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

Completed

Push — master ( 18edfa...a3fde4 )

by Alexey

created 2019-09-10 17:27 UTC

BaseUser::getAuthKey() A

↳ Parent: BaseUser

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

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

<?php


namespace modules\users\models;

use modules\users\Module;
use Yii;
use yii\base\Exception;
use yii\db\ActiveRecord;
use yii\helpers\ArrayHelper;
use yii\helpers\Html;
use yii\web\IdentityInterface;

/**
 * Class BaseUser
 * @package modules\users\models
 *
 * @property int $id ID
 * @property string $auth_key Authorization Key
 * @property string $email_confirm_token Email Confirm Token
 */
class BaseUser extends ActiveRecord implements IdentityInterface
{
    // Statuses
    const STATUS_BLOCKED = 0;
    const STATUS_ACTIVE = 1;
    const STATUS_WAIT = 2;
    const STATUS_DELETED = 3;

    /**
     * {@inheritdoc}
     * @return string
     */
    public static function tableName()
    {
        return '{{%user}}';
    }

    /**
     * {@inheritdoc}
     * @param int|string $id
     * @return User|null|IdentityInterface
     */
    public static function findIdentity($id)
    {
        return static::findOne(['id' => $id, 'status' => self::STATUS_ACTIVE]);
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }

    /**
     * @param mixed $token
     * @param mixed $type
     * @return User|IdentityInterface|null
     */
    public static function findIdentityByAccessToken($token, $type = null)
    {
        return static::findOne(['auth_key' => $token, 'status' => self::STATUS_ACTIVE]);
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }

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

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

    /**
     * {@inheritdoc}
     * @param string $authKey
     * @return bool
     */
    public function validateAuthKey($authKey)
    {
        return $this->getAuthKey() === $authKey;
    }

    /**
     * Generates "remember me" authentication key
     * @throws Exception
     */
    public function generateAuthKey()
    {
        /** @var yii\base\Security $security */
        $security = Yii::$app->security;
        $this->auth_key = $security->generateRandomString();
    }

    /**
     * Generates email confirmation token
     * @throws Exception
     */
    public function generateEmailConfirmToken()
    {
        /** @var yii\base\Security $security */
        $security = Yii::$app->security;
        $this->email_confirm_token = $security->generateRandomString();
    }

    /**
     * Finds out if password reset token is valid
     *
     * @param mixed $token password reset token
     * @return boolean
     */
    public static function isPasswordResetTokenValid($token)
    {
        if (empty($token)) {
            return false;
        }
        $expire = Module::$passwordResetTokenExpire;
        $parts = explode('_', $token);
        $timestamp = (int)end($parts);
        return $timestamp + $expire >= time();
    }

    /**
     * Finds user by password reset token
     *
     * @param mixed $token password reset token
     * @return static|null
     */
    public static function findByPasswordResetToken($token)
    {
        if (!static::isPasswordResetTokenValid($token)) {
            return null;
        }
        return static::findOne([
            'password_reset_token' => $token,
            'status' => self::STATUS_ACTIVE
        ]);
    }

    /**
     * @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')
        ];
    }

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

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

1			<?php
2
3
4			namespace modules\users\models;
5
6			use modules\users\Module;
7			use Yii;
8			use yii\base\Exception;
9			use yii\db\ActiveRecord;
10			use yii\helpers\ArrayHelper;
11			use yii\helpers\Html;
12			use yii\web\IdentityInterface;
13
14			/**
15			* Class BaseUser
16			* @package modules\users\models
17			*
18			* @property int $id ID
19			* @property string $auth_key Authorization Key
20			* @property string $email_confirm_token Email Confirm Token
21			*/
22			class BaseUser extends ActiveRecord implements IdentityInterface
23			{
24			// Statuses
25			const STATUS_BLOCKED = 0;
26			const STATUS_ACTIVE = 1;
27			const STATUS_WAIT = 2;
28			const STATUS_DELETED = 3;
29
30			/**
31			* {@inheritdoc}
32			* @return string
33			*/
34			public static function tableName()
35			{
36			return '{{%user}}';
37			}
38
39			/**
40			* {@inheritdoc}
41			* @param int\|string $id
42			* @return User\|null\|IdentityInterface
43			*/
44			public static function findIdentity($id)
45			{
46			return static::findOne(['id' => $id, 'status' => self::STATUS_ACTIVE]);
			0 ignored issues – show Bug Best Practice introduced 2019-09-10 17:31 UTC by Report Bug Copy Issue Report The expression `return static::findOne(a...> self::STATUS_ACTIVE))` returns the type `yii\db\ActiveRecord` which is incompatible with the return type mandated by `yii\web\IdentityInterface::findIdentity()` of `null\|yii\web\IdentityInterface`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
47			}
48
49			/**
50			* @param mixed $token
51			* @param mixed $type
52			* @return User\|IdentityInterface\|null
53			*/
54			public static function findIdentityByAccessToken($token, $type = null)
55			{
56			return static::findOne(['auth_key' => $token, 'status' => self::STATUS_ACTIVE]);
			0 ignored issues – show Bug Best Practice introduced 2019-09-10 17:31 UTC by Report Bug Copy Issue Report The expression `return static::findOne(a...> self::STATUS_ACTIVE))` returns the type `yii\db\ActiveRecord` which is incompatible with the return type mandated by `yii\web\IdentityInterfac...IdentityByAccessToken()` of `null\|yii\web\IdentityInterface`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
57			}
58
59			/**
60			* {@inheritdoc}
61			* @return int\|string
62			*/
63			public function getId()
64			{
65			return $this->id;
66			}
67
68			/**
69			* {@inheritdoc}
70			* @return string
71			*/
72			public function getAuthKey()
73			{
74			return $this->auth_key;
75			}
76
77			/**
78			* {@inheritdoc}
79			* @param string $authKey
80			* @return bool
81			*/
82			public function validateAuthKey($authKey)
83			{
84			return $this->getAuthKey() === $authKey;
85			}
86
87			/**
88			* Generates "remember me" authentication key
89			* @throws Exception
90			*/
91			public function generateAuthKey()
92			{
93			/** @var yii\base\Security $security */
94			$security = Yii::$app->security;
95			$this->auth_key = $security->generateRandomString();
96			}
97
98			/**
99			* Generates email confirmation token
100			* @throws Exception
101			*/
102			public function generateEmailConfirmToken()
103			{
104			/** @var yii\base\Security $security */
105			$security = Yii::$app->security;
106			$this->email_confirm_token = $security->generateRandomString();
107			}
108
109			/**
110			* Finds out if password reset token is valid
111			*
112			* @param mixed $token password reset token
113			* @return boolean
114			*/
115			public static function isPasswordResetTokenValid($token)
116			{
117			if (empty($token)) {
118			return false;
119			}
120			$expire = Module::$passwordResetTokenExpire;
121			$parts = explode('_', $token);
122			$timestamp = (int)end($parts);
123			return $timestamp + $expire >= time();
124			}
125
126			/**
127			* Finds user by password reset token
128			*
129			* @param mixed $token password reset token
130			* @return static\|null
131			*/
132			public static function findByPasswordResetToken($token)
133			{
134			if (!static::isPasswordResetTokenValid($token)) {
135			return null;
136			}
137			return static::findOne([
138			'password_reset_token' => $token,
139			'status' => self::STATUS_ACTIVE
140			]);
141			}
142
143			/**
144			* @return array
145			*/
146			public static function getStatusesArray()
147			{
148			return [
149			self::STATUS_BLOCKED => Module::t('module', 'Blocked'),
150			self::STATUS_ACTIVE => Module::t('module', 'Active'),
151			self::STATUS_WAIT => Module::t('module', 'Wait'),
152			self::STATUS_DELETED => Module::t('module', 'Deleted')
153			];
154			}
155
156			/**
157			* @return array
158			*/
159			public static function getLabelsArray()
160			{
161			return [
162			self::STATUS_BLOCKED => 'default',
163			self::STATUS_ACTIVE => 'success',
164			self::STATUS_WAIT => 'warning',
165			self::STATUS_DELETED => 'danger'
166			];
167			}
168
169			/**
170			* @return mixed
171			*/
172			public function getStatusName()
173			{
174			return ArrayHelper::getValue(self::getStatusesArray(), $this->status);
			0 ignored issues – show Bug Best Practice introduced 2019-09-10 17:31 UTC by Report Bug Copy Issue Report The property `status` does not exist on `modules\users\models\BaseUser`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
175			}
176
177			/**
178			* Return <span class="label label-success">Active</span>
179			* @return string
180			*/
181			public function getStatusLabelName()
182			{
183			$name = ArrayHelper::getValue(self::getLabelsArray(), $this->status);
			0 ignored issues – show Bug Best Practice introduced 2019-09-10 17:31 UTC by Report Bug Copy Issue Report The property `status` does not exist on `modules\users\models\BaseUser`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
184			return Html::tag('span', $this->getStatusName(), ['class' => 'label label-' . $name]);
185			}
186			}

Dominus77 / yii2-advanced-start

Push — master ( 18edfa...a3fde4 )

BaseUser::getAuthKey() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like