User::findIdentityByAccessToken() - Code Metrics - Inspection of "Merge pull request #13 from MaksSlesarenko/patch-1" - nixsolutions/yii2-starter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 639696...9f112c )

by Anton

created 2017-10-25 08:40 UTC

User::findIdentityByAccessToken() A

↳ Parent: User

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
ccs	0
cts	2
cp	0
rs	10
cc	1
eloc	2
nc	1
nop	2
crap	2

<?php

namespace app\modules\user\models;

use app\modules\user\models\forms\ChangePasswordForm;
use Yii;
use yii\base\Exception;
use yii\behaviors\TimestampBehavior;
use yii\db\ActiveRecord;
use yii\helpers\ArrayHelper;
use yii\web\IdentityInterface;
use yii\web\ServerErrorHttpException;

/**
 * This is the model class for table "users".
 *
 * @property integer $id
 * @property string $first_name
 * @property string $last_name
 * @property string $email
 * @property string $password
 * @property string $avatar
 * @property string $status
 * @property string $created_at
 * @property string $last_login_at
 * @property string $auth_key
 * @property string $auth_provider
 * @property string $social_id
 */
class User extends ActiveRecord implements IdentityInterface
{
    /** Active user status */
    const STATUS_ACTIVE = 'active';

    /** Blocked user status */
    const STATUS_BLOCKED = 'blocked';

    /** Created user status */
    const STATUS_CREATED = 'created';

    /** Role user */
    const ROLE_USER = 'user';

    /** Role admin */
    const ROLE_ADMIN = 'admin';

    const DEFAULT_AVATAR_URL = '/img/no_image.png';

    public $rememberMe = true;

    /**
     * @inheritdoc
     */
    public static function tableName()
    {
        return 'users';
    }

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return [
            ['id', 'integer'],
            [['status'], 'string'],
            ['email', 'email'],
            ['email', 'unique'],
            [['created_at', 'last_login_at'], 'safe'],
            [['auth_key', 'avatar', 'email', 'password', 'auth_provider'], 'string'],
            [['first_name', 'last_name'], 'string', 'max' => 64],
        ];
    }

    /**
     * @inheritdoc
     */
    public function attributeLabels()
    {
        return [
            'id' => Yii::t('user', 'ID'),
            'first_name' => Yii::t('user', 'First name'),
            'last_name' => Yii::t('user', 'Last name'),
            'email' => Yii::t('user', 'Email'),
            'password' => Yii::t('user', 'Password'),
            'avatar' => Yii::t('user', 'Avatar'),
            'status' => Yii::t('user', 'Status'),
            'created_at' => Yii::t('user', 'Registration time'),
            'last_login_at' => Yii::t('user', 'Last sign in'),
        ];
    }

    /**
     * @return array
     */
    public function behaviors()

    {
        return [
            [
                'class' => TimestampBehavior::className(),
                'attributes' => [
                    ActiveRecord::EVENT_BEFORE_INSERT => ['created_at'],
                ],
                'value' => date('Y-m-d H:i:s'),
            ],
        ];
    }

    /**
     * @inheritdoc
     */
    public static function findIdentity($id)
    {
        return static::findOne($id);
    }

    /**
     * @inheritdoc
     */
    public static function findIdentityByAccessToken($token, $type = null)
    {
        return static::findOne(['accessToken' => $token]);
    }

    /**
     * @param $email
     * @return static
     */
    public static function findByEmail($email)
    {
        return static::findOne(['email' => $email]);
    }

    /**
     * @inheritdoc
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * @inheritdoc
     */
    public function getAuthKey()
    {
        return $this->auth_key;
    }

    /**
     * @inheritdoc
     */
    public function validateAuthKey($authKey)
    {
        return $this->auth_key === $authKey;
    }

    /**
     * Validates password
     *
     * @param string $password password to validate
     * @return bool if password provided is valid for current user
     */
    public function validatePassword($password)
    {
        return Yii::$app->security->validatePassword($password, $this->password);
    }

    /**
     * @return bool
     */
    public function hasEmptyPassword()
    {
        return empty($this->password);
    }

    /**
     * Logs in a user using the provided username and password.
     *
     * @return boolean whether the user is logged in successfully
     * @throws Exception
     */
    public function login()
    {
        if (!Yii::$app->user->login($this, $this->rememberMe ? 3600 * 24 * 7 : 0)) {
            throw new Exception('User could not be logged in.');
        }
        $this->last_login_at = date('Y-m-d H:i:s');
        $this->update();
    }

    /**
     * @param $userData
     * @return User
     */
    public function create($userData)
    {
        $this->first_name = $userData->firstName;
        $this->last_name = $userData->lastName;
        $this->email = $userData->email;
        $this->password = Yii::$app->security->generatePasswordHash($userData->password);
        $this->auth_key = Yii::$app->security->generateRandomString();
        $this->avatar = self::DEFAULT_AVATAR_URL;

        $this->save();
        $this->setRole(self::ROLE_USER);
        return $this;
    }

    /**
     * Set new role
     *
     * @param $role
     */
    public function setRole($role)
    {
        $auth = Yii::$app->authManager;
        $auth->revokeAll($this->id);
        $userRole = $auth->getRole($role);
        $auth->assign($userRole, $this->getId());
    }

    /**
     * Return role for user
     *
     * @return string
     */
    public function getRoleName()
    {
        $auth = Yii::$app->authManager;
        $userRole = $auth->getRolesByUser($this->id);
        return !empty($userRole) ? array_shift($userRole)->name : '';
    }

    /**
     * @param $hash
     * @return static
     * @throws ServerErrorHttpException
     */
    public static function findByHash($hash)
    {
        if (!$hash = Hash::findOne(['hash' => $hash])) {
            throw new ServerErrorHttpException('The server encountered an internal error and could not complete your request.');
        }
        return static::findOne($hash->user_id);
    }

    /**
     * @param $socialId
     * @return static
     */
    public static function findBySocialId($socialId)
    {
        return static::findOne(['social_id' => $socialId]);
    }

    /**
     * @param $userAttributes
     * @return bool
     */
    public function saveSocialAccountInfo($userAttributes)
    {
        if ($this->isNewRecord) {
            $this->first_name = ArrayHelper::getValue($userAttributes, 'firstName');
            $this->last_name = ArrayHelper::getValue($userAttributes, 'lastName');
            $this->email = ArrayHelper::getValue($userAttributes, 'email');
            $this->avatar = ArrayHelper::getValue($userAttributes, 'avatar');
            $this->status = self::STATUS_ACTIVE;
        }
        $this->social_id = ArrayHelper::getValue($userAttributes, 'socialId');
        $this->auth_provider = ArrayHelper::getValue($userAttributes, 'authProvider');

        return $this->save();
    }

    /**
     * @param $form
     * @return bool
     */
    public function changePassword($form)
    {
        if ($form->load(Yii::$app->request->post()) && $form->validate()) {
            $this->password = Yii::$app->security->generatePasswordHash($form->newPassword);
            $this->update();
            Hash::findByUserId($this->id)->delete();
            return true;
        }
        return false;
    }
}


1			<?php
2
3			namespace app\modules\user\models;
4
5			use app\modules\user\models\forms\ChangePasswordForm;
6			use Yii;
7			use yii\base\Exception;
8			use yii\behaviors\TimestampBehavior;
9			use yii\db\ActiveRecord;
10			use yii\helpers\ArrayHelper;
11			use yii\web\IdentityInterface;
12			use yii\web\ServerErrorHttpException;
13
14			/**
15			* This is the model class for table "users".
16			*
17			* @property integer $id
18			* @property string $first_name
19			* @property string $last_name
20			* @property string $email
21			* @property string $password
22			* @property string $avatar
23			* @property string $status
24			* @property string $created_at
25			* @property string $last_login_at
26			* @property string $auth_key
27			* @property string $auth_provider
28			* @property string $social_id
29			*/
30			class User extends ActiveRecord implements IdentityInterface
31			{
32			/** Active user status */
33			const STATUS_ACTIVE = 'active';
34
35			/** Blocked user status */
36			const STATUS_BLOCKED = 'blocked';
37
38			/** Created user status */
39			const STATUS_CREATED = 'created';
40
41			/** Role user */
42			const ROLE_USER = 'user';
43
44			/** Role admin */
45			const ROLE_ADMIN = 'admin';
46
47			const DEFAULT_AVATAR_URL = '/img/no_image.png';
48
49			public $rememberMe = true;
50
51			/**
52			* @inheritdoc
53			*/
54	52		public static function tableName()
55			{
56	52		return 'users';
57			}
58
59			/**
60			* @inheritdoc
61			*/
62	7		public function rules()
63			{
64			return [
65	7		['id', 'integer'],
66			[['status'], 'string'],
67			['email', 'email'],
68			['email', 'unique'],
69			[['created_at', 'last_login_at'], 'safe'],
70			[['auth_key', 'avatar', 'email', 'password', 'auth_provider'], 'string'],
71			[['first_name', 'last_name'], 'string', 'max' => 64],
72			];
73			}
74
75			/**
76			* @inheritdoc
77			*/
78	10		public function attributeLabels()
79			{
80			return [
81	10		'id' => Yii::t('user', 'ID'),
82	10		'first_name' => Yii::t('user', 'First name'),
83	10		'last_name' => Yii::t('user', 'Last name'),
84	10		'email' => Yii::t('user', 'Email'),
85	10		'password' => Yii::t('user', 'Password'),
86	10		'avatar' => Yii::t('user', 'Avatar'),
87	10		'status' => Yii::t('user', 'Status'),
88	10		'created_at' => Yii::t('user', 'Registration time'),
89	10		'last_login_at' => Yii::t('user', 'Last sign in'),
90			];
91			}
92
93			/**
94			* @return array
95			*/
96	54	View Code Duplication	public function behaviors()
			0 ignored issues – show Duplication introduced 2017-10-25 08:46 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
97			{
98			return [
99			[
100	54		'class' => TimestampBehavior::className(),
101			'attributes' => [
102	54		ActiveRecord::EVENT_BEFORE_INSERT => ['created_at'],
103			],
104	54		'value' => date('Y-m-d H:i:s'),
105			],
106			];
107			}
108
109			/**
110			* @inheritdoc
111			*/
112	44		public static function findIdentity($id)
113			{
114	44		return static::findOne($id);
115			}
116
117			/**
118			* @inheritdoc
119			*/
120			public static function findIdentityByAccessToken($token, $type = null)
121			{
122			return static::findOne(['accessToken' => $token]);
123			}
124
125			/**
126			* @param $email
127			* @return static
128			*/
129	2		public static function findByEmail($email)
130			{
131	2		return static::findOne(['email' => $email]);
132			}
133
134			/**
135			* @inheritdoc
136			*/
137	46		public function getId()
138			{
139	46		return $this->id;
140			}
141
142			/**
143			* @inheritdoc
144			*/
145	2		public function getAuthKey()
146			{
147	2		return $this->auth_key;
148			}
149
150			/**
151			* @inheritdoc
152			*/
153			public function validateAuthKey($authKey)
154			{
155			return $this->auth_key === $authKey;
156			}
157
158			/**
159			* Validates password
160			*
161			* @param string $password password to validate
162			* @return bool if password provided is valid for current user
163			*/
164	1		public function validatePassword($password)
165			{
166	1		return Yii::$app->security->validatePassword($password, $this->password);
167			}
168
169			/**
170			* @return bool
171			*/
172	1		public function hasEmptyPassword()
173			{
174	1		return empty($this->password);
175			}
176
177			/**
178			* Logs in a user using the provided username and password.
179			*
180			* @return boolean whether the user is logged in successfully
181			* @throws Exception
182			*/
183	2		public function login()
184			{
185	2		if (!Yii::$app->user->login($this, $this->rememberMe ? 3600 * 24 * 7 : 0)) {
186			throw new Exception('User could not be logged in.');
187			}
188	2		$this->last_login_at = date('Y-m-d H:i:s');
189	2		$this->update();
190	2		}
191
192			/**
193			* @param $userData
194			* @return User
195			*/
196	2		public function create($userData)
197			{
198	2		$this->first_name = $userData->firstName;
199	2		$this->last_name = $userData->lastName;
200	2		$this->email = $userData->email;
201	2		$this->password = Yii::$app->security->generatePasswordHash($userData->password);
202	2		$this->auth_key = Yii::$app->security->generateRandomString();
203	2		$this->avatar = self::DEFAULT_AVATAR_URL;
204
205	2		$this->save();
206	2		$this->setRole(self::ROLE_USER);
207	2		return $this;
208			}
209
210			/**
211			* Set new role
212			*
213			* @param $role
214			*/
215	3		public function setRole($role)
216			{
217	3		$auth = Yii::$app->authManager;
218	3		$auth->revokeAll($this->id);
219	3		$userRole = $auth->getRole($role);
220	3		$auth->assign($userRole, $this->getId());
221	3		}
222
223			/**
224			* Return role for user
225			*
226			* @return string
227			*/
228	12		public function getRoleName()
229			{
230	12		$auth = Yii::$app->authManager;
231	12		$userRole = $auth->getRolesByUser($this->id);
232	12		return !empty($userRole) ? array_shift($userRole)->name : '';
233			}
234
235			/**
236			* @param $hash
237			* @return static
238			* @throws ServerErrorHttpException
239			*/
240	10		public static function findByHash($hash)
241			{
242	10		if (!$hash = Hash::findOne(['hash' => $hash])) {
243			throw new ServerErrorHttpException('The server encountered an internal error and could not complete your request.');
244			}
245	10		return static::findOne($hash->user_id);
246			}
247
248			/**
249			* @param $socialId
250			* @return static
251			*/
252			public static function findBySocialId($socialId)
253			{
254			return static::findOne(['social_id' => $socialId]);
255			}
256
257			/**
258			* @param $userAttributes
259			* @return bool
260			*/
261			public function saveSocialAccountInfo($userAttributes)
262			{
263			if ($this->isNewRecord) {
264			$this->first_name = ArrayHelper::getValue($userAttributes, 'firstName');
265			$this->last_name = ArrayHelper::getValue($userAttributes, 'lastName');
266			$this->email = ArrayHelper::getValue($userAttributes, 'email');
267			$this->avatar = ArrayHelper::getValue($userAttributes, 'avatar');
268			$this->status = self::STATUS_ACTIVE;
269			}
270			$this->social_id = ArrayHelper::getValue($userAttributes, 'socialId');
271			$this->auth_provider = ArrayHelper::getValue($userAttributes, 'authProvider');
272
273			return $this->save();
274			}
275
276			/**
277			* @param $form
278			* @return bool
279			*/
280	10		public function changePassword($form)
281			{
282	10		if ($form->load(Yii::$app->request->post()) && $form->validate()) {
283	2		$this->password = Yii::$app->security->generatePasswordHash($form->newPassword);
284	2		$this->update();
285	2		Hash::findByUserId($this->id)->delete();
286	2		return true;
287			}
288	10		return false;
289			}
290			}
291

nixsolutions / yii2-starter

Push — develop ( 639696...9f112c )

User::findIdentityByAccessToken() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like