AuthenticationProviderInterface
extends
AuthenticationManagerInterface
in
AuthenticationProviderInterface is the interface for all authentication providers.
Concrete implementations processes specific Token instances.
Tags
Table of Contents
- USERNAME_NONE_PROVIDED = 'NONE_PROVIDED'
- Use this constant for not provided username.
- authenticate() : TokenInterface
- Attempts to authenticate a TokenInterface object.
- supports() : bool
- Checks whether this provider supports the given token.
Constants
USERNAME_NONE_PROVIDED
Use this constant for not provided username.
public
string
USERNAME_NONE_PROVIDED
= 'NONE_PROVIDED'
Methods
authenticate()
Attempts to authenticate a TokenInterface object.
public
authenticate(TokenInterface $token) : TokenInterface
Parameters
- $token : TokenInterface
Tags
Return values
TokenInterface —An authenticated TokenInterface instance, never null
supports()
Checks whether this provider supports the given token.
public
supports(TokenInterface $token) : bool
Parameters
- $token : TokenInterface
Return values
bool —true if the implementation supports the Token, false otherwise