class RequestAuthenticationHandler implements AuthenticationHandler

Core authentication handler / store

Methods

$this
setHandlers(array $handlers)

Set an associative array of handlers

Member|null
authenticateRequest(HTTPRequest $request)

Given the current request, authenticate the request for non-session authorization (outside the CMS).

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

Log into the identity-store handlers attached to this request filter

logOut(HTTPRequest $request = null)

Log out of all the identity-store handlers attached to this request filter

Details

at line 33
$this setHandlers(array $handlers)

Set an associative array of handlers

Parameters

array $handlers

Return Value

$this

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

Given the current request, authenticate the request for non-session authorization (outside the CMS).

The Member returned from this method will be provided to the Manager for use in the OperationResolver context in place of the current CMS member.

Authenticators can be given a priority. In this case, the authenticator with the highest priority will be returned first. If not provided, it will default to a low number.

An example for configuring the BasicAuthAuthenticator:

SilverStripe\Security\Security: authentication_handlers: - SilverStripe\Security\BasicAuthentionHandler

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 If authentication data exists but does not match a member.

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

Log into the identity-store handlers attached to this request filter

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 75
logOut(HTTPRequest $request = null)

Log out of all the identity-store handlers attached to this request filter

Parameters

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