BaseManager::getDefaultRoles() - Code Metrics - Inspection of "Fixes #13306: Wildcard in `reloadableScripts` in `..." - rob006/yii2-dev - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 97c43c...6b8cf1 )

by Robert

created 2017-02-18 20:47 UTC

BaseManager::getDefaultRoles() A

↳ Parent: BaseManager

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0
ccs	6
cts	6
cp	1
cc	2
eloc	5
nc	2
nop	0
crap	2

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\rbac;

use yii\base\Component;
use yii\base\InvalidConfigException;
use yii\base\InvalidParamException;

/**
 * BaseManager is a base class implementing [[ManagerInterface]] for RBAC management.
 *
 * For more details and usage information on DbManager, see the [guide article on security authorization](guide:security-authorization).
 *
 * @author Qiang Xue <[email protected]>
 * @since 2.0
 */
abstract class BaseManager extends Component implements ManagerInterface
{
    /**
     * @var array a list of role names that are assigned to every user automatically without calling [[assign()]].
     */
    public $defaultRoles = [];


    /**
     * Returns the named auth item.
     * @param string $name the auth item name.
     * @return Item the auth item corresponding to the specified name. Null is returned if no such item.
     */
    abstract protected function getItem($name);

    /**
     * Returns the items of the specified type.
     * @param int $type the auth item type (either [[Item::TYPE_ROLE]] or [[Item::TYPE_PERMISSION]]
     * @return Item[] the auth items of the specified type.
     */
    abstract protected function getItems($type);

    /**
     * Adds an auth item to the RBAC system.
     * @param Item $item the item to add
     * @return bool whether the auth item is successfully added to the system
     * @throws \Exception if data validation or saving fails (such as the name of the role or permission is not unique)
     */
    abstract protected function addItem($item);

    /**
     * Adds a rule to the RBAC system.
     * @param Rule $rule the rule to add
     * @return bool whether the rule is successfully added to the system
     * @throws \Exception if data validation or saving fails (such as the name of the rule is not unique)
     */
    abstract protected function addRule($rule);

    /**
     * Removes an auth item from the RBAC system.
     * @param Item $item the item to remove
     * @return bool whether the role or permission is successfully removed
     * @throws \Exception if data validation or saving fails (such as the name of the role or permission is not unique)
     */
    abstract protected function removeItem($item);

    /**
     * Removes a rule from the RBAC system.
     * @param Rule $rule the rule to remove
     * @return bool whether the rule is successfully removed
     * @throws \Exception if data validation or saving fails (such as the name of the rule is not unique)
     */
    abstract protected function removeRule($rule);

    /**
     * Updates an auth item in the RBAC system.
     * @param string $name the name of the item being updated
     * @param Item $item the updated item
     * @return bool whether the auth item is successfully updated
     * @throws \Exception if data validation or saving fails (such as the name of the role or permission is not unique)
     */
    abstract protected function updateItem($name, $item);

    /**
     * Updates a rule to the RBAC system.
     * @param string $name the name of the rule being updated
     * @param Rule $rule the updated rule
     * @return bool whether the rule is successfully updated
     * @throws \Exception if data validation or saving fails (such as the name of the rule is not unique)
     */
    abstract protected function updateRule($name, $rule);

    /**
     * @inheritdoc
     */
    public function createRole($name)
    {
        $role = new Role();
        $role->name = $name;
        return $role;
    }

    /**
     * @inheritdoc
     */
    public function createPermission($name)
    {
        $permission = new Permission();
        $permission->name = $name;
        return $permission;
    }

    /**
     * @inheritdoc
     */
    public function add($object)
    {
        if ($object instanceof Item) {
            if ($object->ruleName && $this->getRule($object->ruleName) === null) {
                $rule = \Yii::createObject($object->ruleName);
                $rule->name = $object->ruleName;
                $this->addRule($rule);
            }
            return $this->addItem($object);
        } elseif ($object instanceof Rule) {
            return $this->addRule($object);
        } else {
            throw new InvalidParamException('Adding unsupported object type.');
        }
    }

    /**
     * @inheritdoc
     */
    public function remove($object)
    {
        if ($object instanceof Item) {
            return $this->removeItem($object);
        } elseif ($object instanceof Rule) {
            return $this->removeRule($object);
        } else {
            throw new InvalidParamException('Removing unsupported object type.');
        }
    }

    /**
     * @inheritdoc
     */
    public function update($name, $object)
    {
        if ($object instanceof Item) {
            if ($object->ruleName && $this->getRule($object->ruleName) === null) {
                $rule = \Yii::createObject($object->ruleName);
                $rule->name = $object->ruleName;
                $this->addRule($rule);
            }
            return $this->updateItem($name, $object);
        } elseif ($object instanceof Rule) {
            return $this->updateRule($name, $object);
        } else {
            throw new InvalidParamException('Updating unsupported object type.');
        }
    }

    /**
     * @inheritdoc
     */
    public function getRole($name)
    {
        $item = $this->getItem($name);
        return $item instanceof Item && $item->type == Item::TYPE_ROLE ? $item : null;
    }

    /**
     * @inheritdoc
     */
    public function getPermission($name)
    {
        $item = $this->getItem($name);
        return $item instanceof Item && $item->type == Item::TYPE_PERMISSION ? $item : null;
    }

    /**
     * @inheritdoc
     */
    public function getRoles()
    {
        return $this->getItems(Item::TYPE_ROLE);
    }

    /**
     * Returns defaultRoles as array of Role objects
     * @since 2.0.12
     * @return Role[] default roles. The array is indexed by the role names
     */
    public function getDefaultRoles()
    {
        $result = [];
        foreach ($this->defaultRoles as $roleName) {
            $result[$roleName] = $this->createRole($roleName);
        }
        return $result;
    }

    /**
     * @inheritdoc
     */
    public function getPermissions()
    {
        return $this->getItems(Item::TYPE_PERMISSION);
    }

    /**
     * Executes the rule associated with the specified auth item.
     *
     * If the item does not specify a rule, this method will return true. Otherwise, it will
     * return the value of [[Rule::execute()]].
     *
     * @param string|int $user the user ID. This should be either an integer or a string representing
     * the unique identifier of a user. See [[\yii\web\User::id]].
     * @param Item $item the auth item that needs to execute its rule
     * @param array $params parameters passed to [[CheckAccessInterface::checkAccess()]] and will be passed to the rule
     * @return bool the return value of [[Rule::execute()]]. If the auth item does not specify a rule, true will be returned.
     * @throws InvalidConfigException if the auth item has an invalid rule.
     */
    protected function executeRule($user, $item, $params)
    {
        if ($item->ruleName === null) {
            return true;
        }
        $rule = $this->getRule($item->ruleName);
        if ($rule instanceof Rule) {
            return $rule->execute($user, $item, $params);
        } else {
            throw new InvalidConfigException("Rule not found: {$item->ruleName}");
        }
    }

    /**
     * Checks whether array of $assignments is empty and [[defaultRoles]] property is empty as well
     *
     * @param Assignment[] $assignments array of user's assignments
     * @return bool whether array of $assignments is empty and [[defaultRoles]] property is empty as well
     * @since 2.0.11
     */
    protected function hasNoAssignments(array $assignments)
    {
        return empty($assignments) && empty($this->defaultRoles);
    }
}


1		<?php
2		/**
3		* @link http://www.yiiframework.com/
4		* @copyright Copyright (c) 2008 Yii Software LLC
5		* @license http://www.yiiframework.com/license/
6		*/
7
8		namespace yii\rbac;
9
10		use yii\base\Component;
11		use yii\base\InvalidConfigException;
12		use yii\base\InvalidParamException;
13
14		/**
15		* BaseManager is a base class implementing [[ManagerInterface]] for RBAC management.
16		*
17		* For more details and usage information on DbManager, see the [guide article on security authorization](guide:security-authorization).
18		*
19		* @author Qiang Xue <[email protected]>
20		* @since 2.0
21		*/
22		abstract class BaseManager extends Component implements ManagerInterface
23		{
24		/**
25		* @var array a list of role names that are assigned to every user automatically without calling [[assign()]].
26		*/
27		public $defaultRoles = [];
28
29
30		/**
31		* Returns the named auth item.
32		* @param string $name the auth item name.
33		* @return Item the auth item corresponding to the specified name. Null is returned if no such item.
34		*/
35		abstract protected function getItem($name);
36
37		/**
38		* Returns the items of the specified type.
39		* @param int $type the auth item type (either [[Item::TYPE_ROLE]] or [[Item::TYPE_PERMISSION]]
40		* @return Item[] the auth items of the specified type.
41		*/
42		abstract protected function getItems($type);
43
44		/**
45		* Adds an auth item to the RBAC system.
46		* @param Item $item the item to add
47		* @return bool whether the auth item is successfully added to the system
48		* @throws \Exception if data validation or saving fails (such as the name of the role or permission is not unique)
49		*/
50		abstract protected function addItem($item);
51
52		/**
53		* Adds a rule to the RBAC system.
54		* @param Rule $rule the rule to add
55		* @return bool whether the rule is successfully added to the system
56		* @throws \Exception if data validation or saving fails (such as the name of the rule is not unique)
57		*/
58		abstract protected function addRule($rule);
59
60		/**
61		* Removes an auth item from the RBAC system.
62		* @param Item $item the item to remove
63		* @return bool whether the role or permission is successfully removed
64		* @throws \Exception if data validation or saving fails (such as the name of the role or permission is not unique)
65		*/
66		abstract protected function removeItem($item);
67
68		/**
69		* Removes a rule from the RBAC system.
70		* @param Rule $rule the rule to remove
71		* @return bool whether the rule is successfully removed
72		* @throws \Exception if data validation or saving fails (such as the name of the rule is not unique)
73		*/
74		abstract protected function removeRule($rule);
75
76		/**
77		* Updates an auth item in the RBAC system.
78		* @param string $name the name of the item being updated
79		* @param Item $item the updated item
80		* @return bool whether the auth item is successfully updated
81		* @throws \Exception if data validation or saving fails (such as the name of the role or permission is not unique)
82		*/
83		abstract protected function updateItem($name, $item);
84
85		/**
86		* Updates a rule to the RBAC system.
87		* @param string $name the name of the rule being updated
88		* @param Rule $rule the updated rule
89		* @return bool whether the rule is successfully updated
90		* @throws \Exception if data validation or saving fails (such as the name of the rule is not unique)
91		*/
92		abstract protected function updateRule($name, $rule);
93
94		/**
95		* @inheritdoc
96		*/
97	110	public function createRole($name)
98		{
99	110	$role = new Role();
100	110	$role->name = $name;
101	110	return $role;
102		}
103
104		/**
105		* @inheritdoc
106		*/
107	104	public function createPermission($name)
108		{
109	104	$permission = new Permission();
110	104	$permission->name = $name;
111	104	return $permission;
112		}
113
114		/**
115		* @inheritdoc
116		*/
117	110	public function add($object)
118		{
119	110	if ($object instanceof Item) {
120	105	if ($object->ruleName && $this->getRule($object->ruleName) === null) {
121	5	$rule = \Yii::createObject($object->ruleName);
122	5	$rule->name = $object->ruleName;
123	5	$this->addRule($rule);
124	5	}
125	105	return $this->addItem($object);
126	104	} elseif ($object instanceof Rule) {
127	104	return $this->addRule($object);
128		} else {
129		throw new InvalidParamException('Adding unsupported object type.');
130		}
131		}
132
133		/**
134		* @inheritdoc
135		*/
136	6	public function remove($object)
137		{
138	6	if ($object instanceof Item) {
139	6	return $this->removeItem($object);
140	5	} elseif ($object instanceof Rule) {
141	5	return $this->removeRule($object);
142		} else {
143		throw new InvalidParamException('Removing unsupported object type.');
144		}
145		}
146
147		/**
148		* @inheritdoc
149		*/
150	14	public function update($name, $object)
151		{
152	14	if ($object instanceof Item) {
153	14	if ($object->ruleName && $this->getRule($object->ruleName) === null) {
154		$rule = \Yii::createObject($object->ruleName);
155		$rule->name = $object->ruleName;
156		$this->addRule($rule);
157		}
158	14	return $this->updateItem($name, $object);
159	5	} elseif ($object instanceof Rule) {
160	5	return $this->updateRule($name, $object);
161		} else {
162		throw new InvalidParamException('Updating unsupported object type.');
163		}
164		}
165
166		/**
167		* @inheritdoc
168		*/
169	30	public function getRole($name)
170		{
171	30	$item = $this->getItem($name);
172	30	return $item instanceof Item && $item->type == Item::TYPE_ROLE ? $item : null;
173		}
174
175		/**
176		* @inheritdoc
177		*/
178	13	public function getPermission($name)
179		{
180	13	$item = $this->getItem($name);
181	13	return $item instanceof Item && $item->type == Item::TYPE_PERMISSION ? $item : null;
182		}
183
184		/**
185		* @inheritdoc
186		*/
187	20	public function getRoles()
188		{
189	20	return $this->getItems(Item::TYPE_ROLE);
190		}
191
192		/**
193		* Returns defaultRoles as array of Role objects
194		* @since 2.0.12
195		* @return Role[] default roles. The array is indexed by the role names
196		*/
197	10	public function getDefaultRoles()
198		{
199	10	$result = [];
200	10	foreach ($this->defaultRoles as $roleName) {
201	10	$result[$roleName] = $this->createRole($roleName);
202	10	}
203	10	return $result;
204		}
205
206		/**
207		* @inheritdoc
208		*/
209	15	public function getPermissions()
210		{
211	15	return $this->getItems(Item::TYPE_PERMISSION);
212		}
213
214		/**
215		* Executes the rule associated with the specified auth item.
216		*
217		* If the item does not specify a rule, this method will return true. Otherwise, it will
218		* return the value of [[Rule::execute()]].
219		*
220		* @param string\|int $user the user ID. This should be either an integer or a string representing
221		* the unique identifier of a user. See [[\yii\web\User::id]].
222		* @param Item $item the auth item that needs to execute its rule
223		* @param array $params parameters passed to [[CheckAccessInterface::checkAccess()]] and will be passed to the rule
224		* @return bool the return value of [[Rule::execute()]]. If the auth item does not specify a rule, true will be returned.
225		* @throws InvalidConfigException if the auth item has an invalid rule.
226		*/
227	10	protected function executeRule($user, $item, $params)
228		{
229	10	if ($item->ruleName === null) {
230	10	return true;
231		}
232	10	$rule = $this->getRule($item->ruleName);
233	10	if ($rule instanceof Rule) {
234	10	return $rule->execute($user, $item, $params);
235		} else {
236		throw new InvalidConfigException("Rule not found: {$item->ruleName}");
237		}
238		}
239
240		/**
241		* Checks whether array of $assignments is empty and [[defaultRoles]] property is empty as well
242		*
243		* @param Assignment[] $assignments array of user's assignments
244		* @return bool whether array of $assignments is empty and [[defaultRoles]] property is empty as well
245		* @since 2.0.11
246		*/
247	10	protected function hasNoAssignments(array $assignments)
248		{
249	10	return empty($assignments) && empty($this->defaultRoles);
250		}
251		}
252

rob006 / yii2-dev

GitHub Access Token became invalid

Push — master ( 97c43c...6b8cf1 )

BaseManager::getDefaultRoles() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like