Da\User\Helper\AuthHelper

Complexity

Total Complexity

13

Size/Duplication

Total Lines	91
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

19.23%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	hasRole()	0	10	2
A	isAdmin()	0	10	4
A	getPermission()	0	4	1
A	getRole()	0	4	1
A	remove()	0	4	1
A	getUnassignedItems()	0	14	4

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

The method getUser does only exist in yii\web\Application, but not in yii\console\Application.

            : 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})";
            }
        );
    }
}