AuthHelper::getPermission() - Code Metrics - 2amigos/yii2-usuario - Measure and Improve Code Quality continuously with Scrutinizer

AuthHelper::getPermission() A
last analyzed 2021-05-22 12:13 UTC

↳ Parent: AuthHelper

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	2
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

<?php

/*
 * This file is part of the 2amigos/yii2-usuario project.
 *
 * (c) 2amigOS! <http://2amigos.us/>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace Da\User\Helper;

use Da\User\Model\AbstractAuthItem;
use Da\User\Module;
use Da\User\Traits\AuthManagerAwareTrait;
use Yii;
use yii\helpers\ArrayHelper;
use yii\rbac\Permission;
use yii\rbac\Role;
use yii\rbac\Rule;

class AuthHelper
{
    use AuthManagerAwareTrait;

    /**
     * Checks whether a user has certain role.
     *
     * @param $userId
     * @param $role
     *
     * @return bool
     */
    public function hasRole($userId, $role)
    {
        if ($this->getAuthManager()) {
            $roles = array_keys($this->getAuthManager()->getRolesByUser($userId));

            return in_array($role, $roles, true);
        }

        return false;
    }

    /**
     * @param $username
     *
     * @return bool
     */
    public function isAdmin($username)
    {
        /** @var Module $module */
        $module = Yii::$app->getModule('user');
        $hasAdministratorPermissionName = $this->getAuthManager() && $module->administratorPermissionName
            ? Yii::$app->getUser()->can($module->administratorPermissionName)
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            : false;

        return $hasAdministratorPermissionName || in_array($username, $module->administrators, false);
    }

    /**
     * @param $name
     *
     * @return null|\yii\rbac\Item|Permission
     */
    public function getPermission($name)
    {
        return $this->getAuthManager()->getPermission($name);
    }

    /**
     * @param $name
     *
     * @return null|\yii\rbac\Item|Role
     */
    public function getRole($name)
    {
        return $this->getAuthManager()->getRole($name);
    }

    /**
     * Removes a role, permission or rule from the RBAC system.
     *
     * @param Role|Permission|Rule $object
     *
     * @return bool whether the role, permission or rule is successfully removed
     */
    public function remove($object)
    {
        return $this->getAuthManager()->remove($object);
    }

    /**
     * @param AbstractAuthItem $model
     *
     * @return array
     */
    public function getUnassignedItems(AbstractAuthItem $model)
    {
        $excludeItems = $model->item !== null ? [$model->item->name] : [];
        $type = $model->getType() === Permission::TYPE_PERMISSION ? Permission::TYPE_PERMISSION : null;
        $items = $this->getAuthManager()->getItems($type, $excludeItems);

        return ArrayHelper::map(
            $items,
            'name',
            function ($item) {
                return empty($item->description) ? $item->name : "{$item->name} ({$item->description})";
            }
        );
    }
}


1		<?php
2
3		/*
4		* This file is part of the 2amigos/yii2-usuario project.
5		*
6		* (c) 2amigOS! <http://2amigos.us/>
7		*
8		* For the full copyright and license information, please view
9		* the LICENSE file that was distributed with this source code.
10		*/
11
12		namespace Da\User\Helper;
13
14		use Da\User\Model\AbstractAuthItem;
15		use Da\User\Module;
16		use Da\User\Traits\AuthManagerAwareTrait;
17		use Yii;
18		use yii\helpers\ArrayHelper;
19		use yii\rbac\Permission;
20		use yii\rbac\Role;
21		use yii\rbac\Rule;
22
23		class AuthHelper
24		{
25		use AuthManagerAwareTrait;
26
27		/**
28		* Checks whether a user has certain role.
29		*
30		* @param $userId
31		* @param $role
32		*
33		* @return bool
34		*/
35		public function hasRole($userId, $role)
36		{
37		if ($this->getAuthManager()) {
38		$roles = array_keys($this->getAuthManager()->getRolesByUser($userId));
39
40		return in_array($role, $roles, true);
41		}
42
43		return false;
44		}
45
46		/**
47		* @param $username
48		*
49		* @return bool
50		*/
51	2	public function isAdmin($username)
52		{
53		/** @var Module $module */
54	2	$module = Yii::$app->getModule('user');
55	2	$hasAdministratorPermissionName = $this->getAuthManager() && $module->administratorPermissionName
56		? Yii::$app->getUser()->can($module->administratorPermissionName)
		0 ignored issues – show Bug introduced 2016-12-20 20:43 UTC by Report Bug Copy Issue Report The method `getUser` does only exist in `yii\web\Application`, but not in `yii\console\Application`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
57	2	: false;
58
59	2	return $hasAdministratorPermissionName \|\| in_array($username, $module->administrators, false);
60		}
61
62		/**
63		* @param $name
64		*
65		* @return null\|\yii\rbac\Item\|Permission
66		*/
67		public function getPermission($name)
68		{
69		return $this->getAuthManager()->getPermission($name);
70		}
71
72		/**
73		* @param $name
74		*
75		* @return null\|\yii\rbac\Item\|Role
76		*/
77		public function getRole($name)
78		{
79		return $this->getAuthManager()->getRole($name);
80		}
81
82		/**
83		* Removes a role, permission or rule from the RBAC system.
84		*
85		* @param Role\|Permission\|Rule $object
86		*
87		* @return bool whether the role, permission or rule is successfully removed
88		*/
89		public function remove($object)
90		{
91		return $this->getAuthManager()->remove($object);
92		}
93
94		/**
95		* @param AbstractAuthItem $model
96		*
97		* @return array
98		*/
99		public function getUnassignedItems(AbstractAuthItem $model)
100		{
101		$excludeItems = $model->item !== null ? [$model->item->name] : [];
102		$type = $model->getType() === Permission::TYPE_PERMISSION ? Permission::TYPE_PERMISSION : null;
103		$items = $this->getAuthManager()->getItems($type, $excludeItems);
104
105		return ArrayHelper::map(
106		$items,
107		'name',
108		function ($item) {
109		return empty($item->description) ? $item->name : "{$item->name} ({$item->description})";
110		}
111		);
112		}
113		}
114

2amigos / yii2-usuario

AuthHelper::getPermission() A last analyzed 2021-05-22 12:13 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

AuthHelper::getPermission() A
last analyzed 2021-05-22 12:13 UTC