Spec-Zone.ru › Symfony 4.1
AbstractRememberMeServices абстрактный класс AbstractRememberMeServices реализует RememberMeServicesInterface , LogoutHandlerInterface
Базовый класс, реализующий RememberMeServicesInterface.
Константы Свойства 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
Исключения string
getRememberMeParameter()
Возвращает параметр, используемый для проверки запроса услуг "запомнить меня".
Значение возврата string
getSecret()
Значение возврата Реализация RememberMeServicesInterface. Определяет, был ли установлен cookie "запомнить меня", декодирует его и передает его подклассам для дальнейшей обработки.
Параметры Значение возврата Исключения Реализация LogoutHandlerInterface. Удаляет cookie.
Параметры final
loginFail(Request $request, Exception $exception = null)
Реализация RememberMeServicesInterface. Удаляет cookie при неудачной попытке аутентификации.
Параметры Реализация RememberMeServicesInterface. Вызывается при успешной аутентификации.
Параметры abstract protected UserInterface
processAutoLoginCookie(array $cookieParts, Request $request)
Подклассы должны валидировать cookie и выполнять любые дополнительные необходимые действия. Вызывается из autoLogin().
Параметры array $cookieParts Request $request
Значение возврата protected
onLoginFail(Request $request, Exception $exception = null)
Параметры abstract protected
onLoginSuccess(Request $request, Response $response, TokenInterface $token)
Вызывается после успешной аутентификации пользователя, и если он запросил опцию "запомнить меня". Реализация обычно устанавливает cookie и, возможно, сохраняет постоянную запись о нём.
Параметры final protected
getUserProvider($class)
Параметры protected array
decodeCookie(string $rawCookie)
Декодирует значение cookie.
Параметры Значение возврата protected string
encodeCookie(array $cookieParts)
Кодирует части cookie.
Параметры Значение возврата Исключения InvalidArgumentException При $cookieParts содержат разделитель cookie. Расширяющий класс должен либо удалить, либо экранировать его.
protected
cancelCookie(Request $request)
Удаляет cookie "запомнить меня".
Параметры protected bool
isRememberMeRequested(Request $request)
Проверяет, были ли запрошены возможности "запомнить меня".
Параметры Значение возврата