1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. Security
  7. \
  8. Guard
  9. \
  10. Provider
  11. \
  12. GuardAuthenticationProvider

GuardAuthenticationProvider

class GuardAuthenticationProvider implements AuthenticationProviderInterface

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

Methods

__construct(iterable|AuthenticatorInterface[] $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

__construct(iterable|AuthenticatorInterface[] $guardAuthenticators, UserProviderInterface $userProvider, string $providerKey, UserCheckerInterface $userChecker)

Parameters

iterable|AuthenticatorInterface[] $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

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

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