Spec-Zone.ru › Symfony 4.1

AbstractRememberMeServices

абстрактный класс AbstractRememberMeServices реализует RememberMeServicesInterface, LogoutHandlerInterface

Базовый класс, реализующий RememberMeServicesInterface.

Константы

COOKIE_DELIMITER

Свойства

protected $logger
protected $options

Методы

__construct(array $userProviders, string $secret, string $providerKey, array $options = array(), LoggerInterface $logger = null)
string getRememberMeParameter()

Возвращает параметр, используемый для проверки, были ли запрошены remember-me сервисы.

string getSecret()
TokenInterface autoLogin(Request $request)

Реализация RememberMeServicesInterface. Обнаруживает, был ли установлен cookie remember-me, декодирует его и передает его подклассам для дальнейшей обработки.

logout(Request $request, Response $response, TokenInterface $token)

Реализация для LogoutHandlerInterface. Удаляет cookie.

loginFail(Request $request, Exception $exception = null)

Реализация для RememberMeServicesInterface. Удаляет cookie, когда попытка аутентификации завершается ошибкой.

loginSuccess(Request $request, Response $response, TokenInterface $token)

Реализация для RememberMeServicesInterface. Вызывается, когда аутентификация прошла успешно.

UserInterface processAutoLoginCookie(array $cookieParts, Request $request)

Подклассы должны валидировать cookie и выполнять любые дополнительные необходимые действия. Вызывается из autoLogin().

onLoginFail(Request $request, Exception $exception = null)
onLoginSuccess(Request $request, Response $response, TokenInterface $token)

Вызывается после успешной авторизации пользователя и запроса функций remember-me. Реализация обычно устанавливает cookie и, возможно, сохраняет постоянную запись о нём.

getUserProvider($class)
array decodeCookie(string $rawCookie)

Декодирует значение raw cookie.

string encodeCookie(array $cookieParts)

Кодирует части cookie.

cancelCookie(Request $request)

Удаляет cookie remember-me.

bool isRememberMeRequested(Request $request)

Проверяет, были ли запрошены возможности remember-me.

Подробности

__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. Определяет, был ли установлен cookie "запомнить меня", декодирует его и передает его подклассам для дальнейшей обработки.

Параметры

Request $request

Значение возврата

TokenInterface

Исключения

CookieTheftException
RuntimeException

logout(Request $request, Response $response, TokenInterface $token)

Реализация LogoutHandlerInterface. Удаляет cookie.

Параметры

Request $request
Response $response
TokenInterface $token

final loginFail(Request $request, Exception $exception = null)

Реализация RememberMeServicesInterface. Удаляет cookie при неудачной попытке аутентификации.

Параметры

Request $request
Exception $exception

final loginSuccess(Request $request, Response $response, TokenInterface $token)

Реализация RememberMeServicesInterface. Вызывается при успешной аутентификации.

Параметры

Request $request
Response $response
TokenInterface $token

abstract protected UserInterface processAutoLoginCookie(array $cookieParts, Request $request)

Подклассы должны валидировать cookie и выполнять любые дополнительные необходимые действия. Вызывается из autoLogin().

Параметры

array $cookieParts
Request $request

Значение возврата

UserInterface

protected onLoginFail(Request $request, Exception $exception = null)

Параметры

Request $request
Exception $exception

abstract protected onLoginSuccess(Request $request, Response $response, TokenInterface $token)

Вызывается после успешной аутентификации пользователя, и если он запросил опцию "запомнить меня". Реализация обычно устанавливает cookie и, возможно, сохраняет постоянную запись о нём.

Параметры

Request $request
Response $response
TokenInterface $token

final protected getUserProvider($class)

Параметры

$class

protected array decodeCookie(string $rawCookie)

Декодирует значение cookie.

Параметры

string $rawCookie

Значение возврата

array

protected string encodeCookie(array $cookieParts)

Кодирует части cookie.

Параметры

array $cookieParts

Значение возврата

string

Исключения

InvalidArgumentException При $cookieParts содержат разделитель cookie. Расширяющий класс должен либо удалить, либо экранировать его.

protected cancelCookie(Request $request)

Удаляет cookie "запомнить меня".

Параметры

Request $request

protected bool isRememberMeRequested(Request $request)

Проверяет, были ли запрошены возможности "запомнить меня".

Параметры

Request $request

Значение возврата

bool

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Security/Http/RememberMe/AbstractRememberMeServices.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API