Use union types on contracts and models

spatie · Aug 21, 2023 · 05372f9 · 05372f9
1 parent bd01bee
commit 05372f9
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 8 deletions.
diff --git a/src/Contracts/Permission.php b/src/Contracts/Permission.php
@@ -21,6 +21,7 @@ public function roles(): BelongsToMany;
     /**
      * Find a permission by its name.
      *
+     * @return \Spatie\Permission\Contracts\Permission
      *
      * @throws \Spatie\Permission\Exceptions\PermissionDoesNotExist
      */
@@ -29,14 +30,17 @@ public static function findByName(string $name, ?string $guardName): self;
     /**
      * Find a permission by its id.
      *
-     * @param  int|string  $id
+     * @return \Spatie\Permission\Contracts\Permission
      *
      * @throws \Spatie\Permission\Exceptions\PermissionDoesNotExist
      */
-    public static function findById($id, ?string $guardName): self;
+    public static function findById(int|string $id, ?string $guardName): self;
 
     /**
      * Find or Create a permission by its name and guard name.
+     *
+     * @return \Spatie\Permission\Contracts\Permission
+     *
      */
     public static function findOrCreate(string $name, ?string $guardName): self;
 }
diff --git a/src/Contracts/Role.php b/src/Contracts/Role.php
@@ -30,12 +30,11 @@ public static function findByName(string $name, ?string $guardName): self;
     /**
      * Find a role by its id and guard name.
      *
-     * @param  int|string  $id
      * @return \Spatie\Permission\Contracts\Role
      *
      * @throws \Spatie\Permission\Exceptions\RoleDoesNotExist
      */
-    public static function findById($id, ?string $guardName): self;
+    public static function findById(int|string $id, ?string $guardName): self;
 
     /**
      * Find or create a role by its name and guard name.

diff --git a/src/Models/Permission.php b/src/Models/Permission.php
@@ -100,12 +100,11 @@ public static function findByName(string $name, string $guardName = null): Permi
     /**
      * Find a permission by its id (and optionally guardName).
      *
-     * @param  int|string  $id
      * @return PermissionContract|Permission
      *
      * @throws PermissionDoesNotExist
      */
-    public static function findById($id, string $guardName = null): PermissionContract
+    public static function findById(int|string $id, string $guardName = null): PermissionContract
     {
         $guardName = $guardName ?? Guard::getDefaultName(static::class);
         $permission = static::getPermission([(new static())->getKeyName() => $id, 'guard_name' => $guardName]);

diff --git a/src/Models/Role.php b/src/Models/Role.php
@@ -111,10 +111,9 @@ public static function findByName(string $name, string $guardName = null): RoleC
     /**
      * Find a role by its id (and optionally guardName).
      *
-     * @param  int|string  $id
      * @return RoleContract|Role
      */
-    public static function findById($id, string $guardName = null): RoleContract
+    public static function findById(int|string $id, string $guardName = null): RoleContract
     {
         $guardName = $guardName ?? Guard::getDefaultName(static::class);