interface AuthenticationProviderInterface implements AuthenticationManagerInterface

AuthenticationProviderInterface is the interface for all authentication providers.

Concrete implementations processes specific Token instances.

Constants

USERNAME_NONE_PROVIDED

Use this constant for not provided username.

Methods

authenticate(TokenInterface $token)

Attempts to authenticate a TokenInterface object.

bool
supports(TokenInterface $token)

Checks whether this provider supports the given token.

Details

TokenInterface authenticate(TokenInterface $token)

Attempts to authenticate a TokenInterface object.

Parameters

TokenInterface $token The TokenInterface instance to authenticate

Return Value

TokenInterface An authenticated TokenInterface instance, never null

Exceptions

AuthenticationException if the authentication fails

at line line 39
bool supports(TokenInterface $token)

Checks whether this provider supports the given token.

Parameters

TokenInterface $token

Return Value

bool true if the implementation supports the Token, false otherwise