PersistentTokenBasedRememberMeServices
class PersistentTokenBasedRememberMeServices extends AbstractRememberMeServices
Конкретная реализация RememberMeServicesInterface, которая требует реализации TokenProviderInterface для предоставления возможностей remember-me.
Константы
| COOKIE_DELIMITER |
Методы
| __construct(array $userProviders, string $secret, string $providerKey, array $options = array(), LoggerInterface $logger = null) | из AbstractRememberMeServices | |
| string | getRememberMeParameter() Возвращает параметр, используемый для проверки, были ли запрошены службы remember-me. | из AbstractRememberMeServices |
| string | getSecret() | из AbstractRememberMeServices |
| TokenInterface | autoLogin(Request $request) Реализация RememberMeServicesInterface. Обнаруживает, был ли установлен cookie remember-me, декодирует его и передает его подклассам для дальнейшей обработки. | из AbstractRememberMeServices |
| logout(Request $request, Response $response, TokenInterface $token) Реализация для LogoutHandlerInterface. Удаляет cookie. | из AbstractRememberMeServices | |
| loginFail(Request $request, Exception $exception = null) Реализация для RememberMeServicesInterface. Удаляет cookie, когда попытка аутентификации завершается неудачей. | из AbstractRememberMeServices | |
| loginSuccess(Request $request, Response $response, TokenInterface $token) Реализация для RememberMeServicesInterface. Вызывается при успешной аутентификации. | из AbstractRememberMeServices | |
| setTokenProvider(TokenProviderInterface $tokenProvider) |
Подробности
__construct(array $userProviders, string $secret, string $providerKey, array $options = array(), LoggerInterface $logger = null)
Параметры
| array | $userProviders | |
| string | $secret | |
| string | $providerKey | |
| array | $options | |
| LoggerInterface | $logger |
Исключения
| InvalidArgumentException |
string getRememberMeParameter()
Возвращает параметр, используемый для проверки запроса сервисов "запомнить меня".
Значение, возвращаемое функцией
| string |
string getSecret()
Значение, возвращаемое функцией
| string |
final TokenInterface autoLogin(Request $request)
Реализация RememberMeServicesInterface. Определяет, был ли установлен куки "запомнить меня", декодирует его и передает подклассам для дальнейшей обработки.
Параметры
| Request | $request |
Значение, возвращаемое функцией
| TokenInterface |
Исключения
| CookieTheftException | |
| RuntimeException |
logout(Request $request, Response $response, TokenInterface $token)
Реализация для LogoutHandlerInterface. Удаляет куки.
Параметры
| Request | $request | |
| Response | $response | |
| TokenInterface | $token |
final loginFail(Request $request, Exception $exception = null)
Реализация для RememberMeServicesInterface. Удаляет куки при неудачной попытке аутентификации.
Параметры
| Request | $request | |
| Exception | $exception |
final loginSuccess(Request $request, Response $response, TokenInterface $token)
Реализация для RememberMeServicesInterface. Вызывается при успешной аутентификации.
Параметры
| Request | $request | |
| Response | $response | |
| TokenInterface | $token |
setTokenProvider(TokenProviderInterface $tokenProvider)
Параметры
| TokenProviderInterface | $tokenProvider |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.4/Symfony/Component/Security/Http/RememberMe/PersistentTokenBasedRememberMeServices.html
