PHP Интерфейс Prado\Security\IUser

This interface must be implemented by user objects.
С версии: 3.0
Автор: Qiang Xue ([email protected])
Показать файл Открыть проект

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

Метод Описание
getIsGuest ( ) : boolean
getName ( ) : string
getRoles ( ) : array
isInRole ( $role ) : boolean
loadFromString ( $string ) : Prado\Security\IUser
saveToString ( ) : string
setIsGuest ( $value )
setName ( $value )
setRoles ( $value ) : array | string

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

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

public getIsGuest ( ) : boolean
Результат boolean if the user is a guest

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

public getName ( ) : string
Результат string username

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

public getRoles ( ) : array
Результат array list of roles that the user is of

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

public isInRole ( $role ) : boolean
Результат boolean whether the user is of this role

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

public loadFromString ( $string ) : Prado\Security\IUser
Результат Prado\Security\IUser the user object

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

public saveToString ( ) : string
Результат string user data that is serialized and will be stored in session

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

public setIsGuest ( $value )

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

public setName ( $value )

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

public setRoles ( $value ) : array | string
Результат array | string list of roles that the user is of. If it is a string, roles are assumed by separated by comma