User
extends ActiveRecord
in package
implements
IdentityInterface
User model
Tags
Interfaces, Classes, Traits and Enums
- IdentityInterface
Table of Contents
- STATUS_ACTIVE = 10
- STATUS_DELETED = 0
- STATUS_INACTIVE = 9
- $auth_key : string
- $created_at : int
- $email : string
- $id : int
- $password : string
- $password_hash : string
- $password_reset_token : string
- $status : int
- $updated_at : int
- $username : string
- $verification_token : string
- behaviors() : mixed
- {@inheritdoc}
- findByPasswordResetToken() : static|null
- Finds user by password reset token
- findByUsername() : static|null
- Finds user by username
- findByVerificationToken() : static|null
- Finds user by verification email token
- findIdentity() : mixed
- {@inheritdoc}
- findIdentityByAccessToken() : mixed
- {@inheritdoc}
- generateAuthKey() : mixed
- Generates "remember me" authentication key
- generateEmailVerificationToken() : mixed
- Generates new token for email verification
- generatePasswordResetToken() : mixed
- Generates new password reset token
- getAuthKey() : mixed
- {@inheritdoc}
- getId() : mixed
- {@inheritdoc}
- isPasswordResetTokenValid() : bool
- Finds out if password reset token is valid
- removePasswordResetToken() : mixed
- Removes password reset token
- rules() : mixed
- {@inheritdoc}
- setPassword() : mixed
- Generates password hash from password and sets it to the model
- tableName() : mixed
- {@inheritdoc}
- validateAuthKey() : mixed
- {@inheritdoc}
- validatePassword() : bool
- Validates password
Constants
STATUS_ACTIVE
public
mixed
STATUS_ACTIVE
= 10
STATUS_DELETED
public
mixed
STATUS_DELETED
= 0
STATUS_INACTIVE
public
mixed
STATUS_INACTIVE
= 9
Properties
$auth_key
public
string
$auth_key
$created_at
public
int
$created_at
public
string
$email
$id
public
int
$id
$password
public
string
$password
write-only password
$password_hash
public
string
$password_hash
$password_reset_token
public
string
$password_reset_token
$status
public
int
$status
$updated_at
public
int
$updated_at
$username
public
string
$username
$verification_token
public
string
$verification_token
Methods
behaviors()
{@inheritdoc}
public
behaviors() : mixed
Return values
mixed —findByPasswordResetToken()
Finds user by password reset token
public
static findByPasswordResetToken(string $token) : static|null
Parameters
- $token : string
-
password reset token
Return values
static|null —findByUsername()
Finds user by username
public
static findByUsername(string $username) : static|null
Parameters
- $username : string
Return values
static|null —findByVerificationToken()
Finds user by verification email token
public
static findByVerificationToken(string $token) : static|null
Parameters
- $token : string
-
verify email token
Return values
static|null —findIdentity()
{@inheritdoc}
public
static findIdentity(mixed $id) : mixed
Parameters
- $id : mixed
Return values
mixed —findIdentityByAccessToken()
{@inheritdoc}
public
static findIdentityByAccessToken(mixed $token[, mixed $type = null ]) : mixed
Parameters
- $token : mixed
- $type : mixed = null
Return values
mixed —generateAuthKey()
Generates "remember me" authentication key
public
generateAuthKey() : mixed
Return values
mixed —generateEmailVerificationToken()
Generates new token for email verification
public
generateEmailVerificationToken() : mixed
Return values
mixed —generatePasswordResetToken()
Generates new password reset token
public
generatePasswordResetToken() : mixed
Return values
mixed —getAuthKey()
{@inheritdoc}
public
getAuthKey() : mixed
Return values
mixed —getId()
{@inheritdoc}
public
getId() : mixed
Return values
mixed —isPasswordResetTokenValid()
Finds out if password reset token is valid
public
static isPasswordResetTokenValid(string $token) : bool
Parameters
- $token : string
-
password reset token
Return values
bool —removePasswordResetToken()
Removes password reset token
public
removePasswordResetToken() : mixed
Return values
mixed —rules()
{@inheritdoc}
public
rules() : mixed
Return values
mixed —setPassword()
Generates password hash from password and sets it to the model
public
setPassword(string $password) : mixed
Parameters
- $password : string
Return values
mixed —tableName()
{@inheritdoc}
public
static tableName() : mixed
Return values
mixed —validateAuthKey()
{@inheritdoc}
public
validateAuthKey(mixed $authKey) : mixed
Parameters
- $authKey : mixed
Return values
mixed —validatePassword()
Validates password
public
validatePassword(string $password) : bool
Parameters
- $password : string
-
password to validate
Return values
bool —if password provided is valid for current user