hipanel\rbac\SetterTrait

Complexity

Total Complexity

24

Size/Duplication

Total Lines	135
Duplicated Lines	0 %

Test Coverage

Coverage

73.08%

Importance

Changes	5
Bugs	1	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getAllItems()	0	3	1
A	findItem()	0	11	3
A	setAssignments()	0	7	3
A	setAssignment()	0	17	4
A	setChild()	0	21	6
A	getAllAssignments()	0	3	1
A	setRole()	0	9	3
A	setPermission()	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-2020, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\rbac;

use Exception;
use hiqdev\yii\compat\yii;
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) {
            $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) {
            $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);

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

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

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

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

    }

    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 Exception("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;
    }
}