AclManager::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

AclManager::cacheUpdated() A

↳ Parent: AclManager

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	2
ccs	0
cts	2
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php
namespace Ubiquity\security\acl;

use Ubiquity\cache\CacheManager;
use Ubiquity\cache\ClassUtils;
use Ubiquity\exceptions\AclException;
use Ubiquity\security\acl\cache\AclControllerParser;
use Ubiquity\security\acl\cache\PermissionsMap;
use Ubiquity\security\acl\models\AbstractAclPart;
use Ubiquity\security\acl\models\AclElement;
use Ubiquity\security\acl\models\AclList;
use Ubiquity\security\acl\models\Permission;
use Ubiquity\security\acl\models\Resource;
use Ubiquity\security\acl\models\Role;
use Ubiquity\security\acl\persistence\AclCacheProvider;
use Ubiquity\controllers\Router;
use Ubiquity\security\acl\persistence\AclDAOProvider;
use Ubiquity\security\acl\persistence\AclProviderInterface;
use Ubiquity\security\acl\traits\AclManagerInit;

/**
 * Ubiquity\security\acl$AclManager
 * This class is part of Ubiquity
 *
 * @author jc
 * @version 1.0.2
 *
 */
class AclManager {

	use AclManagerInit;

	protected static ?AclList $aclList=null;

	protected static PermissionsMap $permissionMap;

	protected static array $providersPersistence;


	public static function addRole(string $name, ?array $parents = []): void {
		self::$aclList->addRole(new Role($name, $parents));
	}

	public static function addRoles(array $nameParents): void {
		foreach ($nameParents as $name => $parents) {
			self::$aclList->addRole(new Role($name, $parents));
		}
	}

	public static function addResource(string $name, ?string $value = null): void {
		self::$aclList->addResource(new Resource($name, $value));
	}

	public static function addResources(array $nameValue): void {
		foreach ($nameValue as $name => $value) {
			self::$aclList->addResource(new Resource($name, $value));
		}
	}

	public static function addPermission(string $name, int $level = 0): void {
		self::$aclList->addPermission(new Permission($name, $level));
	}

	public static function addPermissions(array $nameLevel): void {
		foreach ($nameLevel as $name => $level) {
			self::$aclList->addPermission(new Permission($name, $level));
		}
	}

	public static function setPermissionLevel(string $name, int $level): void {
		self::$aclList->setPermissionLevel($name, $level);
	}

	public static function getRoles(): array {
		return self::$aclList->getRoles();
	}

	public static function getResources(): array {
		return self::$aclList->getResources();
	}

	/**
	 *
	 * @return \Ubiquity\security\acl\models\AclList
	 */
	public static function getAclList(): ?AclList {
		return AclManager::$aclList;
	}

	public static function getPermissions():array {
		return self::$aclList->getPermissions();
	}

	public static function getAcls() {
		return self::$aclList->getAcls();
	}

	/**
	 * Allow role to access to resource with the permission.
	 *
	 * @param string $role
	 * @param ?string $resource
	 * @param ?string $permission
	 */
	public static function allow(string $role, ?string $resource = '*', ?string $permission = 'ALL'): void {
		self::$aclList->allow($role, $resource ?? '*', $permission ?? 'ALL');
	}

	/**
	 * Add role, resource and permission and allow this role to access to resource with the permission.
	 *
	 * @param string $role
	 * @param ?string $resource
	 * @param ?string $permission
	 */
	public static function addAndAllow(string $role, ?string $resource = '*', ?string $permission = 'ALL'): void {
		self::$aclList->addAndAllow($role, $resource ?? '*', $permission ?? 'ALL');
	}

	/**
	 * Check if access to resource is allowed for role with the permission.
	 *
	 * @param string $role
	 * @param ?string $resource
	 * @param ?string $permission
	 * @return bool
	 */
	public static function isAllowed(string $role, ?string $resource = '*', ?string $permission = 'ALL'): bool {
		return self::$aclList->isAllowed($role, $resource ?? '*', $permission ?? 'ALL');
	}

	public static function isAllowedRoute(string $role,string $routeName): bool {
		$routeInfo=Router::getRouteInfoByName($routeName);
		if (!isset ( $routeInfo ['controller'] )) {
			$routeInfo=\current($routeInfo);
		}
		$controller=$routeInfo['controller']??null;
		$action=$routeInfo['action']??null;
		if(isset($controller) && isset($action)){
			$resourceController = self::getPermissionMap ()->getRessourcePermission ( $controller, $action );
			if (isset ( $resourceController )) {
				try{
					if (self::isAllowed ( $role, $resourceController ['resource'], $resourceController ['permission'] )) {
						return true;
					}
				}
				catch(AclException $e){
					//Nothing to do
				}
			}
			return false;
		}
		return false;
	}

	/**
	 * Save all acls,roles, resources and permissions for AclProviders with no autoSave.
	 */
	public static function saveAll(): void {
		self::$aclList->saveAll();
	}

	/**
	 * Checks if ACL cache is updated.
	 * Do not use directly from this class: use checkCache instead.
	 * @return bool
	 */
	public static function cacheUpdated(): bool {
		return self::$aclList->cacheUpdated();
	}
	
	/**
	 *
	 * @param string $role
	 */
	public static function removeRole(string $role): void {
		self::$aclList->removeRole($role);
	}

	/**
	 *
	 * @param string $permission
	 */
	public static function removePermission(string $permission): void {
		self::$aclList->removePermission($permission);
	}

	/**
	 *
	 * @param string $resource
	 */
	public static function removeResource(string $resource): void {
		self::$aclList->removeResource($resource);
	}

	/**
	 *
	 * @param string $role
	 * @param string $resource
	 * @param ?string $permission
	 */
	public static function removeAcl(string $role, string $resource, ?string $permission = null): void {
		self::$aclList->removeAcl($role, $resource, $permission);
	}

	/**
	 *
	 * @return \Ubiquity\security\acl\cache\PermissionsMap
	 */
	public static function getPermissionMap():PermissionsMap {
		if (! isset(self::$permissionMap)) {
			self::$permissionMap = new PermissionsMap();
			self::$permissionMap->load();
		}
		return self::$permissionMap;
	}

	/**
	 *
	 * @param string $controller
	 * @param string $action
	 * @param string $resource
	 * @param string $permission
	 */
	public static function associate(string $controller, string $action, string $resource, string $permission = 'ALL'):void {
		self::$aclList->getResourceByName($resource);
		self::$aclList->getPermissionByName($permission);
		self::$permissionMap->addAction($controller, $action, $resource, $permission);
	}

	/**
	 *
	 * @param AbstractAclPart $part
	 * @param string $providerClass
	 * @return boolean
	 */
	public static function existPartIn(AbstractAclPart $part, string $providerClass):bool {
		return self::$aclList->existPartIn($part, $providerClass);
	}

	/**
	 *
	 * @param AclElement $elm
	 * @param string $providerClass
	 * @return boolean
	 */
	public static function existAclIn(AclElement $elm, string $providerClass):bool {
		return self::$aclList->existAclIn($elm, $providerClass);
	}
}


1		<?php
2		namespace Ubiquity\security\acl;
3
4		use Ubiquity\cache\CacheManager;
5		use Ubiquity\cache\ClassUtils;
6		use Ubiquity\exceptions\AclException;
7		use Ubiquity\security\acl\cache\AclControllerParser;
8		use Ubiquity\security\acl\cache\PermissionsMap;
9		use Ubiquity\security\acl\models\AbstractAclPart;
10		use Ubiquity\security\acl\models\AclElement;
11		use Ubiquity\security\acl\models\AclList;
12		use Ubiquity\security\acl\models\Permission;
13		use Ubiquity\security\acl\models\Resource;
14		use Ubiquity\security\acl\models\Role;
15		use Ubiquity\security\acl\persistence\AclCacheProvider;
16		use Ubiquity\controllers\Router;
17		use Ubiquity\security\acl\persistence\AclDAOProvider;
18		use Ubiquity\security\acl\persistence\AclProviderInterface;
19		use Ubiquity\security\acl\traits\AclManagerInit;
20
21		/**
22		* Ubiquity\security\acl$AclManager
23		* This class is part of Ubiquity
24		*
25		* @author jc
26		* @version 1.0.2
27		*
28		*/
29		class AclManager {
30
31		use AclManagerInit;
32
33		protected static ?AclList $aclList=null;
34
35		protected static PermissionsMap $permissionMap;
36
37		protected static array $providersPersistence;
38
39
40	8	public static function addRole(string $name, ?array $parents = []): void {
41	8	self::$aclList->addRole(new Role($name, $parents));
42		}
43
44	1	public static function addRoles(array $nameParents): void {
45	1	foreach ($nameParents as $name => $parents) {
46	1	self::$aclList->addRole(new Role($name, $parents));
47		}
48		}
49
50	7	public static function addResource(string $name, ?string $value = null): void {
51	7	self::$aclList->addResource(new Resource($name, $value));
52		}
53
54	1	public static function addResources(array $nameValue): void {
55	1	foreach ($nameValue as $name => $value) {
56	1	self::$aclList->addResource(new Resource($name, $value));
57		}
58		}
59
60	9	public static function addPermission(string $name, int $level = 0): void {
61	9	self::$aclList->addPermission(new Permission($name, $level));
62		}
63
64	1	public static function addPermissions(array $nameLevel): void {
65	1	foreach ($nameLevel as $name => $level) {
66	1	self::$aclList->addPermission(new Permission($name, $level));
67		}
68		}
69
70	3	public static function setPermissionLevel(string $name, int $level): void {
71	3	self::$aclList->setPermissionLevel($name, $level);
72		}
73
74	8	public static function getRoles(): array {
75	8	return self::$aclList->getRoles();
76		}
77
78	7	public static function getResources(): array {
79	7	return self::$aclList->getResources();
80		}
81
82		/**
83		*
84		* @return \Ubiquity\security\acl\models\AclList
85		*/
86	3	public static function getAclList(): ?AclList {
87	3	return AclManager::$aclList;
88		}
89
90	11	public static function getPermissions():array {
91	11	return self::$aclList->getPermissions();
92		}
93
94	6	public static function getAcls() {
95	6	return self::$aclList->getAcls();
96		}
97
98		/**
99		* Allow role to access to resource with the permission.
100		*
101		* @param string $role
102		* @param ?string $resource
103		* @param ?string $permission
104		*/
105	10	public static function allow(string $role, ?string $resource = '*', ?string $permission = 'ALL'): void {
106	10	self::$aclList->allow($role, $resource ?? '*', $permission ?? 'ALL');
107		}
108
109		/**
110		* Add role, resource and permission and allow this role to access to resource with the permission.
111		*
112		* @param string $role
113		* @param ?string $resource
114		* @param ?string $permission
115		*/
116	3	public static function addAndAllow(string $role, ?string $resource = '*', ?string $permission = 'ALL'): void {
117	3	self::$aclList->addAndAllow($role, $resource ?? '*', $permission ?? 'ALL');
118		}
119
120		/**
121		* Check if access to resource is allowed for role with the permission.
122		*
123		* @param string $role
124		* @param ?string $resource
125		* @param ?string $permission
126		* @return bool
127		*/
128	20	public static function isAllowed(string $role, ?string $resource = '*', ?string $permission = 'ALL'): bool {
129	20	return self::$aclList->isAllowed($role, $resource ?? '*', $permission ?? 'ALL');
130		}
131
132		public static function isAllowedRoute(string $role,string $routeName): bool {
133		$routeInfo=Router::getRouteInfoByName($routeName);
134		if (!isset ( $routeInfo ['controller'] )) {
135		$routeInfo=\current($routeInfo);
136		}
137		$controller=$routeInfo['controller']??null;
138		$action=$routeInfo['action']??null;
139		if(isset($controller) && isset($action)){
140		$resourceController = self::getPermissionMap ()->getRessourcePermission ( $controller, $action );
141		if (isset ( $resourceController )) {
142		try{
143		if (self::isAllowed ( $role, $resourceController ['resource'], $resourceController ['permission'] )) {
144		return true;
145		}
146		}
147		catch(AclException $e){
148		//Nothing to do
149		}
150		}
151		return false;
152		}
153		return false;
154		}
155
156		/**
157		* Save all acls,roles, resources and permissions for AclProviders with no autoSave.
158		*/
159	4	public static function saveAll(): void {
160	4	self::$aclList->saveAll();
161		}
162
163		/**
164		* Checks if ACL cache is updated.
165		* Do not use directly from this class: use checkCache instead.
166		* @return bool
167		*/
168		public static function cacheUpdated(): bool {
169		return self::$aclList->cacheUpdated();
170		}
171
172		/**
173		*
174		* @param string $role
175		*/
176	2	public static function removeRole(string $role): void {
177	2	self::$aclList->removeRole($role);
178		}
179
180		/**
181		*
182		* @param string $permission
183		*/
184	2	public static function removePermission(string $permission): void {
185	2	self::$aclList->removePermission($permission);
186		}
187
188		/**
189		*
190		* @param string $resource
191		*/
192		public static function removeResource(string $resource): void {
193		self::$aclList->removeResource($resource);
194		}
195
196		/**
197		*
198		* @param string $role
199		* @param string $resource
200		* @param ?string $permission
201		*/
202	2	public static function removeAcl(string $role, string $resource, ?string $permission = null): void {
203	2	self::$aclList->removeAcl($role, $resource, $permission);
204		}
205
206		/**
207		*
208		* @return \Ubiquity\security\acl\cache\PermissionsMap
209		*/
210	1	public static function getPermissionMap():PermissionsMap {
211	1	if (! isset(self::$permissionMap)) {
212	1	self::$permissionMap = new PermissionsMap();
213	1	self::$permissionMap->load();
214		}
215	1	return self::$permissionMap;
216		}
217
218		/**
219		*
220		* @param string $controller
221		* @param string $action
222		* @param string $resource
223		* @param string $permission
224		*/
225	1	public static function associate(string $controller, string $action, string $resource, string $permission = 'ALL'):void {
226	1	self::$aclList->getResourceByName($resource);
227	1	self::$aclList->getPermissionByName($permission);
228	1	self::$permissionMap->addAction($controller, $action, $resource, $permission);
229		}
230
231		/**
232		*
233		* @param AbstractAclPart $part
234		* @param string $providerClass
235		* @return boolean
236		*/
237	2	public static function existPartIn(AbstractAclPart $part, string $providerClass):bool {
238	2	return self::$aclList->existPartIn($part, $providerClass);
239		}
240
241		/**
242		*
243		* @param AclElement $elm
244		* @param string $providerClass
245		* @return boolean
246		*/
247	2	public static function existAclIn(AclElement $elm, string $providerClass):bool {
248	2	return self::$aclList->existAclIn($elm, $providerClass);
249		}
250		}
251

phpMv / ubiquity-acl

Push — main ( e44aa5...4e3445 )

AclManager::cacheUpdated() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like