AssignmentModel - Code Metrics - yii2mod/yii2-rbac - Measure and Improve Code Quality continuously with Scrutinizer

AssignmentModel A
last analyzed 2019-11-02 17:52 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	105
Duplicated Lines	23.81 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

Metric	Value
wmc	13
lcom	1
cbo	6
dl	25
loc	105
rs	10
c	0
b	0
f	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	2
A	assign()	10	10	3
A	revoke()	10	10	3
A	getItems()	5	25	5

How to fix Duplicated Code

<?php

namespace yii2mod\rbac\models;

use Yii;
use yii\base\BaseObject;
use yii\base\InvalidConfigException;
use yii\web\IdentityInterface;

/**
 * Class AssignmentModel
 *
 * @package yii2mod\rbac\models
 */
class AssignmentModel extends BaseObject
{
    /**
     * @var IdentityInterface
     */
    public $user;

    /**
     * @var int User id
     */
    public $userId;

    /**
     * @var \yii\rbac\ManagerInterface
     */
    protected $manager;

    /**
     * AssignmentModel constructor.
     *
     * @param IdentityInterface $user
     * @param array $config
     *
     * @throws InvalidConfigException
     */
    public function __construct(IdentityInterface $user, $config = [])
    {
        $this->user = $user;
        $this->userId = $user->getId();
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $this->manager = Yii::$app->authManager;

        if ($this->userId === null) {
            throw new InvalidConfigException('The "userId" property must be set.');
        }

        parent::__construct($config);
    }

    /**
     * Assign a roles and permissions to the user.
     *
     * @param array $items
     *
     * @return bool
     */
    public function assign(array $items): bool

    {
        foreach ($items as $name) {
            $item = $this->manager->getRole($name);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
            $item = $item ?: $this->manager->getPermission($name);
            $this->manager->assign($item, $this->userId);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        }

        return true;
    }

    /**
     * Revokes a roles and permissions from the user.
     *
     * @param array $items
     *
     * @return bool
     */
    public function revoke(array $items): bool

    {
        foreach ($items as $name) {
            $item = $this->manager->getRole($name);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
            $item = $item ?: $this->manager->getPermission($name);
            $this->manager->revoke($item, $this->userId);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        }

        return true;
    }

    /**
     * Get all available and assigned roles and permissions
     *
     * @return array
     */
    public function getItems(): array
    {
        $available = [];
        $assigned = [];

        foreach (array_keys($this->manager->getRoles()) as $name) {
            $available[$name] = 'role';
        }

        foreach (array_keys($this->manager->getPermissions()) as $name) {

            if ($name[0] != '/') {
                $available[$name] = 'permission';
            }
        }

        foreach ($this->manager->getAssignments($this->userId) as $item) {
            $assigned[$item->roleName] = $available[$item->roleName];
            unset($available[$item->roleName]);
        }

        return [
            'available' => $available,
            'assigned' => $assigned,
        ];
    }
}


1		<?php
2
3		namespace yii2mod\rbac\models;
4
5		use Yii;
6		use yii\base\BaseObject;
7		use yii\base\InvalidConfigException;
8		use yii\web\IdentityInterface;
9
10		/**
11		* Class AssignmentModel
12		*
13		* @package yii2mod\rbac\models
14		*/
15		class AssignmentModel extends BaseObject
16		{
17		/**
18		* @var IdentityInterface
19		*/
20		public $user;
21
22		/**
23		* @var int User id
24		*/
25		public $userId;
26
27		/**
28		* @var \yii\rbac\ManagerInterface
29		*/
30		protected $manager;
31
32		/**
33		* AssignmentModel constructor.
34		*
35		* @param IdentityInterface $user
36		* @param array $config
37		*
38		* @throws InvalidConfigException
39		*/
40		public function __construct(IdentityInterface $user, $config = [])
41		{
42		$this->user = $user;
43		$this->userId = $user->getId();
		0 ignored issues – show Documentation Bug introduced 2017-08-14 07:08 UTC by Report Bug Copy Issue Report It seems like `$user->getId()` can also be of type `string`. However, the property `$userId` is declared as type `integer`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
44		$this->manager = Yii::$app->authManager;
45
46		if ($this->userId === null) {
47		throw new InvalidConfigException('The "userId" property must be set.');
48		}
49
50		parent::__construct($config);
51		}
52
53		/**
54		* Assign a roles and permissions to the user.
55		*
56		* @param array $items
57		*
58		* @return bool
59		*/
60	View Code Duplication	public function assign(array $items): bool
		0 ignored issues – show Duplication introduced 2017-08-14 07:08 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...
61		{
62		foreach ($items as $name) {
63		$item = $this->manager->getRole($name);
		0 ignored issues – show Bug introduced 2017-08-14 07:08 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$item` is correct as `$this->manager->getRole($name)` (which targets `yii\rbac\ManagerInterface::getRole()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
64		$item = $item ?: $this->manager->getPermission($name);
65		$this->manager->assign($item, $this->userId);
		0 ignored issues – show Bug introduced 2017-11-28 16:11 UTC by Report Bug Copy Issue Report It seems like `$item` defined by `$item ?: $this->manager->getPermission($name)` on line `64` can be `null`; however, `yii\rbac\ManagerInterface::assign()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
66		}
67
68		return true;
69		}
70
71		/**
72		* Revokes a roles and permissions from the user.
73		*
74		* @param array $items
75		*
76		* @return bool
77		*/
78	View Code Duplication	public function revoke(array $items): bool
		0 ignored issues – show Duplication introduced 2017-08-14 07:08 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...
79		{
80		foreach ($items as $name) {
81		$item = $this->manager->getRole($name);
		0 ignored issues – show Bug introduced 2017-08-14 07:08 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$item` is correct as `$this->manager->getRole($name)` (which targets `yii\rbac\ManagerInterface::getRole()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
82		$item = $item ?: $this->manager->getPermission($name);
83		$this->manager->revoke($item, $this->userId);
		0 ignored issues – show Bug introduced 2017-11-28 16:11 UTC by Report Bug Copy Issue Report It seems like `$item` defined by `$item ?: $this->manager->getPermission($name)` on line `82` can be `null`; however, `yii\rbac\ManagerInterface::revoke()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
84		}
85
86		return true;
87		}
88
89		/**
90		* Get all available and assigned roles and permissions
91		*
92		* @return array
93		*/
94		public function getItems(): array
95		{
96		$available = [];
97		$assigned = [];
98
99		foreach (array_keys($this->manager->getRoles()) as $name) {
100		$available[$name] = 'role';
101		}
102
103	View Code Duplication	foreach (array_keys($this->manager->getPermissions()) as $name) {
		0 ignored issues – show Duplication introduced 2017-09-11 16:26 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...
104		if ($name[0] != '/') {
105		$available[$name] = 'permission';
106		}
107		}
108
109		foreach ($this->manager->getAssignments($this->userId) as $item) {
110		$assigned[$item->roleName] = $available[$item->roleName];
111		unset($available[$item->roleName]);
112		}
113
114		return [
115		'available' => $available,
116		'assigned' => $assigned,
117		];
118		}
119		}
120

yii2mod / yii2-rbac

AssignmentModel A last analyzed 2019-11-02 17:52 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

AssignmentModel A
last analyzed 2019-11-02 17:52 UTC