Merge pull request #2402 from erikn69/last

[V6] Php 7.4 typed properties
spatie · Apr 13, 2023 · 38f2049 · 38f2049
2 parents 33b016a + cd37572
commit 38f2049
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 65 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1,2 +1,7 @@
 parameters:
 	ignoreErrors:
+		-
+			# PHPStan can't understand what's going on in context of Role class using Builder `when`
+			message: "#^Call to an undefined method Spatie\\\\Permission\\\\Models\\\\Role::getRoleClass\\(\\).$#"
+			count: 1
+			path: src\Traits\HasPermissions.php
diff --git a/src/Commands/Show.php b/src/Commands/Show.php
@@ -37,17 +37,20 @@ public function handle()
             $roles = $roleClass::whereGuardName($guard)
                 ->with('permissions')
                 ->when(config('permission.teams'), fn ($q) => $q->orderBy($team_key))
-                ->orderBy('name')->get()->mapWithKeys(fn ($role) => [$role->name.'_'.($role->$team_key ?: '') => ['permissions' => $role->permissions->pluck('id'), $team_key => $role->$team_key]]
-                );
+                ->orderBy('name')->get()->mapWithKeys(fn ($role) => [
+                    $role->name.'_'.($role->$team_key ?: '') => ['permissions' => $role->permissions->pluck('id'), $team_key => $role->$team_key],
+                ]);
 
             $permissions = $permissionClass::whereGuardName($guard)->orderBy('name')->pluck('name', 'id');
 
-            $body = $permissions->map(fn ($permission, $id) => $roles->map(fn (array $role_data) => $role_data['permissions']->contains($id) ? ' ✔' : ' ·'
+            $body = $permissions->map(fn ($permission, $id) => $roles->map(
+                    fn (array $role_data) => $role_data['permissions']->contains($id) ? ' ✔' : ' ·'
                 )->prepend($permission)
             );
 
             if (config('permission.teams')) {
-                $teams = $roles->groupBy($team_key)->values()->map(fn ($group, $id) => new TableCell('Team ID: '.($id ?: 'NULL'), ['colspan' => $group->count()])
+                $teams = $roles->groupBy($team_key)->values()->map(
+                    fn ($group, $id) => new TableCell('Team ID: '.($id ?: 'NULL'), ['colspan' => $group->count()])
                 );
             }
 

diff --git a/src/Commands/UpgradeForTeams.php b/src/Commands/UpgradeForTeams.php
@@ -88,9 +88,7 @@ protected function getExistingMigrationsWarning(array $existingMigrations)
             $base = "Setup teams migration already exists.\nFollowing file was found: ";
         }
 
-        return $base.array_reduce($existingMigrations, function ($carry, $fileName) {
-            return $carry."\n - ".$fileName;
-        });
+        return $base.array_reduce($existingMigrations, fn ($carry, $fileName) => $carry."\n - ".$fileName);
     }
 
     /**

diff --git a/src/Guard.php b/src/Guard.php
@@ -48,8 +48,7 @@ public static function getNames($model): Collection
     protected static function getConfigAuthGuards(string $class): Collection
     {
         return collect(config('auth.guards'))
-            ->map(fn ($guard) => isset($guard['provider']) ? config("auth.providers.{$guard['provider']}.model") : null
-            )
+            ->map(fn ($guard) => isset($guard['provider']) ? config("auth.providers.{$guard['provider']}.model") : null)
             ->filter(fn ($model) => $class === $model)
             ->keys();
     }

diff --git a/src/PermissionRegistrar.php b/src/PermissionRegistrar.php
@@ -13,50 +13,38 @@
 
 class PermissionRegistrar
 {
-    /** @var Repository */
-    protected $cache;
+    protected Repository $cache;
 
-    /** @var CacheManager */
-    protected $cacheManager;
+    protected CacheManager $cacheManager;
 
-    /** @var string */
-    protected $permissionClass;
+    protected string $permissionClass;
 
-    /** @var string */
-    protected $roleClass;
+    protected string $roleClass;
 
     /** @var Collection|array|null */
     protected $permissions;
 
-    /** @var string */
-    public $pivotRole;
+    public string $pivotRole;
 
-    /** @var string */
-    public $pivotPermission;
+    public string $pivotPermission;
 
     /** @var \DateInterval|int */
     public $cacheExpirationTime;
 
-    /** @var bool */
-    public $teams;
+    public bool $teams;
 
-    /** @var string */
-    public $teamsKey;
+    public string $teamsKey;
 
     /** @var int|string */
     protected $teamId = null;
 
-    /** @var string */
-    public $cacheKey;
+    public string $cacheKey;
 
-    /** @var array */
-    private $cachedRoles = [];
+    private array $cachedRoles = [];
 
-    /** @var array */
-    private $alias = [];
+    private array $alias = [];
 
-    /** @var array */
-    private $except = [];
+    private array $except = [];
 
     /**
      * PermissionRegistrar constructor.
@@ -180,9 +168,9 @@ private function loadPermissions(): void
             return;
         }
 
-        $this->permissions = $this->cache->remember($this->cacheKey, $this->cacheExpirationTime, function () {
-            return $this->getSerializedPermissionsForCache();
-        });
+        $this->permissions = $this->cache->remember(
+            $this->cacheKey, $this->cacheExpirationTime, fn () => $this->getSerializedPermissionsForCache()
+        );
 
         // fallback for old cache method, must be removed on next mayor version
         if (! isset($this->permissions['alias'])) {
@@ -345,11 +333,12 @@ private function getHydratedPermissionCollection(): Collection
         $permissionClass = $this->getPermissionClass();
         $permissionInstance = new $permissionClass();
 
-        return Collection::make(
-            array_map(fn ($item) => $permissionInstance
-                    ->newFromBuilder($this->aliasedArray(array_diff_key($item, ['r' => 0])))
-                    ->setRelation('roles', $this->getHydratedRoleCollection($item['r'] ?? [])), $this->permissions['permissions'])
-        );
+        return Collection::make(array_map(
+            fn ($item) => $permissionInstance
+                ->newFromBuilder($this->aliasedArray(array_diff_key($item, ['r' => 0])))
+                ->setRelation('roles', $this->getHydratedRoleCollection($item['r'] ?? [])),
+            $this->permissions['permissions']
+        ));
     }
 
     private function getHydratedRoleCollection(array $roles): Collection

diff --git a/src/Traits/HasPermissions.php b/src/Traits/HasPermissions.php
@@ -19,11 +19,9 @@
 
 trait HasPermissions
 {
-    /** @var string */
-    private $permissionClass;
+    private ?string $permissionClass = null;
 
-    /** @var string|null */
-    private $wildcardClass;
+    private ?string $wildcardClass = null;
 
     public static function bootHasPermissions()
     {
@@ -101,22 +99,24 @@ public function scopePermission(Builder $query, $permissions): Builder
     {
         $permissions = $this->convertToPermissionModels($permissions);
 
-        $rolesWithPermissions = is_a($this, Role::class) ? [] : array_unique(array_reduce($permissions, fn ($result, $permission) => array_merge($result, $permission->roles->all()), []));
+        $rolesWithPermissions = is_a($this, Role::class) ? [] : array_unique(
+            array_reduce($permissions, fn ($result, $permission) => array_merge($result, $permission->roles->all()), [])
+        );
 
-        return $query->where(function (Builder $query) use ($permissions, $rolesWithPermissions) {
-            $query->whereHas('permissions', function (Builder $subQuery) use ($permissions) {
+        return $query->where(fn (Builder $query) => $query
+            ->whereHas('permissions', function (Builder $subQuery) use ($permissions) {
                 $permissionClass = $this->getPermissionClass();
                 $key = (new $permissionClass())->getKeyName();
                 $subQuery->whereIn(config('permission.table_names.permissions').".$key", \array_column($permissions, $key));
-            });
-            if (count($rolesWithPermissions) > 0 && ! is_a($this, Role::class)) {
-                $query->orWhereHas('roles', function (Builder $subQuery) use ($rolesWithPermissions) {
+            })
+            ->when(count($rolesWithPermissions) > 0, fn ($subQuery) => $subQuery
+                ->orWhereHas('roles', function (Builder $subQuery) use ($rolesWithPermissions) {
                     $roleClass = $this->getRoleClass();
                     $key = (new $roleClass())->getKeyName();
                     $subQuery->whereIn(config('permission.table_names.roles').".$key", \array_column($rolesWithPermissions, $key));
-                });
-            }
-        });
+                })
+            )
+        );
     }
 
     /**

diff --git a/src/Traits/HasRoles.php b/src/Traits/HasRoles.php
@@ -14,8 +14,7 @@ trait HasRoles
 {
     use HasPermissions;
 
-    /** @var string */
-    private $roleClass;
+    private ?string $roleClass = null;
 
     public static function bootHasRoles()
     {
@@ -60,11 +59,10 @@ public function roles(): BelongsToMany
             return $relation;
         }
 
+        $teamField = config('permission.table_names.roles').'.'.app(PermissionRegistrar::class)->teamsKey;
+
         return $relation->wherePivot(app(PermissionRegistrar::class)->teamsKey, getPermissionsTeamId())
-            ->where(function ($q) {
-                $teamField = config('permission.table_names.roles').'.'.app(PermissionRegistrar::class)->teamsKey;
-                $q->whereNull($teamField)->orWhere($teamField, getPermissionsTeamId());
-            });
+            ->where(fn ($q) => $q->whereNull($teamField)->orWhere($teamField, getPermissionsTeamId()));
     }
 
     /**
@@ -89,11 +87,12 @@ public function scopeRole(Builder $query, $roles, $guard = null): Builder
             return $this->getRoleClass()::{$method}($role, $guard ?: $this->getDefaultGuardName());
         }, Arr::wrap($roles));
 
-        return $query->whereHas('roles', function (Builder $subQuery) use ($roles) {
-            $roleClass = $this->getRoleClass();
-            $key = (new $roleClass())->getKeyName();
-            $subQuery->whereIn(config('permission.table_names.roles').".$key", \array_column($roles, $key));
-        });
+        $roleClass = $this->getRoleClass();
+        $key = (new $roleClass())->getKeyName();
+
+        return $query->whereHas('roles', fn (Builder $subQuery) => $subQuery
+            ->whereIn(config('permission.table_names.roles').".$key", \array_column($roles, $key))
+        );
     }
 
     /**