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

Passed

Push — master ( dc82e8...df98a8 )

by Alexey

created 2018-01-26 22:51 UTC

User::attributeLabels() A

↳ Parent: User

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	7
rs	9.4285
cc	1
eloc	5
nc	1
nop	0

<?php

namespace modules\users\models;

use Yii;
use yii\helpers\ArrayHelper;
use yii\helpers\Html;
use modules\users\traits\ModuleTrait;
use modules\users\Module;

/**
 * Class User
 * @package modules\users\models
 *
 * @property array statusesArray Array statuses
 * @property string userFullName Full user name
 */
class User extends BaseUser
{
    use ModuleTrait;

    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],
        ]);
    }

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

    /**
     * @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'];
        $scenarios[self::SCENARIO_ADMIN_PASSWORD_UPDATE] = ['newPassword', 'newPasswordRepeat'];
        $scenarios[self::SCENARIO_PASSWORD_UPDATE] = ['currentPassword', 'newPassword', 'newPasswordRepeat'];
        $scenarios[self::SCENARIO_PROFILE_UPDATE] = ['email', 'first_name', 'last_name'];
        $scenarios[self::SCENARIO_PROFILE_DELETE] = ['status'];
        $scenarios['default'] = ['username', 'email', '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'),
        ]);
    }

    /**
     * Actions before saving
     *
     * @param bool $insert
     * @return bool
     */
    public function beforeSave($insert)
    {
        if (parent::beforeSave($insert)) {
            if (!empty($this->newPassword)) {
                $this->setPassword($this->newPassword);
                Yii::$app->session->setFlash('success', Module::t('module', 'Password changed successfully.'));
            }
            return true;
        }
        return false;
    }

    /**
     * @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 != ' ') ? trim($fullName) : $this->username;
        }
        return Html::encode($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',
        ];
    }
}


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\traits\ModuleTrait;
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			*/
18			class User extends BaseUser
19			{
20			use ModuleTrait;
21
22			const LENGTH_STRING_PASSWORD_MIN = 6;
23			const LENGTH_STRING_PASSWORD_MAX = 16;
24
25			const SCENARIO_ADMIN_CREATE = 'adminCreate';
26			const SCENARIO_ADMIN_UPDATE = 'adminUpdate';
27			const SCENARIO_ADMIN_PASSWORD_UPDATE = 'adminPasswordUpdate';
28			const SCENARIO_PROFILE_UPDATE = 'profileUpdate';
29			const SCENARIO_PASSWORD_UPDATE = 'passwordUpdate';
30			const SCENARIO_PROFILE_DELETE = 'profileDelete';
31
32			/**
33			* @var string
34			*/
35			public $currentPassword;
36
37			/**
38			* @var string
39			*/
40			public $newPassword;
41
42			/**
43			* @var string
44			*/
45			public $newPasswordRepeat;
46
47			/**
48			* @return array
49			*/
50			public function rules()
51			{
52			return ArrayHelper::merge(parent::rules(), [
53			['status', 'integer'],
54			['status', 'default', 'value' => self::STATUS_WAIT],
55			['status', 'in', 'range' => array_keys(self::getStatusesArray())],
56
57			[['newPassword', 'newPasswordRepeat'], 'required', 'on' => [self::SCENARIO_ADMIN_CREATE, self::SCENARIO_PASSWORD_UPDATE, self::SCENARIO_ADMIN_PASSWORD_UPDATE]],
58			['newPassword', 'string', 'min' => self::LENGTH_STRING_PASSWORD_MIN],
59			['newPasswordRepeat', 'compare', 'compareAttribute' => 'newPassword'],
60			['currentPassword', 'validateCurrentPassword', 'skipOnEmpty' => false, 'skipOnError' => false],
61			]);
62			}
63
64			/**
65			* @param string $attribute
66			*/
67			public function validateCurrentPassword($attribute)
68			{
69			if (!empty($this->newPassword) && !empty($this->newPasswordRepeat) && !$this->hasErrors()) {
70			if ($attribute) {
71			if (!$this->validatePassword($this->$attribute))
72			$this->addError($attribute, Module::t('module', 'Incorrect current password.'));
73			} else {
74			$this->addError($attribute, Module::t('module', 'Enter your current password.'));
75			}
76			} else {
77			$this->addError($attribute, Module::t('module', 'Not all fields are filled in correctly.'));
78			}
79			}
80
81			/**
82			* @return array
83			*/
84			public function scenarios()
85			{
86			$scenarios = parent::scenarios();
87			$scenarios[self::SCENARIO_ADMIN_CREATE] = ['avatar', 'username', 'email', 'status', 'newPassword', 'newPasswordRepeat', 'registration_type', 'first_name', 'last_name'];
88			$scenarios[self::SCENARIO_ADMIN_UPDATE] = ['username', 'email', 'status', 'first_name', 'last_name'];
89			$scenarios[self::SCENARIO_ADMIN_PASSWORD_UPDATE] = ['newPassword', 'newPasswordRepeat'];
90			$scenarios[self::SCENARIO_PASSWORD_UPDATE] = ['currentPassword', 'newPassword', 'newPasswordRepeat'];
91			$scenarios[self::SCENARIO_PROFILE_UPDATE] = ['email', 'first_name', 'last_name'];
92			$scenarios[self::SCENARIO_PROFILE_DELETE] = ['status'];
93			$scenarios['default'] = ['username', 'email', 'password_hash', 'status', 'auth_key', 'email_confirm_token'];
94			return $scenarios;
95			}
96
97			/**
98			* @return array
99			*/
100			public function attributeLabels()
101			{
102			return ArrayHelper::merge(parent::attributeLabels(), [
103			'userRoleName' => Module::t('module', 'Role'),
104			'currentPassword' => Module::t('module', 'Current Password'),
105			'newPassword' => Module::t('module', 'New Password'),
106			'newPasswordRepeat' => Module::t('module', 'Repeat Password'),
107			]);
108			}
109
110			/**
111			* Actions before saving
112			*
113			* @param bool $insert
114			* @return bool
115			*/
116			public function beforeSave($insert)
117			{
118			if (parent::beforeSave($insert)) {
119			if (!empty($this->newPassword)) {
120			$this->setPassword($this->newPassword);
121			Yii::$app->session->setFlash('success', Module::t('module', 'Password changed successfully.'));
122			}
123			return true;
124			}
125			return false;
126			}
127
128			/**
129			* @return array
130			*/
131			public static function getStatusesArray()
132			{
133			return [
134			self::STATUS_BLOCKED => Module::t('module', 'Blocked'),
135			self::STATUS_ACTIVE => Module::t('module', 'Active'),
136			self::STATUS_WAIT => Module::t('module', 'Wait'),
137			self::STATUS_DELETED => Module::t('module', 'Deleted'),
138			];
139			}
140
141			/**
142			* Set Status
143			* @return int\|string
144			*/
145			public function setStatus()
146			{
147			switch ($this->status) {
148			case self::STATUS_ACTIVE:
149			$this->status = self::STATUS_BLOCKED;
150			break;
151			case self::STATUS_DELETED:
152			$this->status = self::STATUS_WAIT;
153			break;
154			default:
155			$this->status = self::STATUS_ACTIVE;
156			}
157			return $this->status;
158			}
159
160			/**
161			* @return string
162			*/
163			public function getUserFullName()
164			{
165			$fullName = Module::t('module', 'Guest');
166			if (!Yii::$app->user->isGuest) {
167			$fullName = $this->first_name . ' ' . $this->last_name;
168			$fullName = ($fullName != ' ') ? trim($fullName) : $this->username;
169			}
170			return Html::encode($fullName);
171			}
172
173			/**
174			* @param integer\|string $id
175			* @return bool
176			*/
177			public
178			function isSuperAdmin($id = '')
179			{
180			$id = $id ? $id : $this->id;
181			$authManager = Yii::$app->authManager;
182			$roles = $authManager->getRolesByUser($id);
183			foreach ($roles as $role) {
184			if ($role->name == \modules\rbac\models\Role::ROLE_SUPER_ADMIN)
185			return true;
186			}
187			return false;
188			}
189
190			/**
191			* @return bool
192			*/
193			public
194			function isDeleted()
195			{
196			return $this->status === self::STATUS_DELETED;
197			}
198
199			/**
200			* @return mixed
201			*/
202			public
203			function getStatusName()
204			{
205			return ArrayHelper::getValue(self::getStatusesArray(), $this->status);
206			}
207
208			/**
209			* Return <span class="label label-success">Active</span>
210			* @return string
211			*/
212			public
213			function getStatusLabelName()
214			{
215			$name = ArrayHelper::getValue(self::getLabelsArray(), $this->status);
216			return Html::tag('span', $this->getStatusName(), ['class' => 'label label-' . $name]);
217			}
218
219			/**
220			* @return array
221			*/
222			public
223			static function getLabelsArray()
224			{
225			return [
226			self::STATUS_BLOCKED => 'default',
227			self::STATUS_ACTIVE => 'success',
228			self::STATUS_WAIT => 'warning',
229			self::STATUS_DELETED => 'danger',
230			];
231			}
232			}
233

Dominus77 / yii2-advanced-start

Push — master ( dc82e8...df98a8 )

User::attributeLabels() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like