Issues in SetterTrait.php - All Issues - Inspection of "removed `document.manage` permission" - hiqdev/hipanel-rbac - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b0c8b3...539d50 )

by Andrii

created 2017-12-13 16:33 UTC

src/SetterTrait.php (6 issues)

Labels

Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?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;
use yii\base\InvalidParamException;
use yii\rbac\Assignment;
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);
        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);

        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);
        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);

        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);
            if (is_null($parent)) {
                throw new InvalidParamException("Unknown parent:$name at setChild");
            }
        }
        if (is_string($child)) {
            $name  = $child;
            $child = $this->getItem($child);
            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);
    }

    /**
     * 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|null the assignment object or `null` when assignment was not found by name
     */
    public function setAssignment($item, $userId)
    {
        try {
            if (is_string($item)) {
                $item = $this->findItem($item);
            }
        } catch (InvalidParamException $e) {
            Yii::warning('Role or permission "' . $item . '" does not exist');

            return null;
        }

        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);
        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;
14			use yii\base\InvalidParamException;
15			use yii\rbac\Assignment;
16			use yii\rbac\Item;
17
18			/**
19			* Smart setters for AuthManager.
20			*
21			* @author Andrii Vasyliev <[email protected]>
22			*/
23			trait SetterTrait
24			{
25			/**
26			* Set permission.
27			* @param string $name
28			* @param string $description
29			* @return Item
30			*/
31	13		public function setPermission($name, $description = null)
32			{
33	13		$permission = $this->getPermission($name) ?: $this->createPermission($name);
34	13		if ($description) {
			0 ignored issues – show Bug Best Practice introduced 2016-10-07 09:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this 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...
35			$permission->description = $description;
36			}
37	13		$this->add($permission);
38
39	13		return $permission;
40			}
41
42			/**
43			* Set role.
44			* @param string $name
45			* @param string $description
46			* @return Item
47			*/
48	12		public function setRole($name, $description = null)
49			{
50	12		$role = $this->getRole($name) ?: $this->createRole($name);
51	12		if ($description) {
			0 ignored issues – show Bug Best Practice introduced 2016-10-07 09:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this 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...
52			$role->description = $description;
53			}
54	12		$this->add($role);
55
56	12		return $role;
57			}
58
59			/**
60			* Set child.
61			* @param string\|Item $parent
62			* @param string\|Item $child
63			* @return bool
64			*/
65	12		public function setChild($parent, $child)
66			{
67	12	View Code Duplication	if (is_string($parent)) {
68	12		$name = $parent;
69	12		$parent = $this->getItem($parent);
70	12		if (is_null($parent)) {
71			throw new InvalidParamException("Unknown parent:$name at setChild");
72			}
73			}
74	12	View Code Duplication	if (is_string($child)) {
75			$name = $child;
76			$child = $this->getItem($child);
77			if (is_null($child)) {
78			throw new InvalidParamException("Unknown child:$name at setChild");
79			}
80			}
81	12		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 Show Similar Issues like this 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...
82			return false;
83			}
84
85	12		return $this->addChild($parent, $child);
86			}
87
88			/**
89			* Assigns an item (role or permission) to a user.
90			* @param string\|Item $item
91			* @param string\|integer $userId the user ID (see [[\yii\web\User::id]])
92			* @throws \Exception when given wrong item name
93			* @return Assignment\|null the assignment object or `null` when assignment was not found by name
94			*/
95	24		public function setAssignment($item, $userId)
96			{
97			try {
98	24		if (is_string($item)) {
99	24		$item = $this->findItem($item);
100			}
101			} catch (InvalidParamException $e) {
102			Yii::warning('Role or permission "' . $item . '" does not exist');
103
104			return null;
105			}
106
107	24		if (isset($this->assignments[$userId][$item->name])) {
108			return $this->assignments[$userId][$item->name];
			0 ignored issues – show Bug introduced 2016-11-04 10:47 UTC by Report Bug Copy Issue Report Show Similar Issues like this 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...
109			}
110
111	24		return $this->assign($item, $userId);
			0 ignored issues – show Bug introduced 2016-10-07 09:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this 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...
112			}
113
114	24		protected function findItem($name, $description = null)
115			{
116	24		$item = $this->getItem($name);
117	24		if ($item) {
118	24		return $item;
119			}
120	2		if (strncmp($name, 'deny:', 5) === 0) {
121	2		return $this->setPermission($name, $description);
122			}
123
124			throw new InvalidParamException("Unknown item:$name at findItem");
125			}
126
127			/**
128			* Assigns items to a user.
129			* @param string\|array $items
130			* @param string\|integer $userId
131			*/
132	10		public function setAssignments($items, $userId)
133			{
134	10		if (is_string($items)) {
135	10		$items = explode(',', $items);
136			}
137	10		foreach ($items as $item) {
138	10		$this->setAssignment($item, $userId);
139			}
140	10		}
141
142			/**
143			* Returns all assignments in the system.
144			* @return array
145			*/
146			public function getAllAssignments()
147			{
148			return $this->assignments;
149			}
150
151			/**
152			* Returns all items in the system.
153			* @return array
154			*/
155	24		public function getAllItems()
156			{
157	24		return $this->items;
			0 ignored issues – show Bug introduced 2017-08-02 14:40 UTC by Report Bug Copy Issue Report Show Similar Issues like this 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...
158			}
159			}
160

hiqdev / hipanel-rbac

Push — master ( b0c8b3...539d50 )

src/SetterTrait.php (6 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like