Interface IUser

IUser interface.

This interface must be implemented by user objects.

Method Summary
boolean	getIsGuest ()
string	getName ()
array	getRoles ()
boolean	isInRole ( string $role)
IUser	loadFromString ( string $string)
string	saveToString ()
void	setIsGuest ( boolean $value)
void	setName ( string $value)
array\|string	setRoles ( mixed $value)

Method Details

getIsGuest

public boolean getIsGuest

()

Output
boolean	if the user is a guest
Exception

public string getName

()

Output
string	username
Exception

public array getRoles

()

Output
array	list of roles that the user is of
Exception

public boolean isInRole

(string $role )

Input
string	$role	role to be tested
Output
boolean	whether the user is of this role
Exception

public IUser loadFromString

(string $string )

Input
string	$string	user data that is serialized and restored from session
Output
IUser	the user object
Exception

public string saveToString

()

Output
string	user data that is serialized and will be stored in session
Exception

public void setIsGuest

(boolean $value )

public void setName

(string $value )

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