Sync with base package

CHANGELOG.md

@@ -3,7 +3,11 @@
 ## 2.0.0 under development
 
 - Chg #63: Raise PHP version to 8.0 (@arogachev)
-- Enh #63: Improve perfomance (@arogachev)
+- Enh #63: Improve performance (@arogachev)
+- Enh #?: Implement `getByNames()` and `getAccessTree()` methods in `ItemsStorage` (@arogachev)
+- Enh #?: Implement `filterUserItemNames()` method in `AssignmentsStorage` (@arogachev)
+- Chg #?: Rename `$name` argument to `$names` and allow array type for it in `getAllChildren()`, `getAllChildRoles()`,
+  `getAllChildPermissions()` methods in `ItemsStorage` (@arogachev)
 
 ## 1.0.0 April 08, 2022
 

src/AssignmentsStorage.php

@@ -92,6 +92,23 @@ public function userHasItem(string $userId, array $itemNames): bool
         return false;
     }
 
+    public function filterUserItemNames(string $userId, array $itemNames): array
+    {
+        $assignments = $this->getByUserId($userId);
+        if (empty($assignments)) {
+            return [];
+        }
+
+        $userItemNames = [];
+        foreach ($itemNames as $itemName) {
+            if (array_key_exists($itemName, $assignments)) {
+                $userItemNames[] = $itemName;
+            }
+        }
+
+        return $userItemNames;
+    }
+
     public function add(Assignment $assignment): void
     {
         $this->assignments[$assignment->getUserId()][$assignment->getItemName()] = $assignment;

src/ItemsStorage.php

@@ -16,6 +16,7 @@
  * system).
  *
  * @psalm-import-type ItemsIndexedByName from ItemsStorageInterface
+ * @psalm-import-type AccessTree from ItemsStorageInterface
  */
 final class ItemsStorage extends CommonStorage implements ItemsStorageInterface
 {
@@ -51,15 +52,16 @@ public function __construct(string $directory, string $itemFile = 'items.php')
         $this->load();
     }
 
-    /**
-     * @return Item[]
-     * @psalm-return array<string, Item>
-     */
     public function getAll(): array
     {
         return $this->items;
     }
 
+    public function getByNames(array $names): array
+    {
+        return array_filter($this->getAll(), static fn (Item $item): bool => in_array($item->getName(), $names));
+    }
+
     public function get(string $name): Permission|Role|null
     {
         return $this->items[$name] ?? null;
@@ -129,31 +131,39 @@ public function getParents(string $name): array
         return $result;
     }
 
+    public function getAccessTree(string $name): array
+    {
+        $result = [$name => ['item' => $this->items[$name], 'children' => []]];
+        $this->fillAccessTreeRecursive($name, $result);
+
+        return $result;
+    }
+
     public function getDirectChildren(string $name): array
     {
         return $this->children[$name] ?? [];
     }
 
-    public function getAllChildren(string $name): array
+    public function getAllChildren(string|array $names): array
     {
         $result = [];
-        $this->fillChildrenRecursive($name, $result);
+        $this->getAllChildrenInternal($names, $result);
 
         return $result;
     }
 
-    public function getAllChildRoles(string $name): array
+    public function getAllChildRoles(string|array $names): array
     {
         $result = [];
-        $this->fillChildrenRecursive($name, $result);
+        $this->getAllChildrenInternal($names, $result);
 
         return $this->filterRoles($result);
     }
 
-    public function getAllChildPermissions(string $name): array
+    public function getAllChildPermissions(string|array $names): array
     {
         $result = [];
-        $this->fillChildrenRecursive($name, $result);
+        $this->getAllChildrenInternal($names, $result);
 
         return $this->filterPermissions($result);
     }
@@ -425,8 +435,52 @@ private function fillParentsRecursive(string $name, array &$result): void
     }
 
     /**
-     * @psalm-param array<string, Item> $result
-     * @psalm-param-out array<string, Item> $result
+     * @psalm-param AccessTree $result
+     * @psalm-param-out non-empty-array<non-empty-string, array{
+     *      item: Permission|Role,
+     *      children: array<non-empty-string, Permission|Role>
+     *  }> $result
+     */
+    private function fillAccessTreeRecursive(string $name, array &$result, array $addedChildItems = []): void
+    {
+        foreach ($this->children as $parentName => $childItems) {
+            foreach ($childItems as $childItem) {
+                if ($childItem->getName() !== $name) {
+                    continue;
+                }
+
+                $parent = $this->get($parentName);
+                if ($parent !== null) {
+                    $result[$parentName]['item'] = $this->items[$parentName];
+
+                    $addedChildItems[$childItem->getName()] = $childItem;
+                    $result[$parentName]['children'] = $addedChildItems;
+                }
+
+                $this->fillAccessTreeRecursive($parentName, $result, $addedChildItems);
+
+                break;
+            }
+        }
+    }
+
+    /**
+     * @param string|string[] $names
+     *
+     * @psalm-param ItemsIndexedByName $result
+     * @psalm-param-out ItemsIndexedByName $result
+     */
+    private function getAllChildrenInternal(string|array $names, array &$result): void
+    {
+        $names = (array) $names;
+        foreach ($names as $name) {
+            $this->fillChildrenRecursive($name, $result);
+        }
+    }
+
+    /**
+     * @psalm-param ItemsIndexedByName $result
+     * @psalm-param-out array<string, Permission|Role> $result
      */
     private function fillChildrenRecursive(string $name, array &$result): void
     {
@@ -442,37 +496,30 @@ private function fillChildrenRecursive(string $name, array &$result): void
     }
 
     /**
-     * @param Item[] $array
-     * @psalm-param array<string, Item> $array
+     * @psalm-param ItemsIndexedByName $items
      *
      * @return Role[]
      * @psalm-return array<string, Role>
      */
-    private function filterRoles(array $array): array
+    private function filterRoles(array $items): array
     {
         return array_filter(
             $this->getRoles(),
-            static fn (Role $roleItem): bool => array_key_exists($roleItem->getName(), $array),
+            static fn (Permission|Role $item): bool => array_key_exists($item->getName(), $items),
         );
     }
 
     /**
-     * @param Item[] $items
-     * @psalm-param array<string, Item> $items
+     * @psalm-param ItemsIndexedByName $items
      *
      * @return Permission[]
      * @psalm-return array<string, Permission>
      */
     private function filterPermissions(array $items): array
     {
-        $permissions = [];
-        foreach (array_keys($items) as $permissionName) {
-            $permission = $this->getPermission($permissionName);
-            if ($permission !== null) {
-                $permissions[$permissionName] = $permission;
-            }
-        }
-
-        return $permissions;
+        return array_filter(
+            $this->getPermissions(),
+            static fn (Permission|Role $permissionItem): bool => array_key_exists($permissionItem->getName(), $items),
+        );
     }
 }