Itstructure\RbacModule\models\ProfileValidate

Complexity

Total Complexity

21

Size/Duplication

Total Lines	205
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	attributes()	0	4	1
A	init()	0	4	2
A	setProfileModel()	0	3	1
A	save()	0	9	2
A	getProfileModel()	0	3	1
A	getUserName()	0	3	1
A	rules()	0	10	1
A	getRoles()	0	3	1
A	attributeLabels()	0	4	1
A	getAuthManager()	0	3	1
A	assignRoles()	0	16	4
A	setRoles()	0	3	1
A	setAuthManager()	0	3	1
A	validateRoles()	0	8	2
A	getId()	0	3	1

<?php

namespace Itstructure\RbacModule\models;

use yii\rbac\{ManagerInterface, Role as BaseRole};
use yii\base\{Model, InvalidConfigException};
use Itstructure\RbacModule\interfaces\{ModelInterface, RbacIdentityInterface};
use Itstructure\RbacModule\Module;

/**
 * Class for validation user(profile) roles.
 *
 * @property string $userUame
 * @property BaseRole[] $roles
 * @property RbacIdentityInterface $profileModel
 * @property ManagerInterface $authManager
 *
 * @package Itstructure\RbacModule\models
 */
class ProfileValidate extends Model implements ModelInterface
{
    /**
     * Current profile (user) model.
     *
     * @var RbacIdentityInterface
     */
    private $profileModel;

    /**
     * Auth manager.
     *
     * @var ManagerInterface
     */
    private $authManager;

    /**
     * Initialize.
     */
    public function init()
    {
        if (null === $this->authManager) {
            throw new InvalidConfigException('The authManager is not defined.');
        }
    }

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return [
            [
                'roles',
                'required',
            ],
            [
                'roles',
                'validateRoles',
            ],
        ];
    }

    /**
     * List if attributes.
     *
     * @return array
     */
    public function attributes()
    {
        return [
            'roles',
        ];
    }

    /**
     * List if attribute labels.
     *
     * @inheritdoc
     */
    public function attributeLabels()
    {
        return [
            'roles' => Module::t('roles', 'Roles'),
        ];
    }

    /**
     * Get user name.
     *
     * @return string
     */
    public function getUserName(): string
    {
        return $this->profileModel->getUserName();
    }

    /**
     * Set new roles values.
     *
     * @param mixed $roles
     */
    public function setRoles($roles)
    {
        $this->roles = $roles;
    }

    /**
     * List of profile assigned roles.
     *
     * @return string[]
     */
    public function getRoles()
    {
        return array_keys($this->profileModel->getRoles());
    }

    /**
     * Set profile (user) model.
     *
     * @param RbacIdentityInterface $model.
     *
     * @throws InvalidConfigException
     *
     * @return void
     */
    public function setProfileModel(RbacIdentityInterface $model): void
    {
        $this->profileModel = $model;
    }

    /**
     * Returns profile (user) model.
     *
     * @return RbacIdentityInterface
     */
    public function getProfileModel(): RbacIdentityInterface
    {
        return $this->profileModel;
    }

    /**
     * Set auth manager.
     *
     * @param ManagerInterface $authManager
     */
    public function setAuthManager(ManagerInterface $authManager)
    {
        $this->authManager = $authManager;
    }

    /**
     * Get auth manager.
     *
     * @return ManagerInterface
     */
    public function getAuthManager(): ManagerInterface
    {
        return $this->authManager;
    }

    /**
     * Validate roles data format.
     *
     * @param $attribute
     *
     * @return bool
     */
    public function validateRoles($attribute): bool
    {
        if (!is_array($this->roles)) {

The condition is_array($this->roles) is always true.

            $this->addError($attribute, 'Incorrect roles data format.');
            return false;
        }

        return true;
    }

    /**
     * Save user data.
     *
     * @return bool
     */
    public function save(): bool
    {
        if (!$this->validate()) {
            return false;
        }

        $this->assignRoles();

        return true;
    }

    /**
     * Returns current model id.
     *
     * @return int
     */
    public function getId(): int
    {
        return $this->profileModel->getId();

The expression return $this->profileModel->getId() could return the type string which is incompatible with the type-hinted return integer. Consider adding an additional type-check to rule them out.

    }

    /**
     * Assign roles.
     *
     * @return void
     */
    private function assignRoles(): void
    {
        if (!$this->profileModel->getIsNewRecord()) {
            $this->authManager->revokeAll(
                $this->profileModel->getId()
            );
        }

        foreach ($this->roles as $role) {
            $roleObject = $this->authManager->getRole($role);

$role of type yii\rbac\Role is incompatible with the type string expected by parameter $name of yii\rbac\ManagerInterface::getRole().

            if (null === $roleObject){
                continue;
            }

            $this->authManager->assign($roleObject, $this->profileModel->getId());
        }
    }
}