psalm suggestions

Author: Marcin Stodulski

src/entities/Permission.php

@@ -14,10 +14,11 @@
 
 class Permission implements PermissionInterface
 {
-    private ?self $parent = null;
+    /** @var ?Permission|?PermissionInterface */
+    private self|PermissionInterface|null $parent = null;
     private string $code = '';
     private string $name = '';
-    public ?array $children = null;
+    public mixed $children = null;
 
     public function setCode(string $code): void
     {
@@ -39,12 +40,12 @@ public function setName(string $name): void
         $this->name = $name;
     }
 
-    public function getParent(): ?Permission
+    public function getParent(): ?PermissionInterface
     {
         return $this->parent;
     }
 
-    public function setParent(?Permission $parent): void
+    public function setParent(?PermissionInterface $parent): void
     {
         $this->parent = $parent;
     }

src/entities/Role.php

@@ -16,12 +16,13 @@
 class Role implements RoleInterface
 {
     private string $code = '';
-    private ?self $parent = null;
+    /** @var ?Role|?RoleInterface */
+    private self|RoleInterface|null $parent = null;
     private string $name = '';
     /** @var PermissionInterface[] $permissions */
     private array $permissions = [];
     private bool $hasAllPermissions = false;
-    public ?array $children = null;
+    public mixed $children = null;
 
     public function getCode(): string
     {
@@ -48,12 +49,12 @@ public function getParent(): ?RoleInterface
         return $this->parent;
     }
 
-    public function setParent(?Role $parent): void
+    public function setParent(?RoleInterface $parent): void
     {
         $this->parent = $parent;
     }
 
-    public function getPermissions()
+    public function getPermissions(): array
     {
         return $this->permissions;
     }

src/interfaces/RoleInterface.php

@@ -14,6 +14,7 @@ interface RoleInterface
 {
     public function getParent(): ?RoleInterface;
     public function getCode(): string;
+    //the lack of the returned type allows you to program it yourself i your classes
     public function getPermissions();
     public function isHasAllPermissions(): bool;
 }

src/services/Authorization.php

@@ -106,20 +106,22 @@ public function getAllSubRolesAndPermissionsForRole(RoleInterface $role): array
         return [$rolesArray, $permissionsArray];
     }
 
-    private function getSubPermissionsForPermissions(array &$permissionsArray, ?array $permissionsTree = null) : void
+    private function getSubPermissionsForPermissions(array &$permissionsArray, array $permissionsTree = null) : void
     {
         if (!empty($permissionsTree)) {
-            /** @var Permission $permission */
+            /** @var PermissionInterface $permission */
             foreach ($permissionsTree as $permission) {
                 if (in_array($permission->getCode(), $permissionsArray)) {
+                    /** @var Permission $permission */
                     if (isset($permission->children)) {
-                        /** @var Permission $childPermission */
+                        /** @var PermissionInterface $childPermission */
                         foreach ($permission->children as $childPermission) {
                             $permissionsArray[$childPermission->getCode()] = $childPermission->getCode();
                         }
                     }
                 }
 
+                /** @var Permission $permission */
                 if (isset($permission->children)) {
                     $this->getSubPermissionsForPermissions($permissionsArray, $permission->children);
                 }
@@ -130,15 +132,16 @@ private function getSubPermissionsForPermissions(array &$permissionsArray, ?arra
     private function getSubRolesCodes(array &$rolesArray, array &$permissionsArray, array $rolesTree = null) : void
     {
         if (!empty($rolesTree)) {
-            /** @var Role $role */
+            /** @var RoleInterface $role */
             foreach ($rolesTree as $role) {
                 if (in_array($role->getCode(), $rolesArray)) {
                     foreach ($role->getPermissions() as $permission) {
                         $permissionsArray[$permission->getCode()] = $permission->getCode();
                     }
 
+                    /** @var Role $role */
                     if (isset($role->children)) {
-                        /** @var Role $childRole */
+                        /** @var RoleInterface $childRole */
                         foreach ($role->children as $childRole) {
                             $rolesArray[] = $childRole->getCode();
                             foreach ($childRole->getPermissions() as $permission) {
@@ -148,25 +151,27 @@ private function getSubRolesCodes(array &$rolesArray, array &$permissionsArray,
                     }
                 }
 
+                /** @var Role $role */
                 if (isset($role->children)) {
                     $this->getSubRolesCodes($rolesArray, $permissionsArray, $role->children);
                 }
             }
         }
     }
 
-    private function buildTree(array $elements, string $parentId = null): array
+    private function buildTree(array $elements, ?string $parentId = null): array
     {
         $branch = array();
 
-        /** @var Role|Permission $element */
+        /** @var RoleInterface|PermissionInterface $element */
         foreach ($elements as $element) {
-            /** @var ?Role|?Permission $parentElement */
-            $parentElement = $element->getParent();
-            $elementParentId = ($parentElement !== null) ? $parentElement->getCode() : null;
+            /** @var ?Role|?Permission $elementParent */
+            $elementParent = $element->getParent();
+            $elementParentId = ($elementParent !== null) ? $elementParent->getCode() : null;
             if ($elementParentId == $parentId) {
                 $children = $this->buildTree($elements, $element->getCode());
                 if ($children) {
+                    /** @var Role|Permission $element */
                     $element->children = $children;
                 }
                 $branch[] = $element;