1. interface
  2. Symfony
  3. Component
  4. Security
  5. Core
  6. Authentication
  7. Provider
  8. AuthenticationProviderInterface

AuthenticationProviderInterface

interface AuthenticationProviderInterface implements AuthenticationManagerInterface

AuthenticationProviderInterface is the interface for all authentication providers.

Concrete implementations processes specific Token instances.

Methods

TokenInterface
authenticate(TokenInterface $token)

Attempts to authenticate a TokenInterface object.

from AuthenticationManagerInterface
bool
supports(TokenInterface $token)

Checks whether this provider supports the given token.

Details

in AuthenticationManagerInterface at line line 34
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 34
bool supports(TokenInterface $token)

Checks whether this provider supports the given token.

Parameters

TokenInterface $token A TokenInterface instance

Return Value

bool true if the implementation supports the Token, false otherwise