interface IUserStorage

Interface for persistent storage for user object data.

Constants

MANUAL

Log-out reason IUserStorage::getLogoutReason()

INACTIVITY

Log-out reason IUserStorage::getLogoutReason()

CLEAR_IDENTITY

Log-out behavior

deprecated BROWSER_CLOSED

Methods

setAuthenticated($state)

Sets the authenticated status of this user.

bool
isAuthenticated()

Is this user authenticated?

setIdentity(IIdentity $identity = null)

Sets the user identity.

IIdentity|null
getIdentity()

Returns current user identity, if any.

setExpiration($time, $flags = 0)

Enables log out from the persistent storage after inactivity.

int|null
getLogoutReason()

Why was user logged out?

Details

at line 32
IUserStorage setAuthenticated($state)

Sets the authenticated status of this user.

Parameters

$state

Return Value

IUserStorage

at line 38
bool isAuthenticated()

Is this user authenticated?

Return Value

bool

at line 44
IUserStorage setIdentity(IIdentity $identity = null)

Sets the user identity.

Parameters

IIdentity $identity

Return Value

IUserStorage

at line 50
IIdentity|null getIdentity()

Returns current user identity, if any.

Return Value

IIdentity|null

at line 58
IUserStorage setExpiration($time, $flags = 0)

Enables log out from the persistent storage after inactivity.

Parameters

$time
$flags

Return Value

IUserStorage

at line 64
int|null getLogoutReason()

Why was user logged out?

Return Value

int|null