fix PHPDoc

spatie · May 26, 2023 · 34fac5c · 34fac5c
1 parent 563794f
commit 34fac5c
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/src/Models/Permission.php b/src/Models/Permission.php
@@ -34,6 +34,11 @@ public function __construct(array $attributes = [])
         $this->table = config('permission.table_names.permissions') ?: parent::getTable();
     }
 
+    /**
+     * @return PermissionContract|Permission
+     *
+     * @throws PermissionAlreadyExists
+     */
     public static function create(array $attributes = [])
     {
         $attributes['guard_name'] = $attributes['guard_name'] ?? Guard::getDefaultName(static::class);
@@ -78,6 +83,7 @@ public function users(): BelongsToMany
      * Find a permission by its name (and optionally guardName).
      *
      * @param  string|null  $guardName
+     * @return PermissionContract|Permission
      *
      * @throws PermissionDoesNotExist
      */
@@ -97,6 +103,7 @@ public static function findByName(string $name, $guardName = null): PermissionCo
      *
      * @param  int|string  $id
      * @param  string|null  $guardName
+     * @return PermissionContract|Permission
      *
      * @throws PermissionDoesNotExist
      */
@@ -116,6 +123,7 @@ public static function findById($id, $guardName = null): PermissionContract
      * Find or create permission by its name (and optionally guardName).
      *
      * @param  string|null  $guardName
+     * @return PermissionContract|Permission
      */
     public static function findOrCreate(string $name, $guardName = null): PermissionContract
     {
@@ -141,6 +149,8 @@ protected static function getPermissions(array $params = [], bool $onlyOne = fal
 
     /**
      * Get the current cached first permission.
+     *
+     * @return PermissionContract|Permission|null
      */
     protected static function getPermission(array $params = []): ?PermissionContract
     {

diff --git a/src/Models/Role.php b/src/Models/Role.php
@@ -35,6 +35,11 @@ public function __construct(array $attributes = [])
         $this->table = config('permission.table_names.roles') ?: parent::getTable();
     }
 
+    /**
+     * @return RoleContract|Role
+     *
+     * @throws RoleAlreadyExists
+     */
     public static function create(array $attributes = [])
     {
         $attributes['guard_name'] = $attributes['guard_name'] ?? Guard::getDefaultName(static::class);
@@ -143,7 +148,12 @@ public static function findOrCreate(string $name, $guardName = null): RoleContra
         return $role;
     }
 
-    protected static function findByParam(array $params = [])
+    /**
+     * Finds a role based on an array of parameters.
+     *
+     * @return RoleContract|Role|null
+     */
+    protected static function findByParam(array $params = []): ?RoleContract
     {
         $query = static::query();