1. class
  2. Symfony
  3. Component
  4. Security
  5. Guard
  6. Provider
  7. GuardAuthenticationProvider

GuardAuthenticationProvider

class GuardAuthenticationProvider implements AuthenticationProviderInterface

Responsible for accepting the PreAuthenticationGuardToken and calling the correct authenticator to retrieve the authenticated token.

Methods

__construct(array $guardAuthenticators, UserProviderInterface $userProvider, string $providerKey, UserCheckerInterface $userChecker)

No description

TokenInterface
authenticate(TokenInterface $token)

Finds the correct authenticator for the token and calls it.

bool
supports(TokenInterface $token)

Checks whether this provider supports the given token.

Details

at line line 49
__construct(array $guardAuthenticators, UserProviderInterface $userProvider, string $providerKey, UserCheckerInterface $userChecker)

Parameters

array $guardAuthenticators The authenticators, with keys that match what's passed to GuardAuthenticationListener
UserProviderInterface $userProvider The user provider
string $providerKey The provider (i.e. firewall) key
UserCheckerInterface $userChecker

at line line 64
TokenInterface authenticate(TokenInterface $token)

Finds the correct authenticator for the token and calls it.

Parameters

TokenInterface $token The TokenInterface instance to authenticate

Return Value

TokenInterface An authenticated TokenInterface instance, never null

at line line 144
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