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

LogOutAuthenticationHandler

class LogOutAuthenticationHandler implements AuthenticationHandler (View source)

This is separate to LogInAuthenticationHandler so that it can be registered with Injector and called before the other AuthenticationHandler::logOut() implementations

Methods

public
Member|null
authenticateRequest(HTTPRequest $request)

No description

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

No description

public
logOut(HTTPRequest|null $request = null)

No description

Details

at line 25
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.

Exceptions

ValidationException

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

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

at line 44
logOut(HTTPRequest|null $request = null)

No description

Parameters

HTTPRequest|null $request

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

Exceptions

InvalidArgumentException