AuthItem - Code Metrics - Inspection of "Do not show routes on both Permissions list and Pe..." - mdmsoft/yii2-admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#421)

unknown

created 2019-04-12 04:16 UTC

AuthItem C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	274
Duplicated Lines	16.79 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes

Metric	Value
wmc	55
lcom	1
cbo	8
dl	46
loc	274
rs	6
c	0
b	0
f	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	3
A	rules()	0	13	2
A	checkUnique()	0	13	3
A	checkRule()	0	17	4
A	attributeLabels()	0	10	1
A	getIsNewRecord()	0	4	1
A	find()	0	9	2
B	save()	0	30	7
B	addChildren()	23	23	7
B	removeChildren()	23	23	7
F	getItems()	0	26	15
A	getItem()	0	4	1
A	getTypeName()	0	12	2

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like AuthItem often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use AuthItem, and based on these observations, apply Extract Interface, too.

<?php

namespace mdm\admin\models;

use mdm\admin\components\Configs;
use mdm\admin\components\Helper;
use Yii;
use yii\base\Model;
use yii\helpers\Json;
use yii\rbac\Item;

/**
 * This is the model class for table "tbl_auth_item".
 *
 * @property string $name
 * @property integer $type
 * @property string $description
 * @property string $ruleName
 * @property string $data
 *
 * @property Item $item
 *
 * @author Misbahul D Munir <[email protected]>
 * @since 1.0
 */
class AuthItem extends Model
{
    public $name;
    public $type;
    public $description;
    public $ruleName;
    public $data;
    /**
     * @var Item
     */
    private $_item;

    /**
     * Initialize object
     * @param Item  $item
     * @param array $config
     */
    public function __construct($item = null, $config = [])
    {
        $this->_item = $item;
        if ($item !== null) {
            $this->name = $item->name;
            $this->type = $item->type;
            $this->description = $item->description;
            $this->ruleName = $item->ruleName;
            $this->data = $item->data === null ? null : Json::encode($item->data);
        }
        parent::__construct($config);
    }

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return [
            [['ruleName'], 'checkRule'],
            [['name', 'type'], 'required'],
            [['name'], 'checkUnique', 'when' => function () {
                return $this->isNewRecord || ($this->_item->name != $this->name);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            }],
            [['type'], 'integer'],
            [['description', 'data', 'ruleName'], 'default'],
            [['name'], 'string', 'max' => 64],
        ];
    }

    /**
     * Check role is unique
     */
    public function checkUnique()
    {
        $authManager = Configs::authManager();
        $value = $this->name;
        if ($authManager->getRole($value) !== null || $authManager->getPermission($value) !== null) {
            $message = Yii::t('yii', '{attribute} "{value}" has already been taken.');
            $params = [
                'attribute' => $this->getAttributeLabel('name'),
                'value' => $value,
            ];
            $this->addError('name', Yii::$app->getI18n()->format($message, $params, Yii::$app->language));
        }
    }

    /**
     * Check for rule
     */
    public function checkRule()
    {
        $name = $this->ruleName;
        if (!Configs::authManager()->getRule($name)) {
            try {
                $rule = Yii::createObject($name);
                if ($rule instanceof \yii\rbac\Rule) {
                    $rule->name = $name;
                    Configs::authManager()->add($rule);
                } else {
                    $this->addError('ruleName', Yii::t('rbac-admin', 'Invalid rule "{value}"', ['value' => $name]));
                }
            } catch (\Exception $exc) {
                $this->addError('ruleName', Yii::t('rbac-admin', 'Rule "{value}" does not exists', ['value' => $name]));
            }
        }
    }

    /**
     * @inheritdoc
     */
    public function attributeLabels()
    {
        return [
            'name' => Yii::t('rbac-admin', 'Name'),
            'type' => Yii::t('rbac-admin', 'Type'),
            'description' => Yii::t('rbac-admin', 'Description'),
            'ruleName' => Yii::t('rbac-admin', 'Rule Name'),
            'data' => Yii::t('rbac-admin', 'Data'),
        ];
    }

    /**
     * Check if is new record.
     * @return boolean
     */
    public function getIsNewRecord()
    {
        return $this->_item === null;
    }

    /**
     * Find role
     * @param string $id
     * @return null|\self
     */
    public static function find($id)
    {
        $item = Configs::authManager()->getRole($id);
        if ($item !== null) {
            return new self($item);
        }

        return null;
    }

    /**
     * Save role to [[\yii\rbac\authManager]]
     * @return boolean
     */
    public function save()
    {
        if ($this->validate()) {
            $manager = Configs::authManager();
            if ($this->_item === null) {
                if ($this->type == Item::TYPE_ROLE) {
                    $this->_item = $manager->createRole($this->name);
                } else {
                    $this->_item = $manager->createPermission($this->name);
                }
                $isNew = true;
            } else {
                $isNew = false;
                $oldName = $this->_item->name;
            }
            $this->_item->name = $this->name;
            $this->_item->description = $this->description;
            $this->_item->ruleName = $this->ruleName;
            $this->_item->data = $this->data === null || $this->data === '' ? null : Json::decode($this->data);
            if ($isNew) {
                $manager->add($this->_item);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            } else {
                $manager->update($oldName, $this->_item);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            }
            Helper::invalidate();
            return true;
        } else {
            return false;
        }
    }

    /**
     * Adds an item as a child of another item.
     * @param array $items
     * @return int
     */
    public function addChildren($items)

    {
        $manager = Configs::authManager();
        $success = 0;
        if ($this->_item) {
            foreach ($items as $name) {
                $child = $manager->getPermission($name);
                if ($this->type == Item::TYPE_ROLE && $child === null) {
                    $child = $manager->getRole($name);
                }
                try {
                    $manager->addChild($this->_item, $child);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                    $success++;
                } catch (\Exception $exc) {
                    Yii::error($exc->getMessage(), __METHOD__);
                }
            }
        }
        if ($success > 0) {
            Helper::invalidate();
        }
        return $success;
    }

    /**
     * Remove an item as a child of another item.
     * @param array $items
     * @return int
     */
    public function removeChildren($items)

    {
        $manager = Configs::authManager();
        $success = 0;
        if ($this->_item !== null) {
            foreach ($items as $name) {
                $child = $manager->getPermission($name);
                if ($this->type == Item::TYPE_ROLE && $child === null) {
                    $child = $manager->getRole($name);
                }
                try {
                    $manager->removeChild($this->_item, $child);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                    $success++;
                } catch (\Exception $exc) {
                    Yii::error($exc->getMessage(), __METHOD__);
                }
            }
        }
        if ($success > 0) {
            Helper::invalidate();
        }
        return $success;
    }

    /**
     * Get items
     * @return array
     */
    public function getItems()
    {
        $manager = Configs::authManager();
        $advanced = Configs::instance()->advanced;
        $available = [];
        if ($this->type == Item::TYPE_ROLE) {
            foreach (array_keys($manager->getRoles()) as $name) {
                $available[$name] = 'role';
            }
        }
        foreach (array_keys($manager->getPermissions()) as $name) {
            $available[$name] = $name[0] == '/' ? 'route' : 'permission';
            $available[$name] = $name[0] == '/' || $advanced && $name[0] == '@' ? 'route' : 'permission';
        }
        $assigned = [];
        foreach ($manager->getChildren($this->_item->name) as $item) {
            $assigned[$item->name] = $item->type == 1 ? 'role' : ($item->name[0] == '/' ? 'route' : 'permission');
            $assigned[$item->name] = $item->type == 1 ? 'role' : ($item->name[0] == '/' || $advanced && $item->name[0] == '@' ? 'route' : 'permission');
            unset($available[$item->name]);
        }
        unset($available[$this->name]);
        return [
            'available' => $available,
            'assigned' => $assigned,
        ];
    }

    /**
     * Get item
     * @return Item
     */
    public function getItem()
    {
        return $this->_item;
    }

    /**
     * Get type name
     * @param  mixed $type
     * @return string|array
     */
    public static function getTypeName($type = null)
    {
        $result = [
            Item::TYPE_PERMISSION => 'Permission',
            Item::TYPE_ROLE => 'Role',
        ];
        if ($type === null) {
            return $result;
        }

        return $result[$type];
    }
}


1		<?php
2
3		namespace mdm\admin\models;
4
5		use mdm\admin\components\Configs;
6		use mdm\admin\components\Helper;
7		use Yii;
8		use yii\base\Model;
9		use yii\helpers\Json;
10		use yii\rbac\Item;
11
12		/**
13		* This is the model class for table "tbl_auth_item".
14		*
15		* @property string $name
16		* @property integer $type
17		* @property string $description
18		* @property string $ruleName
19		* @property string $data
20		*
21		* @property Item $item
22		*
23		* @author Misbahul D Munir <[email protected]>
24		* @since 1.0
25		*/
26		class AuthItem extends Model
27		{
28		public $name;
29		public $type;
30		public $description;
31		public $ruleName;
32		public $data;
33		/**
34		* @var Item
35		*/
36		private $_item;
37
38		/**
39		* Initialize object
40		* @param Item $item
41		* @param array $config
42		*/
43		public function __construct($item = null, $config = [])
44		{
45		$this->_item = $item;
46		if ($item !== null) {
47		$this->name = $item->name;
48		$this->type = $item->type;
49		$this->description = $item->description;
50		$this->ruleName = $item->ruleName;
51		$this->data = $item->data === null ? null : Json::encode($item->data);
52		}
53		parent::__construct($config);
54		}
55
56		/**
57		* @inheritdoc
58		*/
59		public function rules()
60		{
61		return [
62		[['ruleName'], 'checkRule'],
63		[['name', 'type'], 'required'],
64		[['name'], 'checkUnique', 'when' => function () {
65		return $this->isNewRecord \|\| ($this->_item->name != $this->name);
		0 ignored issues – show Documentation introduced 2016-03-18 12:53 UTC by Report Bug Copy Issue Report The property `isNewRecord` does not exist on `object<mdm\admin\models\AuthItem>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
66		}],
67		[['type'], 'integer'],
68		[['description', 'data', 'ruleName'], 'default'],
69		[['name'], 'string', 'max' => 64],
70		];
71		}
72
73		/**
74		* Check role is unique
75		*/
76		public function checkUnique()
77		{
78		$authManager = Configs::authManager();
79		$value = $this->name;
80		if ($authManager->getRole($value) !== null \|\| $authManager->getPermission($value) !== null) {
81		$message = Yii::t('yii', '{attribute} "{value}" has already been taken.');
82		$params = [
83		'attribute' => $this->getAttributeLabel('name'),
84		'value' => $value,
85		];
86		$this->addError('name', Yii::$app->getI18n()->format($message, $params, Yii::$app->language));
87		}
88		}
89
90		/**
91		* Check for rule
92		*/
93		public function checkRule()
94		{
95		$name = $this->ruleName;
96		if (!Configs::authManager()->getRule($name)) {
97		try {
98		$rule = Yii::createObject($name);
99		if ($rule instanceof \yii\rbac\Rule) {
100		$rule->name = $name;
101		Configs::authManager()->add($rule);
102		} else {
103		$this->addError('ruleName', Yii::t('rbac-admin', 'Invalid rule "{value}"', ['value' => $name]));
104		}
105		} catch (\Exception $exc) {
106		$this->addError('ruleName', Yii::t('rbac-admin', 'Rule "{value}" does not exists', ['value' => $name]));
107		}
108		}
109		}
110
111		/**
112		* @inheritdoc
113		*/
114		public function attributeLabels()
115		{
116		return [
117		'name' => Yii::t('rbac-admin', 'Name'),
118		'type' => Yii::t('rbac-admin', 'Type'),
119		'description' => Yii::t('rbac-admin', 'Description'),
120		'ruleName' => Yii::t('rbac-admin', 'Rule Name'),
121		'data' => Yii::t('rbac-admin', 'Data'),
122		];
123		}
124
125		/**
126		* Check if is new record.
127		* @return boolean
128		*/
129		public function getIsNewRecord()
130		{
131		return $this->_item === null;
132		}
133
134		/**
135		* Find role
136		* @param string $id
137		* @return null\|\self
138		*/
139		public static function find($id)
140		{
141		$item = Configs::authManager()->getRole($id);
142		if ($item !== null) {
143		return new self($item);
144		}
145
146		return null;
147		}
148
149		/**
150		* Save role to [[\yii\rbac\authManager]]
151		* @return boolean
152		*/
153		public function save()
154		{
155		if ($this->validate()) {
156		$manager = Configs::authManager();
157		if ($this->_item === null) {
158		if ($this->type == Item::TYPE_ROLE) {
159		$this->_item = $manager->createRole($this->name);
160		} else {
161		$this->_item = $manager->createPermission($this->name);
162		}
163		$isNew = true;
164		} else {
165		$isNew = false;
166		$oldName = $this->_item->name;
167		}
168		$this->_item->name = $this->name;
169		$this->_item->description = $this->description;
170		$this->_item->ruleName = $this->ruleName;
171		$this->_item->data = $this->data === null \|\| $this->data === '' ? null : Json::decode($this->data);
172		if ($isNew) {
173		$manager->add($this->_item);
		0 ignored issues – show Documentation introduced 2016-08-09 14:22 UTC by Report Bug Copy Issue Report `$this->_item` is of type `object<yii\rbac\Item>`, but the function expects a `object<yii\rbac\Role>\|ob...>\|object<yii\rbac\Rule>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
174		} else {
175		$manager->update($oldName, $this->_item);
		0 ignored issues – show Bug introduced 2016-03-18 12:53 UTC by Report Bug Copy Issue Report The variable `$oldName` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history... Documentation introduced 2016-08-09 14:22 UTC by Report Bug Copy Issue Report `$this->_item` is of type `object<yii\rbac\Item>`, but the function expects a `object<yii\rbac\Role>\|ob...>\|object<yii\rbac\Rule>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
176		}
177		Helper::invalidate();
178		return true;
179		} else {
180		return false;
181		}
182		}
183
184		/**
185		* Adds an item as a child of another item.
186		* @param array $items
187		* @return int
188		*/
189	View Code Duplication	public function addChildren($items)
		0 ignored issues – show Duplication introduced 2017-08-01 07:59 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
190		{
191		$manager = Configs::authManager();
192		$success = 0;
193		if ($this->_item) {
194		foreach ($items as $name) {
195		$child = $manager->getPermission($name);
196		if ($this->type == Item::TYPE_ROLE && $child === null) {
197		$child = $manager->getRole($name);
198		}
199		try {
200		$manager->addChild($this->_item, $child);
		0 ignored issues – show Bug introduced 2016-08-09 14:22 UTC by Report Bug Copy Issue Report It seems like `$child` can also be of type `null`; however, `yii\rbac\ManagerInterface::addChild()` does only seem to accept `object<yii\rbac\Item>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
201		$success++;
202		} catch (\Exception $exc) {
203		Yii::error($exc->getMessage(), __METHOD__);
204		}
205		}
206		}
207		if ($success > 0) {
208		Helper::invalidate();
209		}
210		return $success;
211		}
212
213		/**
214		* Remove an item as a child of another item.
215		* @param array $items
216		* @return int
217		*/
218	View Code Duplication	public function removeChildren($items)
		0 ignored issues – show Duplication introduced 2017-08-01 07:59 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
219		{
220		$manager = Configs::authManager();
221		$success = 0;
222		if ($this->_item !== null) {
223		foreach ($items as $name) {
224		$child = $manager->getPermission($name);
225		if ($this->type == Item::TYPE_ROLE && $child === null) {
226		$child = $manager->getRole($name);
227		}
228		try {
229		$manager->removeChild($this->_item, $child);
		0 ignored issues – show Bug introduced 2016-08-09 14:22 UTC by Report Bug Copy Issue Report It seems like `$child` can also be of type `null`; however, `yii\rbac\ManagerInterface::removeChild()` does only seem to accept `object<yii\rbac\Item>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
230		$success++;
231		} catch (\Exception $exc) {
232		Yii::error($exc->getMessage(), __METHOD__);
233		}
234		}
235		}
236		if ($success > 0) {
237		Helper::invalidate();
238		}
239		return $success;
240		}
241
242		/**
243		* Get items
244		* @return array
245		*/
246		public function getItems()
247		{
248		$manager = Configs::authManager();
249		$advanced = Configs::instance()->advanced;
250		$available = [];
251		if ($this->type == Item::TYPE_ROLE) {
252		foreach (array_keys($manager->getRoles()) as $name) {
253		$available[$name] = 'role';
254		}
255		}
256		foreach (array_keys($manager->getPermissions()) as $name) {
257		$available[$name] = $name[0] == '/' ? 'route' : 'permission';
258		$available[$name] = $name[0] == '/' \|\| $advanced && $name[0] == '@' ? 'route' : 'permission';
259		}
260		$assigned = [];
261		foreach ($manager->getChildren($this->_item->name) as $item) {
262		$assigned[$item->name] = $item->type == 1 ? 'role' : ($item->name[0] == '/' ? 'route' : 'permission');
263		$assigned[$item->name] = $item->type == 1 ? 'role' : ($item->name[0] == '/' \|\| $advanced && $item->name[0] == '@' ? 'route' : 'permission');
264		unset($available[$item->name]);
265		}
266		unset($available[$this->name]);
267		return [
268		'available' => $available,
269		'assigned' => $assigned,
270		];
271		}
272
273		/**
274		* Get item
275		* @return Item
276		*/
277		public function getItem()
278		{
279		return $this->_item;
280		}
281
282		/**
283		* Get type name
284		* @param mixed $type
285		* @return string\|array
286		*/
287		public static function getTypeName($type = null)
288		{
289		$result = [
290		Item::TYPE_PERMISSION => 'Permission',
291		Item::TYPE_ROLE => 'Role',
292		];
293		if ($type === null) {
294		return $result;
295		}
296
297		return $result[$type];
298		}
299		}
300

mdmsoft / yii2-admin