RememberMeToken
class RememberMeToken extends AbstractToken
Токен аутентификации для "Remember-Me".
Методы
| __construct(UserInterface $user, string $providerKey, string $secret) | ||
| Role[] | getRoles() Возвращает роли пользователя. | из AbstractToken |
| string | getUsername() Возвращает имя пользователя. | из AbstractToken |
| string|object | getUser() Возвращает представление пользователя. | из AbstractToken |
| setUser(string|object $user) Устанавливает пользователя в токен. | из AbstractToken | |
| bool | isAuthenticated() Возвращает, аутентифицирован ли пользователь или нет. | из AbstractToken |
| setAuthenticated($authenticated) Устанавливает флаг аутентификации. | ||
| eraseCredentials() Удаляет конфиденциальную информацию из токена. | из AbstractToken | |
| serialize() {@inheritdoc} | ||
| unserialize($serialized) {@inheritdoc} | ||
| array | getAttributes() Возвращает атрибуты токена. | из AbstractToken |
| setAttributes(array $attributes) Устанавливает атрибуты токена. | из AbstractToken | |
| bool | hasAttribute(string $name) Возвращает true, если атрибут существует. | из AbstractToken |
| mixed | getAttribute(string $name) Возвращает значение атрибута. | из AbstractToken |
| setAttribute(string $name, mixed $value) Устанавливает атрибут. | из AbstractToken | |
| string | __toString() Возвращает строковое представление токена. | из AbstractToken |
| string | getProviderKey() Возвращает секрет поставщика. | |
| string | getSecret() Возвращает секрет. | |
| mixed | getCredentials() Возвращает учетные данные пользователя. |
Подробности
__construct(UserInterface $user, string $providerKey, string $secret)
Параметры
| UserInterface | $user | |
| string | $providerKey | |
| string | $secret | Секрет, используемый для проверки того, что токен создан приложением, а не злонамеренным клиентом |
Исключения
| InvalidArgumentException |
Role[] getRoles()
Возвращает роли пользователя.
Значение
| Role[] | Массив экземпляров Role |
string getUsername()
Возвращает имя пользователя.
Значение
| string |
string|object getUser()
Возвращает представление пользователя.
Значение
| string|object | Может быть экземпляром UserInterface, объектом, реализующим метод __toString, или именем пользователя как обычной строкой |
setUser(string|object $user)
Устанавливает пользователя в токен.
Пользователь может быть экземпляром UserInterface или объектом, реализующим метод __toString, или именем пользователя как обычной строкой.
Параметры
| string|object | $user | Пользователь |
Исключения
| InvalidArgumentException |
bool isAuthenticated()
Возвращает, аутентифицирован ли пользователь или нет.
Значение
| bool | true, если токен аутентифицирован, false в противном случае |
setAuthenticated($authenticated)
Устанавливает флаг аутентификации.
Параметры
| $authenticated |
eraseCredentials()
Удаляет конфиденциальную информацию из токена.
serialize()
{@inheritdoc}
unserialize($serialized)
{@inheritdoc}
Параметры
| $serialized |
array getAttributes()
Возвращает атрибуты токена.
Значение
| array | Атрибуты токена |
setAttributes(array $attributes)
Устанавливает атрибуты токена.
Параметры
| array | $attributes | Атрибуты токена |
bool hasAttribute(string $name)
Возвращает true, если атрибут существует.
Параметры
| string | $name | Имя атрибута |
Значение
| bool | true, если атрибут существует, false в противном случае |
mixed getAttribute(string $name)
Возвращает значение атрибута.
Параметры
| string | $name | Имя атрибута |
Значение
| mixed | Значение атрибута |
Исключения
| InvalidArgumentException | Если атрибут не существует для данного токена |
setAttribute(string $name, mixed $value)
Устанавливает атрибут.
Параметры
| string | $name | Имя атрибута |
| mixed | $value | Значение атрибута |
string __toString()
Возвращает строковое представление токена.
Это используется только для отладки.
Значение
| string |
string getProviderKey()
Возвращает секрет поставщика.
Значение
| string | Секрет поставщика |
string getSecret()
Возвращает секрет.
Значение
| string |
mixed getCredentials()
Возвращает учетные данные пользователя.
Значение
| mixed | Учетные данные пользователя |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Security/Core/Authentication/Token/RememberMeToken.html