AclManager::addResources() - Code Metrics - Inspection of "Update AclCacheProviderTest.php" - phpMv/ubiquity-acl - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 25e437...1b4ef4 )

by Jean-Christophe

created 2020-10-19 16:48 UTC

AclManager::addResources() A

↳ Parent: AclManager

Complexity

Conditions	2
Paths	2

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes

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

<?php
namespace Ubiquity\security\acl;

use Ubiquity\security\acl\models\AclList;
use Ubiquity\security\acl\models\Role;
use Ubiquity\security\acl\models\Resource;
use Ubiquity\security\acl\models\Permission;
use Ubiquity\security\acl\persistence\AclProviderInterface;
use Ubiquity\cache\ClassUtils;
use Ubiquity\security\acl\cache\AclControllerParser;
use Ubiquity\exceptions\AclException;
use Ubiquity\cache\CacheManager;
use Ubiquity\annotations\acl\AllowAnnotation;
use Ubiquity\annotations\acl\ResourceAnnotation;
use Ubiquity\annotations\acl\PermissionAnnotation;

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

	/**
	 *
	 * @var AclList
	 */
	protected static $aclList;

	/**
	 * Create AclList with default roles and resources.
	 */
	public static function start(): void {
		self::$aclList = new AclList();
		self::$aclList->init();
	}

	/**
	 * Load acls, roles, resources and permissions from providers.
	 *
	 * @param AclProviderInterface[] $providers
	 */
	public static function initFromProviders(?array $providers = []): void {
		self::$aclList->setProviders($providers);
		if (\count($providers) > 0) {
			self::$aclList->loadAcls();
			self::$aclList->loadRoles();
			self::$aclList->loadResources();
			self::$aclList->loadPermissions();
		}
	}

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

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

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

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

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

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

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

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

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

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

	public static function getPermissions() {
		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') {
		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') {
		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 saveAll() {
		self::$aclList->saveAll();
	}

	public static function removeRole(string $role) {
		self::$aclList->removeRole($role);
	}

	public static function removePermission(string $permission) {
		self::$aclList->removePermission($permission);
	}

	public static function removeResource(string $resource) {
		self::$aclList->removeResource($resource);
	}

	public static function removeAcl(string $role, string $resource, string $permission = null) {
		self::$aclList->removeAcl($role, $resource, $permission);
	}

	public static function initCache(&$config) {
		CacheManager::start($config);
		CacheManager::registerAnnotations([
			'allow' => AllowAnnotation::class,
			'resource' => ResourceAnnotation::class,
			'permission' => PermissionAnnotation::class
		]);
		$files = \Ubiquity\cache\CacheManager::getControllersFiles($config, true);
		$parser = new AclControllerParser();
		$parser->init();
		foreach ($files as $file) {
			if (\is_file($file)) {
				$controller = ClassUtils::getClassFullNameFromFile($file);
				try {
					$parser->parse($controller);
				} catch (\Exception $e) {
					if ($e instanceof AclException) {
						throw $e;
					}
				}
			}
		}
		$parser->save();
	}
}



1		<?php
2		namespace Ubiquity\security\acl;
3
4		use Ubiquity\security\acl\models\AclList;
5		use Ubiquity\security\acl\models\Role;
6		use Ubiquity\security\acl\models\Resource;
7		use Ubiquity\security\acl\models\Permission;
8		use Ubiquity\security\acl\persistence\AclProviderInterface;
9		use Ubiquity\cache\ClassUtils;
10		use Ubiquity\security\acl\cache\AclControllerParser;
11		use Ubiquity\exceptions\AclException;
12		use Ubiquity\cache\CacheManager;
13		use Ubiquity\annotations\acl\AllowAnnotation;
14		use Ubiquity\annotations\acl\ResourceAnnotation;
15		use Ubiquity\annotations\acl\PermissionAnnotation;
16
17		/**
18		* Ubiquity\security\acl$AclManager
19		* This class is part of Ubiquity
20		*
21		* @author jc
22		* @version 1.0.0
23		*
24		*/
25		class AclManager {
26
27		/**
28		*
29		* @var AclList
30		*/
31		protected static $aclList;
32
33		/**
34		* Create AclList with default roles and resources.
35		*/
36	19	public static function start(): void {
37	19	self::$aclList = new AclList();
38	19	self::$aclList->init();
39	19	}
40
41		/**
42		* Load acls, roles, resources and permissions from providers.
43		*
44		* @param AclProviderInterface[] $providers
45		*/
46	8	public static function initFromProviders(?array $providers = []): void {
47	8	self::$aclList->setProviders($providers);
48	8	if (\count($providers) > 0) {
49	7	self::$aclList->loadAcls();
50	7	self::$aclList->loadRoles();
51	7	self::$aclList->loadResources();
52	7	self::$aclList->loadPermissions();
53		}
54	8	}
55
56	6	public static function addRole(string $name, ?array $parents = []) {
57	6	self::$aclList->addRole(new Role($name, $parents));
58	6	}
59
60	1	public static function addRoles(array $nameParents) {
61	1	foreach ($nameParents as $name => $parents) {
62	1	self::$aclList->addRole(new Role($name, $parents));
63		}
64	1	}
65
66	6	public static function addResource(string $name, ?string $value = null) {
67	6	self::$aclList->addResource(new Resource($name, $value));
68	6	}
69
70	1	public static function addResources(array $nameValue) {
71	1	foreach ($nameValue as $name => $value) {
72	1	self::$aclList->addResource(new Resource($name, $value));
73		}
74	1	}
75
76	7	public static function addPermission(string $name, int $level = 0) {
77	7	self::$aclList->addPermission(new Permission($name, $level));
78	7	}
79
80	1	public static function addPermissions(array $nameLevel) {
81	1	foreach ($nameLevel as $name => $level) {
82	1	self::$aclList->addPermission(new Permission($name, $level));
83		}
84	1	}
85
86	3	public static function setPermissionLevel(string $name, int $level) {
87	3	self::$aclList->setPermissionLevel($name, $level);
88	2	}
89
90	6	public static function getRoles() {
91	6	return self::$aclList->getRoles();
92		}
93
94	6	public static function getResources() {
95	6	return self::$aclList->getResources();
96		}
97
98		/**
99		*
100		* @return \Ubiquity\security\acl\models\AclList
101		*/
102		public static function getAclList() {
103		return AclManager::$aclList;
104		}
105
106	9	public static function getPermissions() {
107	9	return self::$aclList->getPermissions();
108		}
109
110	3	public static function getAcls() {
111	3	return self::$aclList->getAcls();
112		}
113
114		/**
115		* Allow role to access to resource with the permission.
116		*
117		* @param string $role
118		* @param string $resource
119		* @param string $permission
120		*/
121	9	public static function allow(string $role, ?string $resource = '*', ?string $permission = 'ALL') {
122	9	self::$aclList->allow($role, $resource ?? '*', $permission ?? 'ALL');
123	9	}
124
125		/**
126		* Add role, resource and permission and allow this role to access to resource with the permission.
127		*
128		* @param string $role
129		* @param string $resource
130		* @param string $permission
131		*/
132	1	public static function addAndAllow(string $role, ?string $resource = '*', ?string $permission = 'ALL') {
133	1	self::$aclList->addAndAllow($role, $resource ?? '*', $permission ?? 'ALL');
134	1	}
135
136		/**
137		* Check if access to resource is allowed for role with the permission.
138		*
139		* @param string $role
140		* @param string $resource
141		* @param string $permission
142		* @return bool
143		*/
144	18	public static function isAllowed(string $role, ?string $resource = '*', ?string $permission = 'ALL'): bool {
145	18	return self::$aclList->isAllowed($role, $resource ?? '*', $permission ?? 'ALL');
146		}
147
148	3	public static function saveAll() {
149	3	self::$aclList->saveAll();
150	3	}
151
152	2	public static function removeRole(string $role) {
153	2	self::$aclList->removeRole($role);
154	2	}
155
156	2	public static function removePermission(string $permission) {
157	2	self::$aclList->removePermission($permission);
158	2	}
159
160	1	public static function removeResource(string $resource) {
161	1	self::$aclList->removeResource($resource);
162	1	}
163
164	2	public static function removeAcl(string $role, string $resource, string $permission = null) {
165	2	self::$aclList->removeAcl($role, $resource, $permission);
166	2	}
167
168	1	public static function initCache(&$config) {
169	1	CacheManager::start($config);
170	1	CacheManager::registerAnnotations([
171	1	'allow' => AllowAnnotation::class,
172		'resource' => ResourceAnnotation::class,
173		'permission' => PermissionAnnotation::class
174		]);
175	1	$files = \Ubiquity\cache\CacheManager::getControllersFiles($config, true);
176	1	$parser = new AclControllerParser();
177	1	$parser->init();
178	1	foreach ($files as $file) {
179	1	if (\is_file($file)) {
180	1	$controller = ClassUtils::getClassFullNameFromFile($file);
181		try {
182	1	$parser->parse($controller);
183		} catch (\Exception $e) {
184		if ($e instanceof AclException) {
185		throw $e;
186		}
187		}
188		}
189		}
190	1	$parser->save();
191	1	}
192		}
193
194

phpMv / ubiquity-acl

Push — main ( 25e437...1b4ef4 )

AclManager::addResources() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like