PersistentTokenBasedRememberMeServices
class PersistentTokenBasedRememberMeServices extends AbstractRememberMeServices
Конкретная реализация RememberMeServicesInterface, которая требует реализации TokenProviderInterface для предоставления возможностей remember-me.
Постоянные данные
| COOKIE_DELIMITER |
Методы
| __construct(array $userProviders, string $secret, string $providerKey, array $options = array(), LoggerInterface $logger = null) Конструктор. | from AbstractRememberMeServices | |
| string | getRememberMeParameter() Возвращает параметр, используемый для проверки, были ли запрошены remember-me службы. | from AbstractRememberMeServices |
| string | getSecret() | from AbstractRememberMeServices |
| TokenInterface | autoLogin(Request $request) Реализация RememberMeServicesInterface. Определяет, был ли установлен куки remember-me, декодирует его и передает его подклассам для дальнейшей обработки. | from AbstractRememberMeServices |
| logout(Request $request, Response $response, TokenInterface $token) Реализация для LogoutHandlerInterface. Удаляет куки. | from AbstractRememberMeServices | |
| loginFail(Request $request) Реализация для RememberMeServicesInterface. Удаляет куки, когда попытка аутентификации завершается неудачей. | from AbstractRememberMeServices | |
| loginSuccess(Request $request, Response $response, TokenInterface $token) Реализация для RememberMeServicesInterface. Вызывается, когда аутентификация выполнена успешно. | from 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()
Возвращает параметр, используемый для проверки, были ли запрошены remember-me службы.
Значение результата
| string |
string getSecret()
Значение результата
| string |
final TokenInterface autoLogin(Request $request)
Реализация RememberMeServicesInterface. Определяет, был ли установлен куки remember-me, декодирует его и передает его подклассам для дальнейшей обработки.
Параметры
| Request | $request |
Значение результата
| TokenInterface |
Исключения
| CookieTheftException | |
| RuntimeException |
logout(Request $request, Response $response, TokenInterface $token)
Реализация для LogoutHandlerInterface. Удаляет куки.
Параметры
| Request | $request | |
| Response | $response | |
| TokenInterface | $token |
final loginFail(Request $request)
Реализация для RememberMeServicesInterface. Удаляет куки, когда попытка аутентификации завершается неудачей.
Параметры
| Request | $request |
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.1/Symfony/Component/Security/Http/RememberMe/PersistentTokenBasedRememberMeServices.html
