ProfileValidate::save() - Code Metrics - Inspection of "Created classes to assign roles for profiles" - itstructure/yii2-rbac-module - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — dev (794b40)

by Andrey

created 2018-08-01 08:08 UTC

ProfileValidate::save() A

↳ Parent: ProfileValidate

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.9332
c	0
b	0
f	0
cc	2
nc	2
nop	0

<?php

namespace Itstructure\RbacModule\models;

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

/**
 * Class for validation user(profile) roles.
 *
 * @property string $userUame
 * @property BaseRole[] $roles
 * @property RbacIdentityInterface $profileModel
 * @property ManagerInterface $authManager
 *
 * @package Itstructure\UsersModule\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' => '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.
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @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)){
            $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();
    }

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

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

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


1			<?php
2
3			namespace Itstructure\RbacModule\models;
4
5			use yii\rbac\{ManagerInterface, Role as BaseRole};
6			use yii\base\{Model, InvalidConfigException};
7			use Itstructure\RbacModule\interfaces\{ModelInterface, RbacIdentityInterface};
8
9			/**
10			* Class for validation user(profile) roles.
11			*
12			* @property string $userUame
13			* @property BaseRole[] $roles
14			* @property RbacIdentityInterface $profileModel
15			* @property ManagerInterface $authManager
16			*
17			* @package Itstructure\UsersModule\models
18			*/
19			class ProfileValidate extends Model implements ModelInterface
20			{
21			/**
22			* Current profile (user) model.
23			*
24			* @var RbacIdentityInterface
25			*/
26			private $profileModel;
27
28			/**
29			* Auth manager.
30			*
31			* @var ManagerInterface
32			*/
33			private $authManager;
34
35			/**
36			* Initialize.
37			*/
38			public function init()
39			{
40			if (null === $this->authManager){
41			throw new InvalidConfigException('The authManager is not defined.');
42			}
43			}
44
45			/**
46			* @inheritdoc
47			*/
48			public function rules()
49			{
50			return [
51			[
52			'roles',
53			'required',
54			],
55			[
56			'roles',
57			'validateRoles',
58			],
59			];
60			}
61
62			/**
63			* List if attributes.
64			*
65			* @return array
66			*/
67			public function attributes()
68			{
69			return [
70			'roles',
71			];
72			}
73
74			/**
75			* List if attribute labels.
76			*
77			* @inheritdoc
78			*/
79			public function attributeLabels()
80			{
81			return [
82			'roles' => 'Roles',
83			];
84			}
85
86			/**
87			* Get user name.
88			*
89			* @return string
90			*/
91			public function getUserName(): string
92			{
93			return $this->profileModel->getUserName();
94			}
95
96			/**
97			* Set new roles values.
98			*
99			* @param mixed $roles
100			*/
101			public function setRoles($roles)
102			{
103			$this->roles = $roles;
104			}
105
106			/**
107			* List of profile assigned roles.
108			*
109			* @return string[]
110			*/
111			public function getRoles()
112			{
113			return array_keys($this->profileModel->getRoles());
114			}
115
116			/**
117			* Set profile (user) model.
118			*
119			* @param RbacIdentityInterface $model.
			0 ignored issues – show Documentation introduced 2018-08-01 08:12 UTC by Report Bug Copy Issue Report There is no parameter named `$model.`. Did you maybe mean `$model`? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit. Consider the following example. The parameter `$ireland` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $ireland */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was changed, but the annotation was not. Loading history...
120			*
121			* @throws InvalidConfigException
122			*
123			* @return void
124			*/
125			public function setProfileModel(RbacIdentityInterface $model): void
126			{
127			$this->profileModel = $model;
			0 ignored issues – show Documentation Bug introduced 2018-08-01 08:12 UTC by Report Bug Copy Issue Report It seems like `$model` of type `object<Itstructure\RbacM...\RbacIdentityInterface>` is incompatible with the declared type `object<RbacIdentityInterface>` of property `$profileModel`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
128			}
129
130			/**
131			* Returns profile (user) model.
132			*
133			* @return RbacIdentityInterface
134			*/
135			public function getProfileModel(): RbacIdentityInterface
136			{
137			return $this->profileModel;
138			}
139
140			/**
141			* Set auth manager.
142			*
143			* @param ManagerInterface $authManager
144			*/
145			public function setAuthManager(ManagerInterface $authManager)
146			{
147			$this->authManager = $authManager;
			0 ignored issues – show Documentation Bug introduced 2018-05-12 19:09 UTC by Report Bug Copy Issue Report It seems like `$authManager` of type `object<yii\rbac\ManagerInterface>` is incompatible with the declared type `object<ManagerInterface>` of property `$authManager`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
148			}
149
150			/**
151			* Get auth manager.
152			*
153			* @return ManagerInterface
154			*/
155			public function getAuthManager(): ManagerInterface
156			{
157			return $this->authManager;
158			}
159
160			/**
161			* Validate roles data format.
162			*
163			* @param $attribute
164			*
165			* @return bool
166			*/
167			public function validateRoles($attribute): bool
168			{
169			if (!is_array($this->roles)){
170			$this->addError($attribute, 'Incorrect roles data format.');
171			return false;
172			}
173
174			return true;
175			}
176
177			/**
178			* Save user data.
179			*
180			* @return bool
181			*/
182			public function save(): bool
183			{
184			if (!$this->validate()){
185			return false;
186			}
187
188			$this->assignRoles();
189
190			return true;
191			}
192
193			/**
194			* Returns current model id.
195			*
196			* @return int
197			*/
198			public function getId(): int
199			{
200			return $this->profileModel->getId();
201			}
202
203			/**
204			* Assign roles.
205			*
206			* @return void
207			*/
208			private function assignRoles(): void
209			{
210			if (!$this->profileModel->getIsNewRecord()){
211			$this->authManager->revokeAll(
212			$this->profileModel->getId()
213			);
214			}
215
216			foreach ($this->roles as $role){
217			$roleObject = $this->authManager->getRole($role);
218
219			if (null === $roleObject){
220			continue;
221			}
222
223			$this->authManager->assign($roleObject, $this->profileModel->getId());
224			}
225			}
226			}
227

itstructure / yii2-rbac-module

Branch — dev (794b40)

ProfileValidate::save() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like