interface UserStorage

Interface for persistent storage for user object data.

Constants

LOGOUT_MANUAL

Log-out reason

LOGOUT_INACTIVITY

Log-out reason

Methods

void
saveAuthentication(IIdentity $identity)

Sets the authenticated state of user.

void
clearAuthentication(bool $clearIdentity)

Removed authenticated state of user.

array
getState()

Returns user authenticated state, identity and logout reason.

void
setExpiration(string|null $expire, bool $clearIdentity)

Enables log out from the persistent storage after inactivity (like '20 minutes').

Details

at line 26
void saveAuthentication(IIdentity $identity)

Sets the authenticated state of user.

Parameters

IIdentity $identity

Return Value

void

at line 31
void clearAuthentication(bool $clearIdentity)

Removed authenticated state of user.

Parameters

bool $clearIdentity

Return Value

void

at line 37
array getState()

Returns user authenticated state, identity and logout reason.

Return Value

array ?IIdentity, ?int}

at line 42
void setExpiration(string|null $expire, bool $clearIdentity)

Enables log out from the persistent storage after inactivity (like '20 minutes').

Parameters

string|null $expire
bool $clearIdentity

Return Value

void