AclListOperationsTrait.php

Go to the documentation of this file.

<?php
namespace Ubiquity\security\acl\models\traits;
 
use Ubiquity\security\acl\models\AclElement;
use Ubiquity\security\acl\models\AbstractAclPart;
use Ubiquity\security\acl\models\Role;
use Ubiquity\security\acl\models\Resource;
use Ubiquity\security\acl\models\Permission;
use Ubiquity\security\acl\persistence\AclProviderInterface;
 
class AclListOperationsTrait {
 
    abstract public function getRoleByName(string $name);
 
    abstract public function getResourceByName(string $name);
 
    abstract public function getPermissionByName(string $name);
 
    abstract public function init();
 
    abstract protected function elementExistByName(string $name, array $inArray): bool;
 
    public function saveAclElement(AclElement $aclElement) {
        foreach ($this->providers as $provider) {
                $provider->saveAcl($aclElement);
        }
    }
 
    public function removeAclElement(AclElement $aclElement) {
        foreach ($this->providers as $provider) {
            $provider->removeAcl($aclElement);
        }
    }
 
    public function savePart(AbstractAclPart $aclPart) {
        foreach ($this->providers as $provider) {
            $provider->savePart($aclPart);
        }
    }
 
    public function updatePart(string $id,AbstractAclPart $aclPart) {
        foreach ($this->providers as $provider) {
            $provider->updatePart($id,$aclPart);
        }
    }
 
    public function removePart(AbstractAclPart $aclPart) {
        foreach ($this->providers as $provider) {
            $provider->removePart($aclPart);
        }
    }
 
    public function removeRole(string $roleName) {
        $role = $this->getRoleByName($roleName);
        unset($this->roles[$roleName]);
        $this->unsetCache($roleName);
        $this->removeAcl($roleName);
        $this->removePart($role);
    }
 
    protected function unsetCache($name) {
        if (isset($this->elementsCache[$name])) {
            unset($this->elementsCache[$name]);
        }
    }
 
    public function removePermission(string $permissionName) {
        $permission = $this->getPermissionByName($permissionName);
        unset($this->permissions[$permissionName]);
        $this->unsetCache($permissionName);
        $this->removeAcl(null, null, $permissionName);
        $this->removePart($permission);
    }
 
    public function removeResource(string $resourceName) {
        $resource = $this->getResourceByName($resourceName);
        unset($this->resources[$resourceName]);
        $this->unsetCache($resourceName);
        $this->removeAcl(null, $resourceName);
        $this->removePart($resource);
    }
 
    public function removeAcl(string $roleName = null, string $resourceName = null, string $permissionName = null) {
        $toRemove = [];
        foreach ($this->acls as $index => $acl) {
            if (($resourceName == null || $acl->getResource()->getName() === $resourceName) && ($roleName == null || $acl->getRole()->getName() === $roleName) && ($permissionName == null || $acl->getPermission()->getName() === $permissionName)) {
                foreach ($this->providers as $provider) {
                    $provider->removeAcl($acl);
                }
                $toRemove[] = $index;
            }
        }
        foreach ($toRemove as $remove) {
            unset($this->acls[$remove]);
        }
    }
 
    public function saveAll() {
        foreach ($this->providers as $provider) {
            if (! $provider->isAutosave()) {
                $provider->saveAll();
            }
        }
    }
 
    public function cacheUpdated(): bool {
        foreach ($this->providers as $provider) {
            if (! $provider->isAutosave() && $provider->cacheUpdated()) {
                return true;
            }
        }
        return false;
    }
 
 
    public function clear() {
        $this->init();
    }
 
    public function addRole(Role $role) {
        $this->roles[$role->getName()] = $role;
        $this->savePart($role);
    }
 
    public function addResource(Resource $resource) {
        $this->resources[$resource->getName()] = $resource;
        $this->savePart($resource);
    }
 
    public function addPermission(Permission $permission) {
        $this->permissions[$permission->getName()] = $permission;
        $this->savePart($permission);
    }
 
    public function updateRole(String $roleName, Role $role) {
        $oldRole = $this->getRoleByName($roleName);
        if ($oldRole) {
            $this->updatePart($roleName, $role);
        }
    }
 
    public function updateResource(String $resourceName, Resource $resource) {
        $oldResource = $this->getResourceByName($resourceName);
        if ($oldResource) {
            $this->updatePart($resourceName, $resource);
        }
    }
 
    public function updatePermission(String $permissionName, Permission $permission) {
        $oldPermission = $this->getPermissionByName($permissionName);
        if ($oldPermission) {
            $this->updatePart($permissionName, $permission);
        }
    }
 
    public function setPermissionLevel(string $name, int $level) {
        $perm = $this->getPermissionByName($name);
        $perm->setLevel($level);
        $this->updatePart($name, $perm);
    }
 
    public function allow(string $roleName, string $resourceName, string $permissionName, $id=null) {
        $aclElm = new AclElement();
        $aclElm->setId($id);
        $aclElm->allow($this->getRoleByName($roleName), $this->getResourceByName($resourceName), $this->getPermissionByName($permissionName));
        $this->acls[] = $aclElm;
        $this->saveAclElement($aclElm);
    }
 
    public function addAndAllow(string $roleName, string $resourceName, string $permissionName, $id=null) {
        if (! $this->elementExistByName($roleName, $this->roles)) {
            $this->addRole(new Role($roleName));
        }
        if ($resourceName !== '*' && ! $this->elementExistByName($resourceName, $this->resources)) {
            $this->addResource(new Resource($resourceName));
        }
        if ($permissionName !== 'ALL' && ! $this->elementExistByName($permissionName, $this->permissions)) {
            $this->addPermission(new Permission($permissionName));
        }
        $this->allow($roleName, $resourceName ?? '*', $permissionName ?? 'ALL', $id);
    }
 
    public function roleExists(string $roleName): bool {
        return $this->elementExistByName($roleName, $this->roles);
    }
 
    public function resourceExists(string $resourceName): bool {
        return $this->elementExistByName($resourceName, $this->resources);
    }
 
    public function permissionExists(string $permissionName): bool {
        return $this->elementExistByName($permissionName, $this->permissions);
    }
}