making requested changes for pull request #44

Signed-off-by: Jacob Brown <[email protected]>
laminas · Feb 1, 2023 · 2224633 · 2224633
1 parent efff891
commit 2224633
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 15 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -8,3 +8,5 @@
 /phpcs.xml export-ignore
 /phpunit.xml.dist export-ignore
 /test/ export-ignore
+/benchmarks/ export-ignore
+/phpbench.json export-ignore
diff --git a/benchmarks/AclBench.php b/benchmarks/AclBench.php
@@ -27,7 +27,10 @@ public function __construct()
         $this->acl = new Acl();
     }
 
-    public function benchSetService(): void
+    /**
+     * Benchmarks setting up ACL with roles and resources, and then adding allow/deny rules to them
+     */
+    public function benchAclRolesResourcesAllowDeny(): void
     {
         $acl = new Acl();
         $role = new GenericRole('A');

diff --git a/src/Acl.php b/src/Acl.php
@@ -59,9 +59,9 @@ class Acl implements AclInterface
      * Resources by resourceId plus a null element
      * Used to speed up setRule()
      *
-     * @var (ResourceInterface|null)[]
+     * @var array<int|string, ResourceInterface|null>
      */
-    protected $resourcesById = [null];
+    private $resourcesById = [null];
 
     /** @var Role\RoleInterface|null */
     protected $isAllowedRole;
@@ -568,10 +568,10 @@ public function setRule(
             }
         }
         unset($rolesTemp);
-        /** var (ResourceInterface|null)[] */
-        $resourcesArray = [];
+        /** var array<int|string, ResourceInterface|null> */
+        $resourcesToApplyRules = [];
         if (null === $resources && $this->resources) {
-            $resourcesArray = $this->resourcesById;
+            $resourcesToApplyRules = $this->resourcesById;
         } else {
             // ensure that all specified Resources exist; normalize input to array of Resource objects or null
             if (! is_array($resources)) {
@@ -583,10 +583,10 @@ public function setRule(
                 if (null !== $resource) {
                     $resourceObj = $this->getResource($resource);
                     $resourceId  = $resourceObj->getResourceId();
-                    $this->getChildResources($resourceObj, $resourcesArray);
-                    $resourcesArray[$resourceId] = $resourceObj;
+                    $this->getChildResourcesIntoReference($resourceObj, $resourcesToApplyRules);
+                    $resourcesToApplyRules[$resourceId] = $resourceObj;
                 } else {
-                    $resourcesArray[] = null;
+                    $resourcesToApplyRules[] = null;
                 }
             }
             unset($resources);
@@ -602,7 +602,7 @@ public function setRule(
         switch ($operation) {
             // add to the rules
             case self::OP_ADD:
-                foreach ($resourcesArray as $resource) {
+                foreach ($resourcesToApplyRules as $resource) {
                     foreach ($roles as $role) {
                         $rules =& $this->getRules($resource, $role, true);
                         if (! $privileges) {
@@ -623,7 +623,7 @@ public function setRule(
 
             // remove from the rules
             case self::OP_REMOVE:
-                foreach ($resourcesArray as $resource) {
+                foreach ($resourcesToApplyRules as $resource) {
                     foreach ($roles as $role) {
                         $rules =& $this->getRules($resource, $role);
                         if (null === $rules) {
@@ -674,20 +674,34 @@ public function setRule(
     /**
      * Returns all child resources from the given resource.
      *
-     * @param (ResourceInterface|null)[] $return
-     * @return (ResourceInterface|null)[]
+     * @param array<int|string, ResourceInterface|null> $return
+     * @return array<int|string, ResourceInterface|null>
      */
-    protected function getChildResources(ResourceInterface $resource, array &$return = [])
+    private function getChildResourcesIntoReference(ResourceInterface $resource, array &$return = [])
     {
         $id       = $resource->getResourceId();
         $children = $this->resources[$id]['children'];
         foreach ($children as $child) {
-            $this->getChildResources($child, $return);
+            $this->getChildResourcesIntoReference($child, $return);
             $return[$child->getResourceId()] = $child;
         }
         return $return;
     }
 
+    /**
+     * Returns all child resources from the given resource.
+     *
+     * @deprecated
+     *
+     * @see getChildResourcesIntoReference()
+     *
+     * @return array<int|string, ResourceInterface|null>
+     */
+    protected function getChildResources(ResourceInterface $resource)
+    {
+        return $this->getChildResourcesIntoReference($resource);
+    }
+
     /**
      * Returns true if and only if the Role has access to the Resource
      *