Class common\models\User

All Classes | Properties | Methods | Constants

Inheritance	common\models\User » yii\db\ActiveRecord
Implements	yii\web\IdentityInterface
Source Code	https://github.com/yiisoft/yii2-app-advanced/blob/master/common/models/User.php

User model

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$auth_key	string		common\models\User
$created_at	integer		common\models\User
$email	string		common\models\User
$id	integer		common\models\User
$password	string	write-only password	common\models\User
$password_hash	string		common\models\User
$password_reset_token	string		common\models\User
$status	integer		common\models\User
$updated_at	integer		common\models\User
$username	string		common\models\User
$verification_token	string		common\models\User

Public Methods

Hide inherited methods

Method	Description	Defined By
behaviors()		common\models\User
findByPasswordResetToken()	Finds user by password reset token	common\models\User
findByUsername()	Finds user by username	common\models\User
findByVerificationToken()	Finds user by verification email token	common\models\User
findIdentity()		common\models\User
findIdentityByAccessToken()		common\models\User
generateAuthKey()	Generates "remember me" authentication key	common\models\User
generateEmailVerificationToken()	Generates new token for email verification	common\models\User
generatePasswordResetToken()	Generates new password reset token	common\models\User
getAuthKey()		common\models\User
getId()		common\models\User
isPasswordResetTokenValid()	Finds out if password reset token is valid	common\models\User
removePasswordResetToken()	Removes password reset token	common\models\User
rules()		common\models\User
setPassword()	Generates password hash from password and sets it to the model	common\models\User
tableName()		common\models\User
validateAuthKey()		common\models\User
validatePassword()	Validates password	common\models\User

Constants

Hide inherited constants

Constant	Value	Defined By
STATUS_ACTIVE	10	common\models\User
STATUS_DELETED	0	common\models\User
STATUS_INACTIVE	9	common\models\User

Property Details

Hide inherited properties

$auth_key public property

public string $auth_key = null

$created_at public property

public integer $created_at = null

$email public property

public string $email = null

$id public property

public integer $id = null

$password public property

write-only password

public string $password = null

$password_hash public property

public string $password_hash = null

$password_reset_token public property

public string $password_reset_token = null

$status public property

public integer $status = null

$updated_at public property

public integer $updated_at = null

$username public property

public string $username = null

$verification_token public property

public string $verification_token = null

Method Details

Hide inherited methods

behaviors() public method

public behaviors( ):

Source code

                public function behaviors()
{
    return [
        TimestampBehavior::class,
    ];
}

findByPasswordResetToken() public static method

Finds user by password reset token

public static findByPasswordResetToken( string $token ): common\models\User\|null
$token	string	Password reset token

Source code

                public static function findByPasswordResetToken($token)
{
    if (!static::isPasswordResetTokenValid($token)) {
        return null;
    }
    return static::findOne([
        'password_reset_token' => $token,
        'status' => self::STATUS_ACTIVE,
    ]);
}

findByUsername() public static method

Finds user by username

public static findByUsername( string $username ): common\models\User\|null
$username	string

Source code

                public static function findByUsername($username)
{
    return static::findOne(['username' => $username, 'status' => self::STATUS_ACTIVE]);
}

findByVerificationToken() public static method

Finds user by verification email token

public static findByVerificationToken( string $token ): common\models\User\|null
$token	string	Verify email token

Source code

                public static function findByVerificationToken($token)
{
    return static::findOne([
        'verification_token' => $token,
        'status' => self::STATUS_INACTIVE
    ]);
}

findIdentity() public static method

public static findIdentity( mixed $id ):
$id	mixed

Source code

                public static function findIdentity($id)
{
    return static::findOne(['id' => $id, 'status' => self::STATUS_ACTIVE]);
}

findIdentityByAccessToken() public static method

public static findIdentityByAccessToken( mixed $token, mixed $type = null ):
$token	mixed
$type	mixed

Source code

                public static function findIdentityByAccessToken($token, $type = null)
{
    throw new NotSupportedException('"findIdentityByAccessToken" is not implemented.');
}

generateAuthKey() public method

Generates "remember me" authentication key

public generateAuthKey( ): mixed

Source code

                public function generateAuthKey()
{
    $this->auth_key = Yii::$app->security->generateRandomString();
}

generateEmailVerificationToken() public method

Generates new token for email verification

public generateEmailVerificationToken( ): mixed

Source code

                public function generateEmailVerificationToken()
{
    $this->verification_token = Yii::$app->security->generateRandomString() . '_' . time();
}

generatePasswordResetToken() public method

Generates new password reset token

public generatePasswordResetToken( ): mixed

Source code

                public function generatePasswordResetToken()
{
    $this->password_reset_token = Yii::$app->security->generateRandomString() . '_' . time();
}

getAuthKey() public method

public getAuthKey( ):

Source code

                public function getAuthKey()
{
    return $this->auth_key;
}

getId() public method

public getId( ):

Source code

                public function getId()
{
    return $this->getPrimaryKey();
}

isPasswordResetTokenValid() public static method

Finds out if password reset token is valid

public static isPasswordResetTokenValid( string $token ): boolean
$token	string	Password reset token

Source code

                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();
}

removePasswordResetToken() public method

Removes password reset token

public removePasswordResetToken( ): mixed

Source code

                public function removePasswordResetToken()
{
    $this->password_reset_token = null;
}

rules() public method

public rules( ):

Source code

                public function rules()
{
    return [
        ['status', 'default', 'value' => self::STATUS_INACTIVE],
        ['status', 'in', 'range' => [self::STATUS_ACTIVE, self::STATUS_INACTIVE, self::STATUS_DELETED]],
    ];
}

setPassword() public method

Generates password hash from password and sets it to the model

public setPassword( string $password ): mixed
$password	string

Source code

                public function setPassword($password)
{
    $this->password_hash = Yii::$app->security->generatePasswordHash($password);
}

tableName() public static method

public static tableName( ):

Source code

                public static function tableName()
{
    return '{{%user}}';
}

validateAuthKey() public method

public validateAuthKey( mixed $authKey ):
$authKey	mixed

Source code

                public function validateAuthKey($authKey)
{
    return $this->getAuthKey() === $authKey;
}

validatePassword() public method

Validates password

public validatePassword( string $password ): boolean
$password	string	Password to validate
return	boolean	If password provided is valid for current user

Source code

                public function validatePassword($password)
{
    return Yii::$app->security->validatePassword($password, $this->password_hash);
}