hipanel\rbac\SetterTrait

Complexity

Total Complexity

24

Size/Duplication

Total Lines	136
Duplicated Lines	10.29 %

Coupling/Cohesion

Components	2
Dependencies	2

Test Coverage

Coverage

71.19%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	findItem()	0	12	3
A	getAllAssignments()	0	4	1
A	getAllItems()	0	4	1
A	setPermission()	0	10	3
A	setRole()	0	10	3
B	setChild()	14	22	6
A	setAssignment()	0	17	4
A	setAssignments()	0	9	3

<?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 <sol@hiqdev.com>
 */
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);

It seems like getPermission() must be provided by classes using this trait. How about adding it as abstract method to this trait?

It seems like createPermission() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        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.

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

It seems like add() must be provided by classes using this trait. How about adding it as abstract method to this trait?

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

It seems like getRole() must be provided by classes using this trait. How about adding it as abstract method to this trait?

It seems like createRole() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        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.

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

It seems like add() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $role;
    }

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

It seems like getItem() must be provided by classes using this trait. How about adding it as abstract method to this trait?

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

It seems like getItem() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            if (is_null($child)) {
                throw new InvalidParamException("Unknown child:$name at setChild");
            }
        }
        if (isset($this->children[$parent->name][$child->name])) {

The property children does not exist. Did you maybe forget to declare it?

            return false;
        }

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

It seems like addChild() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * 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];

The property assignments does not exist. Did you maybe forget to declare it?

        }

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

The method assign() does not exist on hipanel\rbac\SetterTrait. Did you maybe mean setAssignment()?

    }

    protected function findItem($name, $description = null)
    {
        $item = $this->getItem($name);

It seems like getItem() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        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;

The property items does not exist. Did you maybe forget to declare it?

    }
}