PHP Класс YWebUser

Наследование: extends CWebUser
Показать файл Открыть проект

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

Свойство Тип Описание
$allowAutoLogin boolean
$attempt integer
$authTimeout integer
$authToken string
$autoRenewCookie boolean
$rbacCacheNameSpace string

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

Свойство Тип Описание
$_profiles array

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

Метод Описание
beforeLogin ( mixed $id, array $states, boolean $fromCookie ) : boolean
getAvatar ( integer $size = 64 ) : mixed
getProfile ( string $moduleName = 'yupe' ) : User | null Метод возвращающий профайл пользователя: s
getProfileField ( $field, string $module = 'yupe' ) : array | mixed | null
isAuthenticated ( ) : boolean Метод который проверяет, авторизирован ли пользователь:
isSuperUser ( ) : boolean Метод проверки пользователя на принадлежность к админам:
login ( IUserIdentity $identity, integer $duration ) : boolean

Защищенные методы

Метод Описание
afterLogin ( boolean $fromCookie ) : parent::afterLogin() Метод для действий после входа в систему:
afterLogout ( ) : parent::afterLogout() Метод для действий после выхода из системы:

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

afterLogin() защищенный Метод

Метод для действий после входа в систему:
protected afterLogin ( boolean $fromCookie ) : parent::afterLogin()
$fromCookie boolean - is authorize from cookie
Результат parent::afterLogin()

afterLogout() защищенный Метод

Метод для действий после выхода из системы:
protected afterLogout ( ) : parent::afterLogout()
Результат parent::afterLogout()

beforeLogin() публичный Метод

public beforeLogin ( mixed $id, array $states, boolean $fromCookie ) : boolean
$id mixed
$states array
$fromCookie boolean
Результат boolean

getAvatar() публичный Метод

public getAvatar ( integer $size = 64 ) : mixed
$size integer
Результат mixed

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

Метод возвращающий профайл пользователя: s
public getProfile ( string $moduleName = 'yupe' ) : User | null
$moduleName string - идентификатор модуля
Результат User | null - Модель пользователя в случае успеха, иначе null

getProfileField() публичный Метод

public getProfileField ( $field, string $module = 'yupe' ) : array | mixed | null
$field
$module string
Результат array | mixed | null

isAuthenticated() публичный Метод

Метод который проверяет, авторизирован ли пользователь:
public isAuthenticated ( ) : boolean
Результат boolean авторизирован ли пользователь

isSuperUser() публичный Метод

Метод проверки пользователя на принадлежность к админам:
public isSuperUser ( ) : boolean
Результат boolean is super user

login() публичный Метод

public login ( IUserIdentity $identity, integer $duration ) : boolean
$identity IUserIdentity
$duration integer
Результат boolean

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

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

protected array $_profiles
Результат array

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

public bool $allowAutoLogin
Результат boolean

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

public int $attempt
Результат integer

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

public int $authTimeout
Результат integer

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

public string $authToken
Результат string

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

public bool $autoRenewCookie
Результат boolean

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

С версии: 0.8
public string $rbacCacheNameSpace
Результат string