1. class
  2. Symfony
  3. Component
  4. Security
  5. Core
  6. Authentication
  7. Provider
  8. UserAuthenticationProvider

UserAuthenticationProvider

class UserAuthenticationProvider implements AuthenticationProviderInterface

UserProviderInterface retrieves users for UsernamePasswordToken tokens.

Methods

__construct(UserCheckerInterface $userChecker, string $providerKey, bool $hideUserNotFoundExceptions = true)

Constructor.

TokenInterface
authenticate(TokenInterface $token)

Attempts to authenticate a TokenInterface object.

bool
supports(TokenInterface $token)

Checks whether this provider supports the given token.

Details

at line line 44
__construct(UserCheckerInterface $userChecker, string $providerKey, bool $hideUserNotFoundExceptions = true)

Constructor.

Parameters

UserCheckerInterface $userChecker An UserCheckerInterface interface
string $providerKey A provider key
bool $hideUserNotFoundExceptions Whether to hide user not found exception or not

Exceptions

InvalidArgumentException

at line line 58
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 105
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