User::getStatusName() - Code Metrics - Inspection of "refactoring" - Dominus77/yii2-advanced-start - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 4b0bfb...40d7bb )

by Alexey

created 2018-07-20 18:59 UTC

User::getStatusName() A

↳ Parent: User

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
c	0
b	0
f	0
rs	10
cc	1
eloc	1
nc	1
nop	0

<?php

namespace modules\users\models;

use Yii;
use yii\helpers\ArrayHelper;
use yii\helpers\Html;
use modules\users\models\query\UserQuery;
use modules\users\Module;

/**
 * Class User
 * @package modules\users\models
 *
 * @property array statusesArray Array statuses
 * @property string userFullName Full user name
 * @property int|string registrationType Type registered
 * @property int $registration_type Type Registration
 * @property string statusLabelName Status name in label
 * @property string statusName Status name
 */
class User extends IdentityUser
{
    const LENGTH_STRING_PASSWORD_MIN = 6;
    const LENGTH_STRING_PASSWORD_MAX = 16;

    const SCENARIO_ADMIN_CREATE = 'adminCreate';
    const SCENARIO_ADMIN_UPDATE = 'adminUpdate';
    const SCENARIO_ADMIN_PASSWORD_UPDATE = 'adminPasswordUpdate';
    const SCENARIO_PROFILE_UPDATE = 'profileUpdate';
    const SCENARIO_PASSWORD_UPDATE = 'passwordUpdate';
    const SCENARIO_PROFILE_DELETE = 'profileDelete';

    /**
     * @var string
     */
    public $currentPassword;

    /**
     * @var string
     */
    public $newPassword;

    /**
     * @var string
     */
    public $newPasswordRepeat;

    /**
     * @return array
     */
    public function rules()
    {
        return ArrayHelper::merge(parent::rules(), [
            ['status', 'integer'],
            ['status', 'default', 'value' => self::STATUS_WAIT],
            ['status', 'in', 'range' => array_keys(self::getStatusesArray())],

            [['newPassword', 'newPasswordRepeat'], 'required', 'on' => [self::SCENARIO_ADMIN_CREATE, self::SCENARIO_PASSWORD_UPDATE, self::SCENARIO_ADMIN_PASSWORD_UPDATE]],
            ['newPassword', 'string', 'min' => self::LENGTH_STRING_PASSWORD_MIN],
            ['newPasswordRepeat', 'compare', 'compareAttribute' => 'newPassword'],
            ['currentPassword', 'validateCurrentPassword', 'skipOnEmpty' => false, 'skipOnError' => false],
        ]);
    }

    /**
     * @return array
     */
    public function scenarios()
    {
        $scenarios = parent::scenarios();
        $scenarios[self::SCENARIO_ADMIN_CREATE] = ['avatar', 'username', 'email', 'status', 'newPassword', 'newPasswordRepeat', 'registration_type', 'first_name', 'last_name'];
        $scenarios[self::SCENARIO_ADMIN_UPDATE] = ['username', 'email', 'status', 'first_name', 'last_name', 'newPassword', 'newPasswordRepeat'];
        $scenarios[self::SCENARIO_ADMIN_PASSWORD_UPDATE] = ['newPassword', 'newPasswordRepeat'];
        $scenarios[self::SCENARIO_PASSWORD_UPDATE] = ['currentPassword', 'newPassword', 'newPasswordRepeat'];
        $scenarios[self::SCENARIO_PROFILE_UPDATE] = ['username', 'email', 'first_name', 'last_name'];
        $scenarios[self::SCENARIO_PROFILE_DELETE] = ['status'];
        $scenarios['default'] = ['username', 'email', 'first_name', 'last_name', 'password_hash', 'status', 'auth_key', 'email_confirm_token'];
        return $scenarios;
    }

    /**
     * @return array
     */
    public function attributeLabels()
    {
        return ArrayHelper::merge(parent::attributeLabels(), [
            'userRoleName' => Module::t('module', 'Role'),
            'currentPassword' => Module::t('module', 'Current Password'),
            'newPassword' => Module::t('module', 'New Password'),
            'newPasswordRepeat' => Module::t('module', 'Repeat Password'),
        ]);
    }

    /**
     * Type of registration
     * How the user is created
     * If the system registration type is registered by itself,
     * if it is created from the admin area,
     * then the login type that created the account
     *
     * @return mixed|string
     */
    public function getRegistrationType()
    {
        if ($this->registration_type > 0) {
            if (($model = User::findOne($this->registration_type)) !== null) {
                return $model->username;
            }
        }
        return $this->getRegistrationTypeName();
    }

    /**
     * Returns the registration type string
     * @return mixed
     */
    public function getRegistrationTypeName()
    {
        return ArrayHelper::getValue(self::getRegistrationTypesArray(), $this->registration_type);
    }

    /**
     * Returns an array of log types
     * @return array
     */
    public static function getRegistrationTypesArray()
    {
        return [
            self::TYPE_REGISTRATION_SYSTEM => Module::t('module', 'System'),
        ];
    }

    /**
     * @param string $attribute
     */
    public function validateCurrentPassword($attribute)
    {
        if (!empty($this->newPassword) && !empty($this->newPasswordRepeat) && !$this->hasErrors()) {
            $this->processValidatePassword($attribute);
        } else {
            $this->addError($attribute, Module::t('module', 'Not all fields are filled in correctly.'));
        }
    }

    /**
     * @param string $attribute
     */
    protected function processValidatePassword($attribute)
    {
        if ($attribute) {
            if (!$this->validatePassword($this->$attribute))
                $this->addError($attribute, Module::t('module', 'Incorrect current password.'));
        } else {
            $this->addError($attribute, Module::t('module', 'Enter your current password.'));
        }
    }

    /**
     * @return array
     */
    public static function getStatusesArray()
    {
        return [
            self::STATUS_BLOCKED => Module::t('module', 'Blocked'),
            self::STATUS_ACTIVE => Module::t('module', 'Active'),
            self::STATUS_WAIT => Module::t('module', 'Wait'),
            self::STATUS_DELETED => Module::t('module', 'Deleted'),
        ];
    }

    /**
     * Set Status
     * @return int|string
     */
    public function setStatus()
    {
        switch ($this->status) {
            case self::STATUS_ACTIVE:
                $this->status = self::STATUS_BLOCKED;
                break;
            case self::STATUS_DELETED:
                $this->status = self::STATUS_WAIT;
                break;
            default:
                $this->status = self::STATUS_ACTIVE;
        }
        return $this->status;
    }

    /**
     * @return string
     */
    public function getUserFullName()
    {
        $fullName = Module::t('module', 'Guest');
        if (!Yii::$app->user->isGuest) {
            $fullName = $this->first_name . ' ' . $this->last_name;
            $fullName = ($fullName != ' ') ? $fullName : $this->username;
        }
        return Html::encode(trim($fullName));
    }

    /**
     * @param integer|string $id
     * @return bool
     */
    public function isSuperAdmin($id = '')
    {
        $id = $id ? $id : $this->id;
        $authManager = Yii::$app->authManager;
        $roles = $authManager->getRolesByUser($id);
        foreach ($roles as $role) {
            if ($role->name == \modules\rbac\models\Role::ROLE_SUPER_ADMIN)
                return true;
        }
        return false;
    }

    /**
     * @return bool
     */
    public function isDeleted()
    {
        return $this->status === self::STATUS_DELETED;
    }

    /**
     * @return mixed
     */
    public function getStatusName()
    {
        return ArrayHelper::getValue(self::getStatusesArray(), $this->status);
    }

    /**
     * Return <span class="label label-success">Active</span>
     * @return string
     */
    public function getStatusLabelName()
    {
        $name = ArrayHelper::getValue(self::getLabelsArray(), $this->status);
        return Html::tag('span', $this->getStatusName(), ['class' => 'label label-' . $name]);
    }

    /**
     * @return array
     */
    public static function getLabelsArray()
    {
        return [
            self::STATUS_BLOCKED => 'default',
            self::STATUS_ACTIVE => 'success',
            self::STATUS_WAIT => 'warning',
            self::STATUS_DELETED => 'danger',
        ];
    }

    /**
     * @return object|\yii\db\ActiveQuery
     * @throws \yii\base\InvalidConfigException
     */
    public static function find()
    {
        return Yii::createObject(UserQuery::class, [get_called_class()]);
    }

    /**
     * Actions before saving
     *
     * @param bool $insert
     * @return bool
     */
    /**
     * Actions before saving
     *
     * @param bool $insert
     * @return bool
     * @throws \yii\base\Exception
     */
    public function beforeSave($insert)
    {
        if (parent::beforeSave($insert)) {
            if ($insert) {
                $this->generateAuthKey();
            }
            if (!empty($this->newPassword)) {
                $this->setPassword($this->newPassword);
            }
            return true;
        }
        return false;
    }

    /**
     * @return bool
     */
    public function beforeDelete()
    {
        if (!parent::beforeDelete()) {
            return false;
        }

        $authManager = Yii::$app->getAuthManager();
        if ($authManager->getRolesByUser($this->id)) {
            $authManager->revokeAll($this->id);
        }
        return true;
    }
}


1			<?php
2
3			namespace modules\users\models;
4
5			use Yii;
6			use yii\helpers\ArrayHelper;
7			use yii\helpers\Html;
8			use modules\users\models\query\UserQuery;
9			use modules\users\Module;
10
11			/**
12			* Class User
13			* @package modules\users\models
14			*
15			* @property array statusesArray Array statuses
16			* @property string userFullName Full user name
17			* @property int\|string registrationType Type registered
18			* @property int $registration_type Type Registration
19			* @property string statusLabelName Status name in label
20			* @property string statusName Status name
21			*/
22			class User extends IdentityUser
23			{
24			const LENGTH_STRING_PASSWORD_MIN = 6;
25			const LENGTH_STRING_PASSWORD_MAX = 16;
26
27			const SCENARIO_ADMIN_CREATE = 'adminCreate';
28			const SCENARIO_ADMIN_UPDATE = 'adminUpdate';
29			const SCENARIO_ADMIN_PASSWORD_UPDATE = 'adminPasswordUpdate';
30			const SCENARIO_PROFILE_UPDATE = 'profileUpdate';
31			const SCENARIO_PASSWORD_UPDATE = 'passwordUpdate';
32			const SCENARIO_PROFILE_DELETE = 'profileDelete';
33
34			/**
35			* @var string
36			*/
37			public $currentPassword;
38
39			/**
40			* @var string
41			*/
42			public $newPassword;
43
44			/**
45			* @var string
46			*/
47			public $newPasswordRepeat;
48
49			/**
50			* @return array
51			*/
52			public function rules()
53			{
54			return ArrayHelper::merge(parent::rules(), [
55			['status', 'integer'],
56			['status', 'default', 'value' => self::STATUS_WAIT],
57			['status', 'in', 'range' => array_keys(self::getStatusesArray())],
58
59			[['newPassword', 'newPasswordRepeat'], 'required', 'on' => [self::SCENARIO_ADMIN_CREATE, self::SCENARIO_PASSWORD_UPDATE, self::SCENARIO_ADMIN_PASSWORD_UPDATE]],
60			['newPassword', 'string', 'min' => self::LENGTH_STRING_PASSWORD_MIN],
61			['newPasswordRepeat', 'compare', 'compareAttribute' => 'newPassword'],
62			['currentPassword', 'validateCurrentPassword', 'skipOnEmpty' => false, 'skipOnError' => false],
63			]);
64			}
65
66			/**
67			* @return array
68			*/
69			public function scenarios()
70			{
71			$scenarios = parent::scenarios();
72			$scenarios[self::SCENARIO_ADMIN_CREATE] = ['avatar', 'username', 'email', 'status', 'newPassword', 'newPasswordRepeat', 'registration_type', 'first_name', 'last_name'];
73			$scenarios[self::SCENARIO_ADMIN_UPDATE] = ['username', 'email', 'status', 'first_name', 'last_name', 'newPassword', 'newPasswordRepeat'];
74			$scenarios[self::SCENARIO_ADMIN_PASSWORD_UPDATE] = ['newPassword', 'newPasswordRepeat'];
75			$scenarios[self::SCENARIO_PASSWORD_UPDATE] = ['currentPassword', 'newPassword', 'newPasswordRepeat'];
76			$scenarios[self::SCENARIO_PROFILE_UPDATE] = ['username', 'email', 'first_name', 'last_name'];
77			$scenarios[self::SCENARIO_PROFILE_DELETE] = ['status'];
78			$scenarios['default'] = ['username', 'email', 'first_name', 'last_name', 'password_hash', 'status', 'auth_key', 'email_confirm_token'];
79			return $scenarios;
80			}
81
82			/**
83			* @return array
84			*/
85			public function attributeLabels()
86			{
87			return ArrayHelper::merge(parent::attributeLabels(), [
88			'userRoleName' => Module::t('module', 'Role'),
89			'currentPassword' => Module::t('module', 'Current Password'),
90			'newPassword' => Module::t('module', 'New Password'),
91			'newPasswordRepeat' => Module::t('module', 'Repeat Password'),
92			]);
93			}
94
95			/**
96			* Type of registration
97			* How the user is created
98			* If the system registration type is registered by itself,
99			* if it is created from the admin area,
100			* then the login type that created the account
101			*
102			* @return mixed\|string
103			*/
104			public function getRegistrationType()
105			{
106			if ($this->registration_type > 0) {
107			if (($model = User::findOne($this->registration_type)) !== null) {
108			return $model->username;
109			}
110			}
111			return $this->getRegistrationTypeName();
112			}
113
114			/**
115			* Returns the registration type string
116			* @return mixed
117			*/
118			public function getRegistrationTypeName()
119			{
120			return ArrayHelper::getValue(self::getRegistrationTypesArray(), $this->registration_type);
121			}
122
123			/**
124			* Returns an array of log types
125			* @return array
126			*/
127			public static function getRegistrationTypesArray()
128			{
129			return [
130			self::TYPE_REGISTRATION_SYSTEM => Module::t('module', 'System'),
131			];
132			}
133
134			/**
135			* @param string $attribute
136			*/
137			public function validateCurrentPassword($attribute)
138			{
139			if (!empty($this->newPassword) && !empty($this->newPasswordRepeat) && !$this->hasErrors()) {
140			$this->processValidatePassword($attribute);
141			} else {
142			$this->addError($attribute, Module::t('module', 'Not all fields are filled in correctly.'));
143			}
144			}
145
146			/**
147			* @param string $attribute
148			*/
149			protected function processValidatePassword($attribute)
150			{
151			if ($attribute) {
152			if (!$this->validatePassword($this->$attribute))
153			$this->addError($attribute, Module::t('module', 'Incorrect current password.'));
154			} else {
155			$this->addError($attribute, Module::t('module', 'Enter your current password.'));
156			}
157			}
158
159			/**
160			* @return array
161			*/
162			public static function getStatusesArray()
163			{
164			return [
165			self::STATUS_BLOCKED => Module::t('module', 'Blocked'),
166			self::STATUS_ACTIVE => Module::t('module', 'Active'),
167			self::STATUS_WAIT => Module::t('module', 'Wait'),
168			self::STATUS_DELETED => Module::t('module', 'Deleted'),
169			];
170			}
171
172			/**
173			* Set Status
174			* @return int\|string
175			*/
176			public function setStatus()
177			{
178			switch ($this->status) {
179			case self::STATUS_ACTIVE:
180			$this->status = self::STATUS_BLOCKED;
181			break;
182			case self::STATUS_DELETED:
183			$this->status = self::STATUS_WAIT;
184			break;
185			default:
186			$this->status = self::STATUS_ACTIVE;
187			}
188			return $this->status;
189			}
190
191			/**
192			* @return string
193			*/
194			public function getUserFullName()
195			{
196			$fullName = Module::t('module', 'Guest');
197			if (!Yii::$app->user->isGuest) {
198			$fullName = $this->first_name . ' ' . $this->last_name;
199			$fullName = ($fullName != ' ') ? $fullName : $this->username;
200			}
201			return Html::encode(trim($fullName));
202			}
203
204			/**
205			* @param integer\|string $id
206			* @return bool
207			*/
208			public function isSuperAdmin($id = '')
209			{
210			$id = $id ? $id : $this->id;
211			$authManager = Yii::$app->authManager;
212			$roles = $authManager->getRolesByUser($id);
213			foreach ($roles as $role) {
214			if ($role->name == \modules\rbac\models\Role::ROLE_SUPER_ADMIN)
215			return true;
216			}
217			return false;
218			}
219
220			/**
221			* @return bool
222			*/
223			public function isDeleted()
224			{
225			return $this->status === self::STATUS_DELETED;
226			}
227
228			/**
229			* @return mixed
230			*/
231			public function getStatusName()
232			{
233			return ArrayHelper::getValue(self::getStatusesArray(), $this->status);
234			}
235
236			/**
237			* Return <span class="label label-success">Active</span>
238			* @return string
239			*/
240			public function getStatusLabelName()
241			{
242			$name = ArrayHelper::getValue(self::getLabelsArray(), $this->status);
243			return Html::tag('span', $this->getStatusName(), ['class' => 'label label-' . $name]);
244			}
245
246			/**
247			* @return array
248			*/
249			public static function getLabelsArray()
250			{
251			return [
252			self::STATUS_BLOCKED => 'default',
253			self::STATUS_ACTIVE => 'success',
254			self::STATUS_WAIT => 'warning',
255			self::STATUS_DELETED => 'danger',
256			];
257			}
258
259			/**
260			* @return object\|\yii\db\ActiveQuery
261			* @throws \yii\base\InvalidConfigException
262			*/
263			public static function find()
264			{
265			return Yii::createObject(UserQuery::class, [get_called_class()]);
266			}
267
268			/**
269			* Actions before saving
270			*
271			* @param bool $insert
272			* @return bool
273			*/
274			/**
275			* Actions before saving
276			*
277			* @param bool $insert
278			* @return bool
279			* @throws \yii\base\Exception
280			*/
281			public function beforeSave($insert)
282			{
283			if (parent::beforeSave($insert)) {
284			if ($insert) {
285			$this->generateAuthKey();
286			}
287			if (!empty($this->newPassword)) {
288			$this->setPassword($this->newPassword);
289			}
290			return true;
291			}
292			return false;
293			}
294
295			/**
296			* @return bool
297			*/
298			public function beforeDelete()
299			{
300			if (!parent::beforeDelete()) {
301			return false;
302			}
303
304			$authManager = Yii::$app->getAuthManager();
305			if ($authManager->getRolesByUser($this->id)) {
306			$authManager->revokeAll($this->id);
307			}
308			return true;
309			}
310			}
311

Dominus77 / yii2-advanced-start

Push — master ( 4b0bfb...40d7bb )

User::getStatusName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like