PHP Класс amnah\yii2\user\models\User

Наследование: extends yii\db\ActiveRecord, implements yii\web\IdentityInterface
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$currentPassword Current password - for account page updates
$module amnah\yii2\user\Module
$newPassword New password - for registration and changing password
$newPasswordConfirm New password confirmation - for reset

Защищенные свойства (Protected)

Свойство Тип Описание
$permissionCache Permission cache array

Открытые методы

Метод Описание
attributeLabels ( )
beforeSave ( $insert )
behaviors ( )
can ( string $permissionName, array $params = [], boolean $allowCaching = true ) : boolean Check if user can do specified $permission
checkEmailChange ( ) : string | boolean Check for email change
confirm ( string $newEmail ) : boolean Confirm user email
findIdentity ( $id )
findIdentityByAccessToken ( $token, $type = null )
getAuthKey ( )
getDisplayName ( ) : string | integer Get display name for the user
getId ( )
getProfile ( ) : ActiveQuery
getRole ( ) : ActiveQuery
getUserAuths ( ) : ActiveQuery
getUserTokens ( ) : ActiveQuery
init ( )
rules ( )
sendEmailConfirmation ( amnah\yii2\user\models\UserToken $userToken ) : integer Send email confirmation to user
setRegisterAttributes ( integer $roleId, string $status = null ) : static Set attributes for registration
statusDropdown ( ) : array Get list of statuses for creating dropdowns
updateLoginMeta ( ) : boolean Update login info (ip and time)
validateAuthKey ( $authKey )
validateCurrentPassword ( ) Validate current password (account page)
validatePassword ( string $password ) : boolean Validate password

Описание методов

attributeLabels() публичный метод

public attributeLabels ( )

beforeSave() публичный метод

public beforeSave ( $insert )

behaviors() публичный метод

public behaviors ( )

can() публичный метод

Check if user can do specified $permission
public can ( string $permissionName, array $params = [], boolean $allowCaching = true ) : boolean
$permissionName string
$params array
$allowCaching boolean
Результат boolean

checkEmailChange() публичный метод

Check for email change
public checkEmailChange ( ) : string | boolean
Результат string | boolean

confirm() публичный метод

Confirm user email
public confirm ( string $newEmail ) : boolean
$newEmail string
Результат boolean

findIdentity() публичный статический метод

public static findIdentity ( $id )

findIdentityByAccessToken() публичный статический метод

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

getAuthKey() публичный метод

public getAuthKey ( )

getDisplayName() публичный метод

Get display name for the user
public getDisplayName ( ) : string | integer
Результат string | integer

getId() публичный метод

public getId ( )

getProfile() публичный метод

public getProfile ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getRole() публичный метод

public getRole ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getUserAuths() публичный метод

public getUserAuths ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getUserTokens() публичный метод

public getUserTokens ( ) : ActiveQuery
Результат yii\db\ActiveQuery

init() публичный метод

public init ( )

rules() публичный метод

public rules ( )

sendEmailConfirmation() публичный метод

Send email confirmation to user
public sendEmailConfirmation ( amnah\yii2\user\models\UserToken $userToken ) : integer
$userToken amnah\yii2\user\models\UserToken
Результат integer

setRegisterAttributes() публичный метод

Set attributes for registration
public setRegisterAttributes ( integer $roleId, string $status = null ) : static
$roleId integer
$status string
Результат static

statusDropdown() публичный статический метод

Get list of statuses for creating dropdowns
public static statusDropdown ( ) : array
Результат array

updateLoginMeta() публичный метод

Update login info (ip and time)
public updateLoginMeta ( ) : boolean
Результат boolean

validateAuthKey() публичный метод

public validateAuthKey ( $authKey )

validateCurrentPassword() публичный метод

Validate current password (account page)
public validateCurrentPassword ( )

validatePassword() публичный метод

Validate password
public validatePassword ( string $password ) : boolean
$password string
Результат boolean

Описание свойств

$currentPassword публичное свойство

Current password - for account page updates
public $currentPassword

$module публичное свойство

public Module,amnah\yii2\user $module
Результат amnah\yii2\user\Module

$newPassword публичное свойство

New password - for registration and changing password
public $newPassword

$newPasswordConfirm публичное свойство

New password confirmation - for reset
public $newPasswordConfirm

$permissionCache защищенное свойство

Permission cache array
protected $permissionCache