UserAuthenticationProvider
abstract class UserAuthenticationProvider implements AuthenticationProviderInterface
UserProviderInterface извлекает пользователей для токенов UsernamePasswordToken.
Методы
| __construct(UserCheckerInterface $userChecker, string $providerKey, bool $hideUserNotFoundExceptions = true) | ||
| TokenInterface | authenticate(TokenInterface $token) Попытка аутентификации объекта TokenInterface. | |
| bool | supports(TokenInterface $token) Проверка поддержки данного токена этим провайдером. | |
| UserInterface | retrieveUser(string $username, UsernamePasswordToken $token) Извлечение пользователя из места, специфичного для реализации. | |
| checkAuthentication(UserInterface $user, UsernamePasswordToken $token) Выполнение дополнительных проверок пользователя и токена (например, валидации учетных данных). |
Подробности
__construct(UserCheckerInterface $userChecker, string $providerKey, bool $hideUserNotFoundExceptions = true)
Параметры
| UserCheckerInterface | $userChecker | |
| string | $providerKey | |
| bool | $hideUserNotFoundExceptions |
Исключения
| InvalidArgumentException |
TokenInterface authenticate(TokenInterface $token)
Попытка аутентификации объекта TokenInterface.
Параметры
| TokenInterface | $token | Экземпляр TokenInterface для аутентификации |
Возвращаемое значение
| TokenInterface | Аутентифицированный объект TokenInterface, никогда не null |
Исключения
| AuthenticationException | если аутентификация не удалась |
bool supports(TokenInterface $token)
Проверка поддержки данного токена этим провайдером.
Параметры
| TokenInterface | $token |
Возвращаемое значение
| bool | true, если реализация поддерживает токен, иначе false |
abstract protected UserInterface retrieveUser(string $username, UsernamePasswordToken $token)
Извлечение пользователя из места, специфичного для реализации.
Параметры
| string | $username | Имя пользователя для извлечения |
| UsernamePasswordToken | $token | Токен |
Возвращаемое значение
| UserInterface | Пользователь |
Исключения
| AuthenticationException | если учетные данные не удалось проверить |
abstract protected checkAuthentication(UserInterface $user, UsernamePasswordToken $token)
Выполнение дополнительных проверок пользователя и токена (например, валидации учетных данных).
Параметры
| UserInterface | $user | |
| UsernamePasswordToken | $token |
Исключения
| AuthenticationException | если учетные данные не удалось проверить |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Security/Core/Authentication/Provider/UserAuthenticationProvider.html
