Interface

eZ\Publish\Core\MVC\Symfony\Security\Authentication\AuthenticatorInterface

interface AuthenticatorInterface

This interface is to be implemented by authenticator classes.

Authenticators are meant to be used to run authentication programmatically, i.e. outside the firewall context.

Methods

TokenInterface authenticate(Request $request)

Runs authentication against provided request and returns the authenticated security token.

Response logout(Request $request)

Performs logout by running configured logout handlers.

Details

at line 34
public TokenInterface authenticate(Request $request)

Runs authentication against provided request and returns the authenticated security token.

This method typically does: - The authentication by itself (i.e. matching a user) - User type checks (e.g. check user activation) - Inject authenticated token in the SecurityContext - (optional) Trigger SecurityEvents::INTERACTIVE_LOGIN event

Parameters

Request $request

Return Value

TokenInterface

Exceptions

AuthenticationException If any authentication issue occured.

at line 43
public Response logout(Request $request)

Performs logout by running configured logout handlers.

Parameters

Request $request

Return Value

Response