modules\rbac\models\Permission

Complexity

Total Complexity

21

Size/Duplication

Total Lines	256
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	1

13 Methods

Rating	Name	Duplication	Size	Complexity
A	groupAdmin()	0	9	1
A	groupManager()	0	5	1
A	groupSuperAdmin()	0	11	1
A	getGroups()	0	7	1
A	groupEditor()	0	5	1
A	processCheckPermissionName()	0	9	3
A	attributeLabels()	0	9	1
A	scenarios()	0	6	1
A	getPermissionChildren()	0	11	3
A	rules()	0	26	1
A	validateUniqueName()	0	8	3
A	getItemsPermissions()	0	12	3
A	permissionsArray()	0	12	1

<?php

namespace modules\rbac\models;

use Yii;
use yii\base\Model;
use modules\rbac\Module;

/**
 * Class Permission
 * @package modules\rbac\models
 *
 * @property-read array $itemsPermissions
 * @property-read array $permissionChildren
 */
class Permission extends Model
{
    // разрешения
    const PERMISSION_MANAGER_MAINTENANCE = 'managerMaintenance';
    const PERMISSION_MANAGER_MAINTENANCE_DESCRIPTION = 'Access to Maintenance management';

    const PERMISSION_MAINTENANCE = 'maintenanceView';
    const PERMISSION_MAINTENANCE_DESCRIPTION = 'View a site in maintenance mode';

    const PERMISSION_VIEW_ADMIN_PAGE = 'viewAdminPage';
    const PERMISSION_VIEW_ADMIN_PAGE_DESCRIPTION = 'Access to the admin area';

    const PERMISSION_MANAGER_CONFIG = 'managerConfig';
    const PERMISSION_MANAGER_CONFIG_DESCRIPTION = 'Access to the config site';

    const PERMISSION_MANAGER_RBAC = 'managerRbac';
    const PERMISSION_MANAGER_RBAC_DESCRIPTION = 'Access to RBAC management';

    const PERMISSION_MANAGER_USERS = 'managerUsers';
    const PERMISSION_MANAGER_USERS_DESCRIPTION = 'Access to Users management';

    const PERMISSION_MANAGER_POST = 'managerPosts';
    const PERMISSION_MANAGER_POST_DESCRIPTION = 'Access to Posts management';

    const PERMISSION_MANAGER_COMMENTS = 'managerComments';
    const PERMISSION_MANAGER_COMMENTS_DESCRIPTION = 'Access to Comments management';

    // редактирование только своих постов
    const PERMISSION_UPDATE_OWN_POST = 'updateOwnPost';
    const PERMISSION_UPDATE_OWN_POST_DESCRIPTION = 'Editing your own post';

    // сценарии
    const SCENARIO_CREATE = 'create';
    const SCENARIO_UPDATE = 'update';

    public $name;
    public $description;
    public $isNewRecord = false;

    /** @var  array $permissions Установленные разрешения для роли */
    public $permissions;
    /** @var array $permissionItems Разрешения */
    public $permissionItems;


    /**
     * @return string[]
     */
    public static function permissionsArray()
    {
        return [
            self::PERMISSION_MANAGER_MAINTENANCE => self::PERMISSION_MANAGER_MAINTENANCE_DESCRIPTION,
            self::PERMISSION_MAINTENANCE => self::PERMISSION_MAINTENANCE_DESCRIPTION,
            self::PERMISSION_VIEW_ADMIN_PAGE => self::PERMISSION_VIEW_ADMIN_PAGE_DESCRIPTION,
            self::PERMISSION_MANAGER_CONFIG => self::PERMISSION_MANAGER_CONFIG_DESCRIPTION,
            self::PERMISSION_MANAGER_RBAC => self::PERMISSION_MANAGER_RBAC_DESCRIPTION,
            self::PERMISSION_MANAGER_USERS => self::PERMISSION_MANAGER_USERS_DESCRIPTION,
            self::PERMISSION_MANAGER_POST => self::PERMISSION_MANAGER_POST_DESCRIPTION,
            self::PERMISSION_MANAGER_COMMENTS => self::PERMISSION_MANAGER_COMMENTS_DESCRIPTION,
            self::PERMISSION_UPDATE_OWN_POST => self::PERMISSION_UPDATE_OWN_POST_DESCRIPTION
        ];
    }

    /**
     * Groups permissions
     * @return array
     */
    public static function getGroups()
    {
        return [
            Role::ROLE_SUPER_ADMIN => self::groupSuperAdmin(),
            Role::ROLE_ADMIN => self::groupAdmin(),
            Role::ROLE_MANAGER => self::groupManager(),
            Role::ROLE_EDITOR => self::groupEditor()
        ];
    }

    /**
     * Group permissions to role super_admin
     * @return array
     */
    public static function groupSuperAdmin()
    {
        return [
            self::PERMISSION_MANAGER_MAINTENANCE,
            self::PERMISSION_MAINTENANCE,
            self::PERMISSION_VIEW_ADMIN_PAGE,
            self::PERMISSION_MANAGER_CONFIG,
            self::PERMISSION_MANAGER_POST,
            self::PERMISSION_MANAGER_COMMENTS,
            self::PERMISSION_MANAGER_USERS,
            self::PERMISSION_MANAGER_RBAC
        ];
    }

    /**
     * Group permissions to role admin
     * @return array
     */
    public static function groupAdmin()
    {
        return [
            self::PERMISSION_MANAGER_MAINTENANCE,
            self::PERMISSION_MAINTENANCE,
            self::PERMISSION_VIEW_ADMIN_PAGE,
            self::PERMISSION_MANAGER_POST,
            self::PERMISSION_MANAGER_COMMENTS,
            self::PERMISSION_MANAGER_USERS
        ];
    }

    /**
     * Group permissions to role manager
     * @return array
     */
    public static function groupManager()
    {
        return [
            self::PERMISSION_VIEW_ADMIN_PAGE,
            self::PERMISSION_MANAGER_POST
        ];
    }

    /**
     * Group permissions to role editor
     * @return array
     */
    public static function groupEditor()
    {
        return [
            self::PERMISSION_VIEW_ADMIN_PAGE,
            self::PERMISSION_UPDATE_OWN_POST
        ];
    }

    /**
     * @inheritdoc
     * @return array
     */
    public function rules()
    {
        return [
            ['name', 'required', 'on' => self::SCENARIO_CREATE],
            ['name', 'string', 'max' => 64, 'on' => self::SCENARIO_CREATE],
            [
                'name',
                'match',
                'pattern' => '#^[\w_-]+$#i',
                'message' => Module::translate(
                    'module',
                    'It is allowed to use the Latin alphabet, numbers, dashes and underscores.(A-z,0-1,-,_)'
                ),
                'on' => self::SCENARIO_CREATE
            ],
            [
                'name',
                'validateUniqueName',
                'skipOnEmpty' => false,
                'skipOnError' => false,
                'on' => [self::SCENARIO_CREATE
                ]
            ],

            [['description'], 'string'],
            [['permissionItems', 'permissions'], 'required', 'on' => self::SCENARIO_UPDATE]
        ];
    }

    /**
     * @param string $attribute
     */
    public function validateUniqueName($attribute)
    {
        if (!$attribute) {
            $this->addError($attribute, Module::translate('module', 'Enter name permission.'));
        }

        if (!$this->hasErrors()) {
            $this->processCheckPermissionName($attribute);
        }
    }

    /**
     * @param string $attribute
     * @return mixed
     */
    public function processCheckPermissionName($attribute)
    {
        if (!empty($this->name)) {
            $auth = Yii::$app->authManager;
            if ($auth->getPermission($this->name)) {
                $this->addError($attribute, Module::translate('module', 'This name is already taken.'));
            }
        }
        return $attribute;
    }

    /**
     * @return array
     */
    public function scenarios()
    {
        $scenarios = parent::scenarios();
        $scenarios[self::SCENARIO_CREATE] = ['name', 'description'];
        $scenarios[self::SCENARIO_UPDATE] = ['name', 'description', 'permissionItems', 'permissions'];
        return $scenarios;
    }

    /**
     * @return array
     */
    public function attributeLabels()
    {
        return [
            'name' => Module::translate('module', 'Name'),
            'description' => Module::translate('module', 'Description'),
            'rolesByPermission' => Module::translate('module', 'Roles with permissions'),
            'itemsRoles' => Module::translate('module', 'Items roles'),
            'permissions' => Module::translate('module', 'Permissions by role'),
            'permissionItems' => Module::translate('module', 'Items permissions')
        ];
    }

    /**
     * Возвращает детей разрешения для текущего разрешения
     * @return array
     */
    public function getPermissionChildren()
    {
        $auth = Yii::$app->authManager;
        $perm = $auth->getChildren($this->name);
        $arr = [];
        foreach ($perm as $value) {
            if ($value->name !== $this->name) {
                $arr[$value->name] = $value->name . ' (' . $value->description . ')';
            }
        }
        return $arr;
    }

    /**
     * Возвращает все разрешения
     * @return array
     */
    public function getItemsPermissions()
    {
        $auth = Yii::$app->authManager;
        $perm = $auth->getPermissions();
        $arr = [];
        foreach ($perm as $value) {
            if ($value->name !== $this->name) {
                $arr[$value->name] = $value->name . ' (' . $value->description . ')';
            }
        }
        $permChild = $this->getPermissionChildren();
        return array_diff($arr, $permChild);
    }
}