class Handler (View source)

The authentication Handler is responsible for handling authentication requirements and providing a Member to the Manager if required, so it can be used in request contexts.

Traits

Configurable

Methods

Member|false
requireAuthentication(HTTPRequest $request)

If required, enforce authentication for non-session authenticated requests. The Member returned from the authentication method will returned for use in the OperationResolver context.

getAuthenticator(HTTPRequest $request)

Returns the first configured authenticator by highest priority, or null if none are configured

prioritiseAuthenticators(array $authenticators)

Sort the configured authenticators by their "priority" (highest to lowest). This allows modules to contribute to the decision of which authenticator should be used first. Users can rewrite this in their own configuration if necessary.

Details

Member|false requireAuthentication(HTTPRequest $request)

If required, enforce authentication for non-session authenticated requests. The Member returned from the authentication method will returned for use in the OperationResolver context.

Authenticators are defined in configuration. see AuthenticatorInterface::authenticate.

Parameters

HTTPRequest $request

Return Value

Member|false

If authentication was successful the Member is returned. False if no authenticators are configured.

Exceptions

ValidationException

If authentication is attempted and fails

null|AuthenticatorInterface getAuthenticator(HTTPRequest $request)

Returns the first configured authenticator by highest priority, or null if none are configured

Parameters

HTTPRequest $request

Return Value

null|AuthenticatorInterface

prioritiseAuthenticators(array $authenticators)

Sort the configured authenticators by their "priority" (highest to lowest). This allows modules to contribute to the decision of which authenticator should be used first. Users can rewrite this in their own configuration if necessary.

Parameters

array $authenticators