hipanel\rbac\AuthManager

Complexity

Total Complexity

30

Size/Duplication

Total Lines	175
Duplicated Lines	12 %

Coupling/Cohesion

Components	2
Dependencies	4

Test Coverage

Coverage

77.14%

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	setPermission()	0	4	1
A	setRole()	0	4	1
A	setItem()	0	10	3
A	createItem()	0	10	3
B	setChild()	14	22	6
A	setAssignment()	7	15	4
A	getRoles()	0	4	1
A	getPermissions()	0	4	1
A	getAllAssignments()	0	4	1
A	saveAssignments()	0	3	1
A	saveBasicAssignments()	0	4	1
A	checkAccess()	0	9	2
A	setCurrentUserRole()	0	9	4
A	getIdentity()	0	4	1

<?php

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

namespace hipanel\rbac;

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

/**
 * HiPanel AuthManager.
 *
 * @author Andrii Vasyliev <sol@hiqdev.com>
 */
class AuthManager extends \yii\rbac\PhpManager
{
    public $itemFile       = '@hipanel/rbac/files/items.php';
    public $ruleFile       = '@hipanel/rbac/files/rules.php';
    public $assignmentFile = '@hipanel/rbac/files/assignments.php';

    /**
     * Set permission.
     * @param string $name
     * @param string $description
     * @return Item
     */
    public function setPermission($name, $description = null)
    {
        return $this->setItem('permission', $name, $description);
    }

    /**
     * Set role.
     * @param string $name
     * @param string $description
     * @return Item
     */
    public function setRole($name, $description = null)
    {
        return $this->setItem('role', $name, $description);
    }

    /**
     * Set item by type and name.
     * Created if not exists else updates.
     * @param string $type
     * @param string $name
     * @param string $description
     * @return Item
     */
    public function setItem($type, $name, $description = null)
    {
        $item = $this->getItem($name) ?: $this->createItem($type, $name);
        if ($description) {

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.

            $item->description = $description;
        }
        $this->add($item);

$item is of type object<yii\rbac\Item>, but the function expects a object<yii\rbac\Role>|object<yii\rbac\Permission>|object<yii\rbac\Rule>.

        return $item;
    }

    /**
     * Create item by type and name.
     * @param string $type
     * @param string $name
     * @throws InvalidParamException
     * @return Item
     */
    public function createItem($type, $name)
    {
        if ('role' === $type) {
            return $this->createRole($name);
        } elseif ('permission' === $type) {
            return $this->createPermission($name);
        } else {
            throw new InvalidParamException('Creating unsupported item type: ' . $type);
        }
    }

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

This code seems to be duplicated across your project.

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

This code seems to be duplicated across your project.

            $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])) {
            return false;
        }

        return $this->addChild($parent, $child);
    }

    /**
     * Assigns a role to a user.
     * @param Role $role
     * @param string|integer $userId the user ID (see [[\yii\web\User::id]])
     * @throws \Exception when given wrong role name or the role has already been assigned to the user
     * @return Assignment the role assignment information
     */
    public function setAssignment($role, $userId)
    {
        if (is_string($role)) {

This code seems to be duplicated across your project.

            $name = $role;
            $role = $this->getRole($role);
            if (is_null($role)) {
                throw new InvalidParamException("Unknown role:$name at setAssignment");
            }
        }
        if (isset($this->assignments[$userId][$role->name])) {
            return false;
        }

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

It seems like $role defined by $this->getRole($role) on line 128 can also be of type object<yii\rbac\Item>; however, yii\rbac\PhpManager::assign() does only seem to accept object<yii\rbac\Role>, maybe add an additional type check?

    }

    public function getRoles()
    {
        return $this->getItems(Item::TYPE_ROLE);
    }

    public function getPermissions()
    {
        return $this->getItems(Item::TYPE_PERMISSION);
    }

    public function getAllAssignments()
    {
        return $this->assignments;
    }

    /**
     * We don't keep all the assignments, only basic.
     * @see forceSaveAssignments
     */
    protected function saveAssignments()
    {
    }

    /**
     * Create only basic assignments before saving.
     */
    public function saveBasicAssignments()
    {
        parent::saveAssignments();

It seems like you call parent on a different method (saveAssignments() instead of saveBasicAssignments()). Are you sure this is correct? If so, you might want to change this to $this->saveAssignments().

    }

    public function checkAccess($userId, $permission, $params = [])
    {
        $this->setCurrentUserRole();
        if ($userId === $this->getIdentity()->id) {
            $userId = $this->getIdentity()->username;
        }

        return parent::checkAccess($userId, $permission, $params);
    }

    protected $_currentUserRole;

    public function setCurrentUserRole()
    {
        if ($this->_currentUserRole === null) {
            $this->_currentUserRole = $this->getIdentity()->type ?: '';
            if ($this->_currentUserRole) {
                $this->setAssignment($this->_currentUserRole, $this->getIdentity()->username);
            }
        }
    }

    public function getIdentity()
    {
        return Yii::$app->user->identity;
    }
}