Spec-Zone.ru › Symfony 3.0

AbstractRememberMeServices

class AbstractRememberMeServices implements RememberMeServicesInterface, LogoutHandlerInterface

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

Константы

COOKIE_DELIMITER

Методы

__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)

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

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

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

Подробное описание

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

Параметры

Request $request

Значение результата

TokenInterface

Исключения

CookieTheftException
RuntimeException

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

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

Параметры

Request $request
Response $response
TokenInterface $token

final loginFail(Request $request)

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

Параметры

Request $request

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

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

Параметры

Request $request
Response $response
TokenInterface $token

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

Spec-Zone.ru

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