AclList::getElementByName() - Code Metrics - Inspection of "add setPermissionLevel" - phpMv/ubiquity-acl - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 2428da...828f5f )

by Jean-Christophe

created 2020-10-04 15:25 UTC

AclList::getElementByName() A

↳ Parent: AclList

Complexity

Conditions	3
Paths	3

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	3

Importance

Changes

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

<?php
namespace Ubiquity\security\acl\models;

use Ubiquity\security\acl\persistence\AclProviderInterface;
use Ubiquity\exceptions\AclException;

/**
 * Ubiquity\security\acl\models$AclList
 * This class is part of Ubiquity
 *
 * @author jc
 * @version 1.0.0
 *
 */
class AclList {

	/**
	 *
	 * @var AclElement[]
	 */
	protected $acls;

	/**
	 *
	 * @var Role[]
	 */
	protected $roles;

	/**
	 *
	 * @var \Ubiquity\security\acl\models\Resource[]
	 */
	protected $resources;

	/**
	 *
	 * @var Permission[]
	 */
	protected $permissions;

	/**
	 *
	 * @var AclLoaderInterface[]
	 */
	protected $providers;

	protected $elementsCache = [];

	protected function getElementByName(string $name, array $inArray, string $type) {
		foreach ($inArray as $elm) {
			if ($elm->getName() == $name) {
				return $elm;
			}
		}
		throw new AclException("$name does not exist in $type ACL");
	}

	protected function elementExistByName(string $name, array $inArray): bool {
		foreach ($inArray as $elm) {
			if ($elm->getName() == $name) {
				return true;
			}
		}
		return false;
	}

	public function init() {
		$this->roles[] = new Role('@ALL');
		$this->resources[] = new Resource('*');
		$this->permissions[] = new Permission('ALL', 1000);
		$this->acls = [];
	}

	public function getRoleByName(string $name) {
		return $this->elementsCache["role_$name"] ??= $this->getElementByName($name, $this->roles, 'roles');
	}

	public function getResourceByName(string $name) {
		return $this->elementsCache["res_$name"] ??= $this->getElementByName($name, $this->resources, 'resources');
	}

	public function getPermissionByName(string $name) {
		return $this->elementsCache["perm_$name"] ??= $this->getElementByName($name, $this->permissions, 'permissions');
	}

	public function loadAcls(): array {
		foreach ($this->providers as $provider) {
			$this->acls += $provider->loadAllAcls();
		}
		return $this->acls;
	}

	public function loadRoles(): array {
		foreach ($this->providers as $provider) {
			$this->roles += $provider->loadAllRoles();
		}
		return $this->roles;
	}

	public function loadResources(): array {
		foreach ($this->providers as $provider) {
			$this->resources += $provider->loadAllResources();
		}
		return $this->resources;
	}

	public function loadPermissions(): array {
		foreach ($this->providers as $provider) {
			$this->permissions += $provider->loadAllPermissions();
		}
		return $this->permissions;
	}

	public function addProvider(AclProviderInterface $provider) {
		$this->providers[] = $provider;
	}

	/**
	 *
	 * @return AclElement[]
	 */
	public function getAcls() {
		return $this->acls;
	}

	/**
	 *
	 * @return Role[]
	 */
	public function getRoles() {
		return $this->roles;
	}

	/**
	 *
	 * @return \Ubiquity\security\acl\models\Resource[]
	 */
	public function getResources() {
		return $this->resources;
	}

	/**
	 *
	 * @return Permission[]
	 */
	public function getPermissions() {
		return $this->permissions;
	}

	/**
	 *
	 * @return AclLoaderInterface[]
	 */
	public function getProviders() {
		return $this->providers;
	}

	/**
	 *
	 * @param AclLoaderInterface[] $providers
	 */
	public function setProviders($providers) {
		$this->providers = $providers;
	}

	public function addRole(Role $role) {
		$this->roles[$role->getName()] = $role;
	}

	public function addResource(Resource $resource) {
		$this->resources[$resource->getName()] = $resource;
	}

	public function addPermission(Permission $permission) {
		$this->permissions[$permission->getName()] = $permission;
	}

	public function setPermissionLevel(string $name, int $level) {
		$perm = $this->getPermissionByName($name);
		$perm->setLevel($level);
	}

	public function allow(string $roleName, string $resourceName, string $permissionName) {
		$aclElm = new AclElement();
		$aclElm->allow($this->getRoleByName($roleName), $this->getResourceByName($resourceName), $this->getPermissionByName($permissionName));
		$this->acls[] = $aclElm;
	}

	public function getRolePermissionsOn(string $roleName, $resourceName = '*'): array {
		$role = $this->getRoleByName($roleName);
		$parents = $role->getParents();
		$result = [];
		foreach ($this->acls as $aclElement) {
			$aclRoleName = $aclElement->getRole()->getName();
			if ($aclRoleName === '@ALL' || $aclRoleName === $roleName) {
				$aclResourceName = $aclElement->getResource()->getName();
				if ($aclResourceName === '*' || $aclResourceName === $resourceName) {
					$result[] = $aclElement;
				}
			}
		}
		foreach ($parents as $parentElm) {
			$result += $this->getRolePermissionsOn($parentElm, $resourceName);
		}
		return $result;
	}

	public function isAllowed(string $roleName, string $resourceName, string $permissionName) {
		$acls = $this->getRolePermissionsOn($roleName, $resourceName);
		if (\count($acls) > 0) {
			$permissionLevel = $this->getPermissionByName($permissionName)->getLevel();
			foreach ($acls as $aclElm) {
				$level = $aclElm->getPermission()->getLevel();
				if ($level >= $permissionLevel) {
					return true;
				}
			}
		}
		return false;
	}
}



1		<?php
2		namespace Ubiquity\security\acl\models;
3
4		use Ubiquity\security\acl\persistence\AclProviderInterface;
5		use Ubiquity\exceptions\AclException;
6
7		/**
8		* Ubiquity\security\acl\models$AclList
9		* This class is part of Ubiquity
10		*
11		* @author jc
12		* @version 1.0.0
13		*
14		*/
15		class AclList {
16
17		/**
18		*
19		* @var AclElement[]
20		*/
21		protected $acls;
22
23		/**
24		*
25		* @var Role[]
26		*/
27		protected $roles;
28
29		/**
30		*
31		* @var \Ubiquity\security\acl\models\Resource[]
32		*/
33		protected $resources;
34
35		/**
36		*
37		* @var Permission[]
38		*/
39		protected $permissions;
40
41		/**
42		*
43		* @var AclLoaderInterface[]
44		*/
45		protected $providers;
46
47		protected $elementsCache = [];
48
49	8	protected function getElementByName(string $name, array $inArray, string $type) {
50	8	foreach ($inArray as $elm) {
51	8	if ($elm->getName() == $name) {
52	7	return $elm;
53		}
54		}
55	3	throw new AclException("$name does not exist in $type ACL");
56		}
57
58		protected function elementExistByName(string $name, array $inArray): bool {
59		foreach ($inArray as $elm) {
60		if ($elm->getName() == $name) {
61		return true;
62		}
63		}
64		return false;
65		}
66
67	8	public function init() {
68	8	$this->roles[] = new Role('@ALL');
69	8	$this->resources[] = new Resource('*');
70	8	$this->permissions[] = new Permission('ALL', 1000);
71	8	$this->acls = [];
72	8	}
73
74	8	public function getRoleByName(string $name) {
75	8	return $this->elementsCache["role_$name"] ??= $this->getElementByName($name, $this->roles, 'roles');
76		}
77
78	4	public function getResourceByName(string $name) {
79	4	return $this->elementsCache["res_$name"] ??= $this->getElementByName($name, $this->resources, 'resources');
80		}
81
82	4	public function getPermissionByName(string $name) {
83	4	return $this->elementsCache["perm_$name"] ??= $this->getElementByName($name, $this->permissions, 'permissions');
84		}
85
86	1	public function loadAcls(): array {
87	1	foreach ($this->providers as $provider) {
88		$this->acls += $provider->loadAllAcls();
89		}
90	1	return $this->acls;
91		}
92
93	1	public function loadRoles(): array {
94	1	foreach ($this->providers as $provider) {
95		$this->roles += $provider->loadAllRoles();
96		}
97	1	return $this->roles;
98		}
99
100	1	public function loadResources(): array {
101	1	foreach ($this->providers as $provider) {
102		$this->resources += $provider->loadAllResources();
103		}
104	1	return $this->resources;
105		}
106
107	1	public function loadPermissions(): array {
108	1	foreach ($this->providers as $provider) {
109		$this->permissions += $provider->loadAllPermissions();
110		}
111	1	return $this->permissions;
112		}
113
114		public function addProvider(AclProviderInterface $provider) {
115		$this->providers[] = $provider;
116		}
117
118		/**
119		*
120		* @return AclElement[]
121		*/
122		public function getAcls() {
123		return $this->acls;
124		}
125
126		/**
127		*
128		* @return Role[]
129		*/
130		public function getRoles() {
131		return $this->roles;
132		}
133
134		/**
135		*
136		* @return \Ubiquity\security\acl\models\Resource[]
137		*/
138		public function getResources() {
139		return $this->resources;
140		}
141
142		/**
143		*
144		* @return Permission[]
145		*/
146		public function getPermissions() {
147		return $this->permissions;
148		}
149
150		/**
151		*
152		* @return AclLoaderInterface[]
153		*/
154		public function getProviders() {
155		return $this->providers;
156		}
157
158		/**
159		*
160		* @param AclLoaderInterface[] $providers
161		*/
162	1	public function setProviders($providers) {
163	1	$this->providers = $providers;
164	1	}
165
166	3	public function addRole(Role $role) {
167	3	$this->roles[$role->getName()] = $role;
168	3	}
169
170	4	public function addResource(Resource $resource) {
171	4	$this->resources[$resource->getName()] = $resource;
172	4	}
173
174	3	public function addPermission(Permission $permission) {
175	3	$this->permissions[$permission->getName()] = $permission;
176	3	}
177
178	1	public function setPermissionLevel(string $name, int $level) {
179	1	$perm = $this->getPermissionByName($name);
180		$perm->setLevel($level);
181		}
182
183	4	public function allow(string $roleName, string $resourceName, string $permissionName) {
184	4	$aclElm = new AclElement();
185	4	$aclElm->allow($this->getRoleByName($roleName), $this->getResourceByName($resourceName), $this->getPermissionByName($permissionName));
186	4	$this->acls[] = $aclElm;
187	4	}
188
189	8	public function getRolePermissionsOn(string $roleName, $resourceName = '*'): array {
190	8	$role = $this->getRoleByName($roleName);
191	7	$parents = $role->getParents();
192	7	$result = [];
193	7	foreach ($this->acls as $aclElement) {
194	4	$aclRoleName = $aclElement->getRole()->getName();
195	4	if ($aclRoleName === '@ALL' \|\| $aclRoleName === $roleName) {
196	4	$aclResourceName = $aclElement->getResource()->getName();
197	4	if ($aclResourceName === '*' \|\| $aclResourceName === $resourceName) {
198	4	$result[] = $aclElement;
199		}
200		}
201		}
202	7	foreach ($parents as $parentElm) {
203	1	$result += $this->getRolePermissionsOn($parentElm, $resourceName);
204		}
205	7	return $result;
206		}
207
208	8	public function isAllowed(string $roleName, string $resourceName, string $permissionName) {
209	8	$acls = $this->getRolePermissionsOn($roleName, $resourceName);
210	7	if (\count($acls) > 0) {
211	4	$permissionLevel = $this->getPermissionByName($permissionName)->getLevel();
212	3	foreach ($acls as $aclElm) {
213	3	$level = $aclElm->getPermission()->getLevel();
214	3	if ($level >= $permissionLevel) {
215	3	return true;
216		}
217		}
218		}
219	6	return false;
220		}
221		}
222
223

phpMv / ubiquity-acl

Push — main ( 2428da...828f5f )

AclList::getElementByName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like