SetterTrait::setChild() - Code Metrics - Inspection of "Added server.sell permission" - hiqdev/hipanel-rbac - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 44a76b...721920 )

by Dmitry

created 2017-07-11 15:33 UTC

SetterTrait::setChild() B

↳ Parent: SetterTrait

Complexity

Conditions	6
Paths	11

Size

Total Lines	22
Code Lines	14

Duplication

Lines	14
Ratio	63.64 %

Code Coverage

Tests	9
CRAP Score	9.0146

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	14
loc	22
ccs	9
cts	16
cp	0.5625
rs	8.6737
cc	6
eloc	14
nc	11
nop	2
crap	9.0146

<?php
/**
 * RBAC implementation for HiPanel.
 *
 * @link      https://github.com/hiqdev/hipanel-rbac
 * @package   hipanel-rbac
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2016-2017, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\rbac;

use yii\base\InvalidParamException;
use yii\rbac\Item;

/**
 * Smart setters for AuthManager.
 *
 * @author Andrii Vasyliev <[email protected]>
 */
trait SetterTrait
{
    /**
     * Set permission.
     * @param string $name
     * @param string $description
     * @return Item
     */
    public function setPermission($name, $description = null)
    {
        $permission = $this->getPermission($name) ?: $this->createPermission($name);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        if ($description) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $permission->description = $description;
        }
        $this->add($permission);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        return $permission;
    }

    /**
     * Set role.
     * @param string $name
     * @param string $description
     * @return Item
     */
    public function setRole($name, $description = null)
    {
        $role = $this->getRole($name) ?: $this->createRole($name);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        if ($description) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $role->description = $description;
        }
        $this->add($role);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        return $role;
    }

    /**
     * Set child.
     * @param string|Item $parent
     * @param string|Item $child
     * @return bool
     */
    public function setChild($parent, $child)
    {
        if (is_string($parent)) {

            $name   = $parent;
            $parent = $this->getItem($parent);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            if (is_null($parent)) {
                throw new InvalidParamException("Unknown parent:$name at setChild");
            }
        }
        if (is_string($child)) {

            $name  = $child;
            $child = $this->getItem($child);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            if (is_null($child)) {
                throw new InvalidParamException("Unknown child:$name at setChild");
            }
        }
        if (isset($this->children[$parent->name][$child->name])) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            return false;
        }

        return $this->addChild($parent, $child);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Assigns an item (role or permission) to a user.
     * @param string|Item $item
     * @param string|integer $userId the user ID (see [[\yii\web\User::id]])
     * @throws \Exception when given wrong item name
     * @return Assignment the assignment object
     */
    public function setAssignment($item, $userId)
    {
        if (is_string($item)) {
            $item = $this->findItem($item);
        }
        if (isset($this->assignments[$userId][$item->name])) {
            return $this->assignments[$userId][$item->name];
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }

        return $this->assign($item, $userId);

    }

    protected function findItem($name, $description = null)
    {
        $item = $this->getItem($name);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        if ($item) {
            return $item;
        }
        if (strncmp($name, 'deny:', 5) === 0) {
            return $this->setPermission($name, $description);
        }

        throw new InvalidParamException("Unknown item:$name at findItem");
    }

    /**
     * Assigns items to a user.
     * @param string|array $items
     * @param string|integer $userId
     */
    public function setAssignments($items, $userId)
    {
        if (is_string($items)) {
            $items = explode(',', $items);
        }
        foreach ($items as $item) {
            $this->setAssignment($item, $userId);
        }
    }

    /**
     * Returns all assignments in the system.
     * @return array
     */
    public function getAllAssignments()
    {
        return $this->assignments;
    }

    /**
     * Returns all items in the system.
     * @return array
     */
    public function getAllItems()
    {
        return $this->items;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }
}


1			<?php
2			/**
3			* RBAC implementation for HiPanel.
4			*
5			* @link https://github.com/hiqdev/hipanel-rbac
6			* @package hipanel-rbac
7			* @license BSD-3-Clause
8			* @copyright Copyright (c) 2016-2017, HiQDev (http://hiqdev.com/)
9			*/
10
11			namespace hipanel\rbac;
12
13			use yii\base\InvalidParamException;
14			use yii\rbac\Item;
15
16			/**
17			* Smart setters for AuthManager.
18			*
19			* @author Andrii Vasyliev <[email protected]>
20			*/
21			trait SetterTrait
22			{
23			/**
24			* Set permission.
25			* @param string $name
26			* @param string $description
27			* @return Item
28			*/
29	7		public function setPermission($name, $description = null)
30			{
31	7		$permission = $this->getPermission($name) ?: $this->createPermission($name);
			0 ignored issues – show Bug introduced 2016-10-07 15:19 UTC by Report Bug Copy Issue Report It seems like `getPermission()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history... Bug introduced 2016-10-07 09:57 UTC by Report Bug Copy Issue Report It seems like `createPermission()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
32	7		if ($description) {
			0 ignored issues – show Bug Best Practice introduced 2016-10-07 09:57 UTC by Report Bug Copy Issue Report The expression `$description` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
33			$permission->description = $description;
34			}
35	7		$this->add($permission);
			0 ignored issues – show Bug introduced 2016-10-07 09:57 UTC by Report Bug Copy Issue Report It seems like `add()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
36
37	7		return $permission;
38			}
39
40			/**
41			* Set role.
42			* @param string $name
43			* @param string $description
44			* @return Item
45			*/
46	7		public function setRole($name, $description = null)
47			{
48	7		$role = $this->getRole($name) ?: $this->createRole($name);
			0 ignored issues – show Bug introduced 2016-10-07 15:19 UTC by Report Bug Copy Issue Report It seems like `getRole()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history... Bug introduced 2016-10-07 09:57 UTC by Report Bug Copy Issue Report It seems like `createRole()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
49	7		if ($description) {
			0 ignored issues – show Bug Best Practice introduced 2016-10-07 09:57 UTC by Report Bug Copy Issue Report The expression `$description` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
50			$role->description = $description;
51			}
52	7		$this->add($role);
			0 ignored issues – show Bug introduced 2016-10-07 09:57 UTC by Report Bug Copy Issue Report It seems like `add()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
53
54	7		return $role;
55			}
56
57			/**
58			* Set child.
59			* @param string\|Item $parent
60			* @param string\|Item $child
61			* @return bool
62			*/
63	7		public function setChild($parent, $child)
64			{
65	7	View Code Duplication	if (is_string($parent)) {
			0 ignored issues – show Duplication introduced 2016-10-07 09:57 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
66	7		$name = $parent;
67	7		$parent = $this->getItem($parent);
			0 ignored issues – show Bug introduced 2016-10-07 09:57 UTC by Report Bug Copy Issue Report It seems like `getItem()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
68	7		if (is_null($parent)) {
69			throw new InvalidParamException("Unknown parent:$name at setChild");
70			}
71	7		}
72	7	View Code Duplication	if (is_string($child)) {
			0 ignored issues – show Duplication introduced 2016-10-07 09:57 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
73			$name = $child;
74			$child = $this->getItem($child);
			0 ignored issues – show Bug introduced 2016-10-07 09:57 UTC by Report Bug Copy Issue Report It seems like `getItem()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
75			if (is_null($child)) {
76			throw new InvalidParamException("Unknown child:$name at setChild");
77			}
78			}
79	7		if (isset($this->children[$parent->name][$child->name])) {
			0 ignored issues – show Bug introduced 2016-10-07 09:57 UTC by Report Bug Copy Issue Report The property `children` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
80			return false;
81			}
82
83	7		return $this->addChild($parent, $child);
			0 ignored issues – show Bug introduced 2016-10-07 09:57 UTC by Report Bug Copy Issue Report It seems like `addChild()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
84			}
85
86			/**
87			* Assigns an item (role or permission) to a user.
88			* @param string\|Item $item
89			* @param string\|integer $userId the user ID (see [[\yii\web\User::id]])
90			* @throws \Exception when given wrong item name
91			* @return Assignment the assignment object
92			*/
93	14		public function setAssignment($item, $userId)
94			{
95	14		if (is_string($item)) {
96	14		$item = $this->findItem($item);
97	14		}
98	14		if (isset($this->assignments[$userId][$item->name])) {
99			return $this->assignments[$userId][$item->name];
			0 ignored issues – show Bug introduced 2016-11-04 10:47 UTC by Report Bug Copy Issue Report The property `assignments` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
100			}
101
102	14		return $this->assign($item, $userId);
			0 ignored issues – show Bug introduced 2016-10-07 09:57 UTC by Report Bug Copy Issue Report The method `assign()` does not exist on `hipanel\rbac\SetterTrait`. Did you maybe mean `setAssignment()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
103			}
104
105	14		protected function findItem($name, $description = null)
106			{
107	14		$item = $this->getItem($name);
			0 ignored issues – show Bug introduced 2017-06-30 08:34 UTC by Report Bug Copy Issue Report It seems like `getItem()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
108	14		if ($item) {
109	14		return $item;
110			}
111	1		if (strncmp($name, 'deny:', 5) === 0) {
112	1		return $this->setPermission($name, $description);
113			}
114
115			throw new InvalidParamException("Unknown item:$name at findItem");
116			}
117
118			/**
119			* Assigns items to a user.
120			* @param string\|array $items
121			* @param string\|integer $userId
122			*/
123	4		public function setAssignments($items, $userId)
124			{
125	4		if (is_string($items)) {
126	4		$items = explode(',', $items);
127	4		}
128	4		foreach ($items as $item) {
129	4		$this->setAssignment($item, $userId);
130	4		}
131	4		}
132
133			/**
134			* Returns all assignments in the system.
135			* @return array
136			*/
137			public function getAllAssignments()
138			{
139			return $this->assignments;
140			}
141
142			/**
143			* Returns all items in the system.
144			* @return array
145			*/
146	14		public function getAllItems()
147			{
148	14		return $this->items;
			0 ignored issues – show Bug introduced 2016-11-04 10:47 UTC by Report Bug Copy Issue Report The property `items` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
149			}
150			}
151

hiqdev / hipanel-rbac

Push — master ( 44a76b...721920 )

SetterTrait::setChild() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like