1. class
  2. SilverStripe
  3. \
  4. Security
  5. \
  6. MemberAuthenticator
  7. \
  8. SessionAuthenticationHandler

SessionAuthenticationHandler

class SessionAuthenticationHandler implements AuthenticationHandler (View source)

Authenticate a member passed on a session cookie

Methods

string
getSessionVariable()

Get the session variable name used to track member ID

setSessionVariable(string $sessionVariable)

Set the session variable name used to track member ID

Member|null
authenticateRequest(HTTPRequest $request)

No description

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

No description

logOut(HTTPRequest $request = null)

No description

Details

at line 27
string getSessionVariable()

Get the session variable name used to track member ID

Return Value

string

at line 37
setSessionVariable(string $sessionVariable)

Set the session variable name used to track member ID

Parameters

string $sessionVariable

at line 46
Member|null authenticateRequest(HTTPRequest $request)

Parameters

HTTPRequest $request

The current HTTP request

Return Value

Member|null

The authenticated Member, or null if this auth mechanism isn't used.

at line 71
logIn(Member $member, bool $persistent = false, HTTPRequest $request = null)

Parameters

Member $member

The member to log in.
bool $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 112
logOut(HTTPRequest $request = null)

Parameters

HTTPRequest $request

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