interface IUserStorage

Interface for persistent storage for user object data.

Constants

MANUAL

Log-out reason IUserStorage::getLogoutReason()

INACTIVITY

Log-out reason IUserStorage::getLogoutReason()

BROWSER_CLOSED

Log-out reason IUserStorage::getLogoutReason()

CLEAR_IDENTITY

Log-out behavior

Methods

void
setAuthenticated($state)

Sets the authenticated status of this user.

bool
isAuthenticated()

Is this user authenticated?

void
setIdentity(IIdentity $identity = NULL)

Sets the user identity.

IIdentity|null
getIdentity()

Returns current user identity, if any.

void
setExpiration($time, $flags = 0)

Enables log out from the persistent storage after inactivity.

int
getLogoutReason()

Why was user logged out?

Details

at line 33
void setAuthenticated($state)

Sets the authenticated status of this user.

Parameters

$state

Return Value

void

at line 39
bool isAuthenticated()

Is this user authenticated?

Return Value

bool

at line 45
void setIdentity(IIdentity $identity = NULL)

Sets the user identity.

Parameters

IIdentity $identity

Return Value

void

at line 51
IIdentity|null getIdentity()

Returns current user identity, if any.

Return Value

IIdentity|null

at line 59
void setExpiration($time, $flags = 0)

Enables log out from the persistent storage after inactivity.

Parameters

$time
$flags

Return Value

void

at line 65
int getLogoutReason()

Why was user logged out?

Return Value

int