interface IdentityStore

Represents an authentication handler that can have identities logged into & out of it.

For example, SessionAuthenticationHandler is an IdentityStore (as we can write a new member to it) but BasicAuthAuthenticationHandler is not (as it's up to the browser to handle log-in / log-out)

Methods

logIn(Member $member, Boolean $persistent = false, HTTPRequest $request = null)

Log the given member into this identity store.

logOut(HTTPRequest $request = null)

Log any logged-in member out of this identity store.

Details

at line 22
logIn(Member $member, Boolean $persistent = false, HTTPRequest $request = null)

Log the given member into this identity store.

Parameters

Member $member The member to log in.
Boolean $persistent boolean If set to true, the login may persist beyond the current session.
HTTPRequest $request The request of the visitor that is logging in, to get, for example, cookies.

at line 29
logOut(HTTPRequest $request = null)

Log any logged-in member out of this identity store.

Parameters

HTTPRequest $request The request of the visitor that is logging out, to get, for example, cookies.