PersistentTokenBasedRememberMeServices

class PersistentTokenBasedRememberMeServices extends AbstractRememberMeServices

Конкретная реализация RememberMeServicesInterface, которая требует реализации TokenProviderInterface для предоставления возможностей remember-me.

Постоянные значения

COOKIE_DELIMITER

Свойства

protected	$logger		из AbstractRememberMeServices
protected	$options		из AbstractRememberMeServices

Методы

	__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
UserInterface	processAutoLoginCookie(array $cookieParts, Request $request) Подклассы должны валидировать cookie и выполнять любые дополнительные необходимые действия. Вызывается из autoLogin().
	onLoginFail(Request $request, Exception $exception = null)	из AbstractRememberMeServices
	onLoginSuccess(Request $request, Response $response, TokenInterface $token) Вызывается после успешного входа в систему пользователя, который запросил возможности remember-me. Реализация обычно устанавливает cookie и, возможно, сохраняет постоянную запись о нём.
	getUserProvider($class)	из AbstractRememberMeServices
array	decodeCookie(string $rawCookie) Декодирует значение сырого cookie.	из AbstractRememberMeServices
string	encodeCookie(array $cookieParts) Кодирует части cookie.	из AbstractRememberMeServices
	cancelCookie(Request $request) Удаляет cookie remember-me.
bool	isRememberMeRequested(Request $request) Проверяет, были ли запрошены возможности remember-me.	из 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, Exception $exception = null)

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

Параметры

Request	$request
Exception	$exception

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

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

Параметры

Request	$request
Response	$response
TokenInterface	$token

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

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

Параметры

array	$cookieParts
Request	$request

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

UserInterface

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

Параметры

Request	$request
Exception	$exception

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

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

Параметры

Request	$request
Response	$response
TokenInterface	$token

final protected getUserProvider($class)

Параметры

$class

protected array decodeCookie(string $rawCookie)

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

Параметры

string

$rawCookie

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

array

protected string encodeCookie(array $cookieParts)

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

Параметры

array

$cookieParts

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

string

Исключения

InvalidArgumentException

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

protected cancelCookie(Request $request)

Удаляет куки remember-me.

Параметры

Request

$request

protected bool isRememberMeRequested(Request $request)

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

Параметры

Request

$request

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

bool

setTokenProvider(TokenProviderInterface $tokenProvider)

Параметры

TokenProviderInterface

$tokenProvider

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