1. class
  2. SilverStripe
  3. \
  4. SessionManager
  5. \
  6. Security
  7. \
  8. LogInAuthenticationHandler

LogInAuthenticationHandler

class LogInAuthenticationHandler implements AuthenticationHandler (View source)

This is separate to LogOutAuthenticationHandler so that it can be registered with Injector and called after the other AuthenticationHandler::logIn() implementations

Methods

public
string
getSessionVariable()

No description

public
void
setSessionVariable(string $sessionVariable)

No description

public
RememberLoginHash|null
getRememberLoginHash()

No description

public
setRememberLoginHash(RememberLoginHash $rememberLoginHash)

No description

public
Member|null
authenticateRequest(HTTPRequest $request)

No description

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

No description

public
logOut(HTTPRequest $request = null)

No description

Details

at line 33
string getSessionVariable()

No description

Return Value

string

at line 42
void setSessionVariable(string $sessionVariable)

No description

Parameters

string $sessionVariable

Return Value

void

at line 50
RememberLoginHash|null getRememberLoginHash()

No description

Return Value

RememberLoginHash|null

at line 58
setRememberLoginHash(RememberLoginHash $rememberLoginHash)

No description

Parameters

RememberLoginHash $rememberLoginHash

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

No description

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 78
logIn(Member $member, bool $persistent = false, HTTPRequest $request = null)

No description

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.

Exceptions

InvalidArgumentException

at line 111
logOut(HTTPRequest $request = null)

No description

Parameters

HTTPRequest $request

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