Spec-Zone.ru › Symfony 4.1 TokenBasedRememberMeServices class TokenBasedRememberMeServices extends AbstractRememberMeServices
Конкретная реализация интерфейса RememberMeServicesInterface, предоставляющая возможности remember-me без необходимости использования TokenProvider.
Постоянные значения Свойства Методы __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.
из AbstractRememberMeServices bool isRememberMeRequested (Request $request) Проверяет, были ли запрошены возможности remember-me.
из AbstractRememberMeServices string generateCookieValue (string $class, string $username, int $expires, string $password) Генерирует значение cookie.
string generateCookieHash (string $class, string $username, int $expires, string $password) Генерирует хеш для cookie, чтобы убедиться, что он не был изменён.
Детали
__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()
Возвращает параметр, используемый для проверки запроса услуг remember-me.
Возвращаемое значение string
getSecret()
Возвращаемое значение Реализация RememberMeServicesInterface. Определяет, установлен ли куки remember-me, декодирует его и передает его подклассам для дальнейшей обработки.
Параметры Возвращаемое значение Исключения Реализация для LogoutHandlerInterface. Удаляет куки.
Параметры final
loginFail(Request $request, Exception $exception = null)
Реализация для RememberMeServicesInterface. Удаляет куки при неудачной попытке аутентификации.
Параметры Реализация для RememberMeServicesInterface. Вызывается при успешной аутентификации.
Параметры protected UserInterface
processAutoLoginCookie(array $cookieParts, Request $request)
Подклассы должны валидировать куки и выполнять все дополнительные необходимые действия. Вызывается из autoLogin().
Параметры array $cookieParts Request $request
Возвращаемое значение protected
onLoginFail(Request $request, Exception $exception = null)
Параметры Вызывается после успешной авторизации пользователя и запроса возможностей remember-me. Реализация обычно устанавливает куки и, возможно, сохраняет постоянную запись о нём.
Параметры final protected
getUserProvider($class)
Параметры protected array
decodeCookie(string $rawCookie)
Декодирует значение куки.
Параметры Возвращаемое значение protected string
encodeCookie(array $cookieParts)
Кодирует части куки.
Параметры Возвращаемое значение Исключения InvalidArgumentException Когда $cookieParts содержат разделитель куки. Расширяющий класс должен либо удалить его, либо экранировать.
protected
cancelCookie(Request $request)
Удаляет куки remember-me.
Параметры protected bool
isRememberMeRequested(Request $request)
Проверяет, были ли запрошены возможности remember-me.
Параметры Возвращаемое значение protected string
generateCookieValue(string $class, string $username, int $expires, string $password)
Генерирует значение куки.
Параметры string $class string $username Имя пользователя int $expires Маркер Unix, когда куки истекает string $password Закодированный пароль
Возвращаемое значение protected string
generateCookieHash(string $class, string $username, int $expires, string $password)
Генерирует хеш для куки, чтобы убедиться, что она не подделана.
Параметры строка $class строка $username Имя пользователя целое число $expires Маркер времени Unix, когда куки истекает строка $password Закодированный пароль
Возвращаемое значение
