Handler
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
Provides extensions to this object to integrate it with standard config API methods.
Methods
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
If required, enforce authentication for non-session authenticated requests. The Member returned from the authentication method will returned for use in the OperationResolver context.
Returns the first configured authenticator by highest priority, or null if none are configured
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
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
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. AuthenticatorInterface::authenticate.
AuthenticatorInterface|null
getAuthenticator(HTTPRequest $request)
Returns the first configured authenticator by highest priority, or null if none are configured
protected AuthenticatorInterface
buildAuthenticator(string $authenticator)
No description
void
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.