UserAuthenticationProvider
class UserAuthenticationProvider implements AuthenticationProviderInterface
UserProviderInterface retrieves users for UsernamePasswordToken tokens.
Methods
__construct(UserCheckerInterface $userChecker, string $providerKey, bool $hideUserNotFoundExceptions = true) | ||
TokenInterface | authenticate(TokenInterface $token) Attempts to authenticate a TokenInterface object. | |
bool | supports(TokenInterface $token) Checks whether this provider supports the given token. |
Details
__construct(UserCheckerInterface $userChecker, string $providerKey, bool $hideUserNotFoundExceptions = true)
Parameters
UserCheckerInterface | $userChecker | An UserCheckerInterface interface |
string | $providerKey | A provider key |
bool | $hideUserNotFoundExceptions | Whether to hide user not found exception or not |
Exceptions
InvalidArgumentException |
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 |
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 |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Security/Core/Authentication/Provider/UserAuthenticationProvider.html