app\core\models\User

Complexity

Total Complexity

18

Size/Duplication

Total Lines	187
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	isPasswordResetTokenValid()	0	9	2
A	findByPasswordResetToken()	0	9	2
A	validatePassword()	0	3	1
A	findIdentity()	0	6	1
A	rules()	0	6	1
A	fields()	0	19	1
A	validateAuthKey()	0	3	1
A	removePasswordResetToken()	0	3	1
A	tableName()	0	3	1
A	behaviors()	0	6	1
A	getId()	0	3	1
A	generateAuthKey()	0	3	1
A	generatePasswordResetToken()	0	3	1
A	setPassword()	0	3	1
A	getAuthKey()	0	3	1
A	findIdentityByAccessToken()	0	4	1

<?php

namespace app\core\models;

use app\core\types\UserStatus;
use Yii;
use yii\behaviors\TimestampBehavior;
use yii\db\ActiveRecord;
use yii\web\IdentityInterface;
use yiier\helpers\DateHelper;

/**
 * This is the model class for table "{{%user}}".
 *
 * @property int $id
 * @property string $username
 * @property string|null $avatar
 * @property string $auth_key
 * @property string $password_hash
 * @property string|null $password_reset_token
 * @property string|null $email
 * @property int|null $status 状态：1正常 0冻结
 * @property string $base_currency_code
 * @property int|null $created_at
 * @property int|null $updated_at
 *
 * @property-write string $password
 * @property-read string $authKey
 */
class User extends ActiveRecord implements IdentityInterface
{
    /**
     * @inheritdoc
     */
    public static function tableName()
    {
        return '{{%user}}';
    }

    /**
     * @inheritdoc
     * @throws \yii\base\InvalidConfigException
     */
    public function behaviors()
    {
        return [
            [
                'class' => TimestampBehavior::class,
                'value' => Yii::$app->formatter->asDatetime('now')
            ],
        ];
    }

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return [
            ['status', 'default', 'value' => UserStatus::ACTIVE],
            ['status', 'in', 'range' => [UserStatus::ACTIVE, UserStatus::UNACTIVATED]],
            [['username'], 'string', 'max' => 60],
        ];
    }

    /**
     * @inheritdoc
     */
    public static function findIdentity($id)
    {
        return static::find()

The expression return static::find()->where(array('id' => $id, 'status' => app\core\types\UserStatus::ACTIVE))->limit(1)->one() also could return the type array|yii\db\ActiveRecord which is incompatible with the return type mandated by yii\web\IdentityInterface::findIdentity() of null|yii\web\IdentityInterface.

            ->where(['id' => $id, 'status' => UserStatus::ACTIVE])
            ->limit(1)
            ->one();
    }


    /**
     * @param mixed $token
     * @param null $type

Are you sure the doc-type for parameter $type is correct as it would always require null to be passed?

     * @return void|IdentityInterface
     */
    public static function findIdentityByAccessToken($token, $type = null)
    {
        $userId = (string)$token->getClaim('id');
        return self::findIdentity($userId);

The expression return self::findIdentity($userId) also could return the type array|yii\db\ActiveRecord which is incompatible with the documented return type yii\web\IdentityInterface.

    }

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

The expression return $this->getPrimaryKey() also could return the type array which is incompatible with the return type mandated by yii\web\IdentityInterface::getId() of integer|string.

    }

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

    /**
     * @inheritdoc
     */
    public function validateAuthKey($authKey)
    {
        return $this->getAuthKey() === $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_hash);
    }

    /**
     * Generates password hash from password and sets it to the model
     *
     * @param string $password
     * @throws \yii\base\Exception
     */
    public function setPassword($password)
    {
        $this->password_hash = Yii::$app->security->generatePasswordHash($password);
    }

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

    /**
     * Generates new password reset token
     * @throws \yii\base\Exception
     */
    public function generatePasswordResetToken()
    {
        $this->password_reset_token = Yii::$app->security->generateRandomString() . '_' . time();
    }

    /**
     * Removes password reset token
     */
    public function removePasswordResetToken()
    {
        $this->password_reset_token = null;
    }

    /**
     * Finds user by password reset token
     *
     * @param string $token password reset token
     * @return User|array|ActiveRecord|null
     */
    public static function findByPasswordResetToken($token)
    {
        if (!static::isPasswordResetTokenValid($token)) {
            return null;
        }

        return static::find()
            ->where(['password_reset_token' => $token, 'status' => [UserStatus::ACTIVE]])
            ->one();
    }

    /**
     * Finds out if password reset token is valid
     *
     * @param string $token password reset token
     * @return boolean
     */
    public static function isPasswordResetTokenValid($token)
    {
        if (empty($token)) {
            return false;
        }

        $timestamp = (int)substr($token, strrpos($token, '_') + 1);
        $expire = Yii::$app->params['user.passwordResetTokenExpire'];
        return $timestamp + $expire >= time();
    }

    /**
     * @return array
     */
    public function fields()
    {
        $fields = parent::fields();
        unset($fields['auth_key'], $fields['password_hash'], $fields['password_reset_token']);

        $fields['created_at'] = function (self $model) {
            return DateHelper::datetimeToIso8601($model->created_at);

It seems like $model->created_at can also be of type null; however, parameter $dateStr of yiier\helpers\DateHelper::datetimeToIso8601() does only seem to accept string, maybe add an additional type check?

        };

        $fields['avatar'] = function (self $model) {
            $avatar = md5(strtolower(trim($model->avatar)));

It seems like $model->avatar can also be of type null; however, parameter $string of trim() does only seem to accept string, maybe add an additional type check?

            return "https://www.gravatar.com/avatar/{$avatar}?s=48";
        };

        $fields['updated_at'] = function (self $model) {
            return DateHelper::datetimeToIso8601($model->updated_at);

It seems like $model->updated_at can also be of type null; however, parameter $dateStr of yiier\helpers\DateHelper::datetimeToIso8601() does only seem to accept string, maybe add an additional type check?

        };

        return $fields;
    }
}