AclListOperationsTrait::cacheUpdated() - Code Metrics - Inspection of "add cacheUpdated and checkCache" - phpMv/ubiquity-acl - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( e44aa5...4e3445 )

by Jean-Christophe

created 2022-12-30 02:36 UTC

AclListOperationsTrait::cacheUpdated() A

↳ Parent: AclListOperationsTrait

Complexity

Conditions	4
Paths	3

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
cc	4
eloc	4
nc	3
nop	0
dl	0
loc	7
ccs	0
cts	5
cp	0
crap	20
rs	10
c	0
b	0
f	0

<?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;

/**
 * Ubiquity\security\acl\models\traits$AclListOperations
 * This class is part of Ubiquity
 *
 * @author jc
 * @version 1.0.3
 * @property Role[] $roles
 * @property Resource[] $resources
 * @property Permission[] $permissions
 * @property AclProviderInterface[] $providers
 * @property array $elementsCache
 * @property AclElement[] $acls
 *
 */
trait 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);
	}
}



1		<?php
2		namespace Ubiquity\security\acl\models\traits;
3
4		use Ubiquity\security\acl\models\AclElement;
5		use Ubiquity\security\acl\models\AbstractAclPart;
6		use Ubiquity\security\acl\models\Role;
7		use Ubiquity\security\acl\models\Resource;
8		use Ubiquity\security\acl\models\Permission;
9		use Ubiquity\security\acl\persistence\AclProviderInterface;
10
11		/**
12		* Ubiquity\security\acl\models\traits$AclListOperations
13		* This class is part of Ubiquity
14		*
15		* @author jc
16		* @version 1.0.3
17		* @property Role[] $roles
18		* @property Resource[] $resources
19		* @property Permission[] $permissions
20		* @property AclProviderInterface[] $providers
21		* @property array $elementsCache
22		* @property AclElement[] $acls
23		*
24		*/
25		trait AclListOperationsTrait {
26
27		abstract public function getRoleByName(string $name);
28
29		abstract public function getResourceByName(string $name);
30
31		abstract public function getPermissionByName(string $name);
32
33		abstract public function init();
34
35		abstract protected function elementExistByName(string $name, array $inArray): bool;
36
37	13	public function saveAclElement(AclElement $aclElement) {
38	13	foreach ($this->providers as $provider) {
39	5	$provider->saveAcl($aclElement);
40		}
41		}
42
43		public function removeAclElement(AclElement $aclElement) {
44		foreach ($this->providers as $provider) {
45		$provider->removeAcl($aclElement);
46		}
47		}
48
49	14	public function savePart(AbstractAclPart $aclPart) {
50	14	foreach ($this->providers as $provider) {
51	6	$provider->savePart($aclPart);
52		}
53		}
54
55	2	public function updatePart(string $id,AbstractAclPart $aclPart) {
56	2	foreach ($this->providers as $provider) {
57	2	$provider->updatePart($id,$aclPart);
58		}
59		}
60
61	4	public function removePart(AbstractAclPart $aclPart) {
62	4	foreach ($this->providers as $provider) {
63	4	$provider->removePart($aclPart);
64		}
65		}
66
67	2	public function removeRole(string $roleName) {
68	2	$role = $this->getRoleByName($roleName);
69	2	unset($this->roles[$roleName]);
70	2	$this->unsetCache($roleName);
71	2	$this->removeAcl($roleName);
72	2	$this->removePart($role);
73		}
74
75	4	protected function unsetCache($name) {
76	4	if (isset($this->elementsCache[$name])) {
77	4	unset($this->elementsCache[$name]);
78		}
79		}
80
81	2	public function removePermission(string $permissionName) {
82	2	$permission = $this->getPermissionByName($permissionName);
83	2	unset($this->permissions[$permissionName]);
84	2	$this->unsetCache($permissionName);
85	2	$this->removeAcl(null, null, $permissionName);
86	2	$this->removePart($permission);
87		}
88
89		public function removeResource(string $resourceName) {
90		$resource = $this->getResourceByName($resourceName);
91		unset($this->resources[$resourceName]);
92		$this->unsetCache($resourceName);
93		$this->removeAcl(null, $resourceName);
94		$this->removePart($resource);
95		}
96
97	6	public function removeAcl(string $roleName = null, string $resourceName = null, string $permissionName = null) {
98	6	$toRemove = [];
99	6	foreach ($this->acls as $index => $acl) {
100	6	if (($resourceName == null \|\| $acl->getResource()->getName() === $resourceName) && ($roleName == null \|\| $acl->getRole()->getName() === $roleName) && ($permissionName == null \|\| $acl->getPermission()->getName() === $permissionName)) {
101	2	foreach ($this->providers as $provider) {
102	2	$provider->removeAcl($acl);
103		}
104	2	$toRemove[] = $index;
105		}
106		}
107	6	foreach ($toRemove as $remove) {
108	2	unset($this->acls[$remove]);
109		}
110		}
111
112	4	public function saveAll() {
113	4	foreach ($this->providers as $provider) {
114	4	if (! $provider->isAutosave()) {
115	3	$provider->saveAll();
116		}
117		}
118		}
119
120		public function cacheUpdated(): bool {
121		foreach ($this->providers as $provider) {
122		if (! $provider->isAutosave() && $provider->cacheUpdated()) {
123		return true;
124		}
125		}
126		return false;
127		}
128
129
130	3	public function clear() {
131	3	$this->init();
132		}
133
134	10	public function addRole(Role $role) {
135	10	$this->roles[$role->getName()] = $role;
136	10	$this->savePart($role);
137		}
138
139	9	public function addResource(Resource $resource) {
140	9	$this->resources[$resource->getName()] = $resource;
141	9	$this->savePart($resource);
142		}
143
144	11	public function addPermission(Permission $permission) {
145	11	$this->permissions[$permission->getName()] = $permission;
146	11	$this->savePart($permission);
147		}
148
149		public function updateRole(String $roleName,Role $role){
150		$oldRole = $this->getRoleByName($roleName);
151		if($oldRole) {
152		$this->updatePart($roleName,$role);
153		}
154		}
155
156		public function updateResource(String $resourceName,Resource $resource){
157		$oldResource = $this->getResourceByName($resourceName);
158		if($oldResource) {
159		$this->updatePart($resourceName,$resource);
160		}
161		}
162
163		public function updatePermission(String $permissionName,Permission $permission){
164		$oldPermission = $this->getPermissionByName($permissionName);
165		if($oldPermission) {
166		$this->updatePart($permissionName,$permission);
167		}
168		}
169
170	3	public function setPermissionLevel(string $name, int $level) {
171	3	$perm = $this->getPermissionByName($name);
172	2	$perm->setLevel($level);
173	2	$this->updatePart($name,$perm);
174		}
175
176	13	public function allow(string $roleName, string $resourceName, string $permissionName, $id=null) {
177	13	$aclElm = new AclElement();
178	13	$aclElm->setId($id);
179	13	$aclElm->allow($this->getRoleByName($roleName), $this->getResourceByName($resourceName), $this->getPermissionByName($permissionName));
180	13	$this->acls[] = $aclElm;
181	13	$this->saveAclElement($aclElm);
182		}
183
184	3	public function addAndAllow(string $roleName, string $resourceName, string $permissionName, $id=null) {
185	3	if (! $this->elementExistByName($roleName, $this->roles)) {
186	3	$this->addRole(new Role($roleName));
187		}
188	3	if ($resourceName !== '*' && ! $this->elementExistByName($resourceName, $this->resources)) {
189	3	$this->addResource(new Resource($resourceName));
190		}
191	3	if ($permissionName !== 'ALL' && ! $this->elementExistByName($permissionName, $this->permissions)) {
192	3	$this->addPermission(new Permission($permissionName));
193		}
194	3	$this->allow($roleName, $resourceName ?? '*', $permissionName ?? 'ALL', $id);
195		}
196		}
197
198

phpMv / ubiquity-acl

Push — main ( e44aa5...4e3445 )

AclListOperationsTrait::cacheUpdated() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like