Method Details |
getIsGuest
public boolean getIsGuest |
() |
Output |
boolean
| if the user is a guest |
Exception |
|
getName
Output |
string
| username |
Exception |
|
getRoles
Output |
array
| list of roles that the user is of |
Exception |
|
isInRole
public boolean isInRole |
(string $role ) |
Input |
string | $role | role to be tested |
Output |
boolean
| whether the user is of this role |
Exception |
|
loadFromString
public IUser loadFromString |
(string $string ) |
Input |
string | $string | user data that is serialized and restored from session |
Output |
IUser
| the user object |
Exception |
|
saveToString
public string saveToString |
() |
Output |
string
| user data that is serialized and will be stored in session |
Exception |
|
setIsGuest
public void setIsGuest |
(boolean $value ) |
Input |
boolean | $value | if the user is a guest |
Output |
Exception |
|
setName
public void setName |
(string $value ) |
Input |
string | $value | username |
Output |
Exception |
|
setRoles
public array|string setRoles |
(mixed $value ) |
Input |
mixed | $value | |
Output |
array|string
| list of roles that the user is of. If it is a string, roles are assumed by separated by comma |
Exception |
|