[PHPStan] Introduced role policy map array shape as TPolicyMap

ibexa · Jun 13, 2024 · 0c7a838 · 0c7a838
1 parent c4fab36
commit 0c7a838
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 12 deletions.
diff --git a/src/contracts/Repository/RoleService.php b/src/contracts/Repository/RoleService.php
@@ -23,6 +23,8 @@
 
 /**
  * This service provides methods for managing Roles and Policies.
+ *
+ * @phpstan-type TPolicyMap array<string, array<string, array<string, boolean|null>>>
  */
 interface RoleService
 {

diff --git a/src/lib/Base/Container/ApiLoader/RepositoryFactory.php b/src/lib/Base/Container/ApiLoader/RepositoryFactory.php
@@ -35,22 +35,23 @@
 
 /**
  * @internal
+ *
+ * @phpstan-import-type TPolicyMap from \Ibexa\Contracts\Core\Repository\RoleService
  */
 final class RepositoryFactory implements LoggerAwareInterface
 {
     use LoggerAwareTrait;
 
-    /**
-     * Policies map.
-     *
-     * @var array
-     */
+    /** @phpstan-var TPolicyMap */
     private array $policyMap;
 
     private LanguageResolver $languageResolver;
 
     private RepositoryConfigurationProviderInterface $repositoryConfigurationProvider;
 
+    /**
+     * @phpstan-param TPolicyMap $policyMap
+     */
     public function __construct(
         array $policyMap,
         LanguageResolver $languageResolver,

diff --git a/src/lib/Repository/RoleService.php b/src/lib/Repository/RoleService.php
@@ -42,6 +42,8 @@
 
 /**
  * This service provides methods for managing Roles and Policies.
+ *
+ * @phpstan-import-type TPolicyMap from \Ibexa\Contracts\Core\Repository\RoleService
  */
 class RoleService implements RoleServiceInterface
 {
@@ -57,20 +59,16 @@ class RoleService implements RoleServiceInterface
     /** @var \Ibexa\Core\Repository\Mapper\RoleDomainMapper */
     protected $roleDomainMapper;
 
-    /** @var array */
-    protected $settings;
+    /** @phpstan-var array{policyMap: TPolicyMap}|array{} */
+    protected array $settings;
 
     /** @var \Ibexa\Contracts\Core\Repository\PermissionResolver */
     private $permissionResolver;
 
     /**
      * Setups service with reference to repository object that created it & corresponding handler.
      *
-     * @param \Ibexa\Contracts\Core\Repository\Repository $repository
-     * @param \Ibexa\Contracts\Core\Persistence\User\Handler $userHandler
-     * @param \Ibexa\Core\Repository\Permission\LimitationService $limitationService
-     * @param \Ibexa\Core\Repository\Mapper\RoleDomainMapper $roleDomainMapper
-     * @param array $settings
+     * @phpstan-param array{policyMap: TPolicyMap}|array{} $settings
      */
     public function __construct(
         RepositoryInterface $repository,
-Original file line number
+Diff line change
@@ Expand Up / @@ -23,6 +23,8 @@ @@
     /**
      * This service provides methods for managing Roles and Policies.
+     *
+     * @phpstan-type TPolicyMap array<string, array<string, array<string, boolean|null>>>
      */
     interface RoleService
     {
@@ Expand Down @@