EZP-31480: Introduced strict types for PermissionResolver & Permissio…

…nCriterionResolver (#2986)
ezsystems · Mar 16, 2020 · db13e33 · db13e33
1 parent 58debb5
commit db13e33
Show file tree

Hide file tree

Showing 6 changed files with 41 additions and 25 deletions.
diff --git a/eZ/Publish/API/Repository/PermissionCriterionResolver.php b/eZ/Publish/API/Repository/PermissionCriterionResolver.php
@@ -4,6 +4,8 @@
  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
+
 namespace eZ\Publish\API\Repository;
 
 /**
@@ -25,5 +27,5 @@ interface PermissionCriterionResolver
      *
      * @return bool|\eZ\Publish\API\Repository\Values\Content\Query\Criterion
      */
-    public function getPermissionsCriterion($module, $function, ?array $targets = null);
+    public function getPermissionsCriterion(string $module = 'content', string $function = 'read', ?array $targets = null);
 }
diff --git a/eZ/Publish/API/Repository/PermissionResolver.php b/eZ/Publish/API/Repository/PermissionResolver.php
@@ -4,6 +4,8 @@
  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
+
 namespace eZ\Publish\API\Repository;
 
 use eZ\Publish\API\Repository\Values\User\LookupLimitationResult;
@@ -20,14 +22,14 @@ interface PermissionResolver
      *
      * @return \eZ\Publish\API\Repository\Values\User\UserReference
      */
-    public function getCurrentUserReference();
+    public function getCurrentUserReference(): UserReference;
 
     /**
      * Sets the current user to the given $user.
      *
      * @param \eZ\Publish\API\Repository\Values\User\UserReference $userReference
      */
-    public function setCurrentUserReference(UserReference $userReference);
+    public function setCurrentUserReference(UserReference $userReference): void;
 
     /**
      * Low level permission function: Returns boolean value, or an array of limitations that user permission depends on.
@@ -47,7 +49,7 @@ public function setCurrentUserReference(UserReference $userReference);
      *
      * @return bool|array if limitations are on this function an array of limitations is returned
      */
-    public function hasAccess($module, $function, UserReference $userReference = null);
+    public function hasAccess(string $module, string $function, ?UserReference $userReference = null);
 
     /**
      * Indicates if the current user is allowed to perform an action given by the function on the given
@@ -70,7 +72,7 @@ public function hasAccess($module, $function, UserReference $userReference = nul
      *
      * @return bool
      */
-    public function canUser($module, $function, ValueObject $object, array $targets = []);
+    public function canUser(string $module, string $function, ValueObject $object, array $targets = []): bool;
 
     /**
      * @param string $module The module, aka controller identifier to check permissions on

diff --git a/eZ/Publish/Core/Repository/Permission/CachedPermissionService.php b/eZ/Publish/Core/Repository/Permission/CachedPermissionService.php
@@ -4,6 +4,8 @@
  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
+
 namespace eZ\Publish\Core\Repository\Permission;
 
 use eZ\Publish\API\Repository\PermissionResolver as APIPermissionResolver;
@@ -69,31 +71,30 @@ class CachedPermissionService implements APIPermissionResolver, APIPermissionCri
     public function __construct(
         APIPermissionResolver $permissionResolver,
         APIPermissionCriterionResolver $permissionCriterionResolver,
-        $cacheTTL = 5
+        int $cacheTTL = 5
     ) {
         $this->permissionResolver = $permissionResolver;
         $this->permissionCriterionResolver = $permissionCriterionResolver;
         $this->cacheTTL = $cacheTTL;
     }
 
-    public function getCurrentUserReference()
+    public function getCurrentUserReference(): UserReference
     {
         return $this->permissionResolver->getCurrentUserReference();
     }
 
-    public function setCurrentUserReference(UserReference $userReference)
+    public function setCurrentUserReference(UserReference $userReference): void
     {
         $this->permissionCriterion = null;
-
-        return $this->permissionResolver->setCurrentUserReference($userReference);
+        $this->permissionResolver->setCurrentUserReference($userReference);
     }
 
-    public function hasAccess($module, $function, UserReference $userReference = null)
+    public function hasAccess(string $module, string $function, ?UserReference $userReference = null)
     {
         return $this->permissionResolver->hasAccess($module, $function, $userReference);
     }
 
-    public function canUser($module, $function, ValueObject $object, array $targets = [])
+    public function canUser(string $module, string $function, ValueObject $object, array $targets = []): bool
     {
         return $this->permissionResolver->canUser($module, $function, $object, $targets);
     }
@@ -111,7 +112,7 @@ public function lookupLimitations(
         return $this->permissionResolver->lookupLimitations($module, $function, $object, $targets, $limitations);
     }
 
-    public function getPermissionsCriterion($module = 'content', $function = 'read', ?array $targets = null)
+    public function getPermissionsCriterion(string $module = 'content', string $function = 'read', ?array $targets = null)
     {
         // We only cache content/read lookup as those are the once frequently done, and it's only one we can safely
         // do that won't harm the system if it becomes stale (but user might experience permissions exceptions if it do)

diff --git a/eZ/Publish/Core/Repository/Permission/PermissionCriterionResolver.php b/eZ/Publish/Core/Repository/Permission/PermissionCriterionResolver.php
@@ -4,6 +4,8 @@
  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
+
 namespace eZ\Publish\Core\Repository\Permission;
 
 use eZ\Publish\API\Repository\PermissionCriterionResolver as APIPermissionCriterionResolver;
@@ -53,7 +55,7 @@ public function __construct(
      *
      * @return bool|\eZ\Publish\API\Repository\Values\Content\Query\Criterion
      */
-    public function getPermissionsCriterion($module = 'content', $function = 'read', ?array $targets = null)
+    public function getPermissionsCriterion(string $module = 'content', string $function = 'read', ?array $targets = null)
     {
         $permissionSets = $this->permissionResolver->hasAccess($module, $function);
         if (is_bool($permissionSets)) {

diff --git a/eZ/Publish/Core/Repository/Permission/PermissionResolver.php b/eZ/Publish/Core/Repository/Permission/PermissionResolver.php
@@ -4,6 +4,8 @@
  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
+
 namespace eZ\Publish\Core\Repository\Permission;
 
 use eZ\Publish\API\Repository\PermissionResolver as PermissionResolverInterface;
@@ -77,12 +79,12 @@ public function __construct(
         $this->policyMap = $policyMap;
     }
 
-    public function getCurrentUserReference()
+    public function getCurrentUserReference(): APIUserReference
     {
         return $this->currentUserRef;
     }
 
-    public function setCurrentUserReference(APIUserReference $userReference)
+    public function setCurrentUserReference(APIUserReference $userReference): void
     {
         $id = $userReference->getUserId();
         if (!$id) {
@@ -92,7 +94,7 @@ public function setCurrentUserReference(APIUserReference $userReference)
         $this->currentUserRef = $userReference;
     }
 
-    public function hasAccess($module, $function, APIUserReference $userReference = null)
+    public function hasAccess(string $module, string $function, ?APIUserReference $userReference = null)
     {
         if (!isset($this->policyMap[$module])) {
             throw new InvalidArgumentValue('module', "module: {$module}/ function: {$function}");
@@ -158,7 +160,7 @@ public function hasAccess($module, $function, APIUserReference $userReference =
         return false; // No policies matching $module and $function, or they contained limitations
     }
 
-    public function canUser($module, $function, ValueObject $object, array $targets = [])
+    public function canUser(string $module, string $function, ValueObject $object, array $targets = []): bool
     {
         $permissionSets = $this->hasAccess($module, $function);
         if ($permissionSets === false || $permissionSets === true) {

diff --git a/eZ/Publish/Core/Repository/Tests/Permission/CachedPermissionServiceTest.php b/eZ/Publish/Core/Repository/Tests/Permission/CachedPermissionServiceTest.php
@@ -1,11 +1,11 @@
 <?php
 
 /**
- * File contains: eZ\Publish\Core\Repository\Tests\Service\Mock\PermissionCriterionHandlerTest class.
- *
  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
+
 namespace eZ\Publish\Core\Repository\Permission;
 
 /**
@@ -73,11 +73,18 @@ public function providerForTestPermissionResolverPassTrough()
      */
     public function testPermissionResolverPassTrough($method, array $arguments, $expectedReturn)
     {
-        $this->getPermissionResolverMock([$method])
-            ->expects($this->once())
-            ->method($method)
-            ->with(...$arguments)
-            ->willReturn($expectedReturn);
+        if ($expectedReturn !== null) {
+            $this->getPermissionResolverMock([$method])
+                ->expects($this->once())
+                ->method($method)
+                ->with(...$arguments)
+                ->willReturn($expectedReturn);
+        } else {
+            $this->getPermissionResolverMock([$method])
+                ->expects($this->once())
+                ->method($method)
+                ->with(...$arguments);
+        }
 
         $cachedService = $this->getCachedPermissionService();