PostAuthenticationGuardToken
class PostAuthenticationGuardToken extends AbstractToken implements GuardTokenInterface
Используется в качестве токена "аутентифицированного" пользователя, хотя позже может быть установлен как неаутентифицированный.
Если вы используете аутентификацию Guard, вы обязаны использовать класс, реализующий GuardTokenInterface, в качестве аутентифицированного токена (например, этот класс).
Методы
| __construct(UserInterface $user, string $providerKey, array $roles) | ||
| Role[] | getRoles() Возвращает роли пользователя. | из AbstractToken |
| string | getUsername() Возвращает имя пользователя. | из AbstractToken |
| mixed | getUser() Возвращает представление пользователя. | из AbstractToken |
| setUser(mixed $user) Устанавливает пользователя в токен. | из AbstractToken | |
| bool | isAuthenticated() Возвращает, аутентифицирован ли пользователь или нет. | из AbstractToken |
| setAuthenticated($authenticated) Устанавливает флаг аутентификации. | из AbstractToken | |
| 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 |
| mixed | getCredentials() Предполагается, что это токен только для аутентифицированных пользователей, где данные аутентификации уже использовались и, следовательно, очищены. | |
| string | getProviderKey() Возвращает ключ поставщика (брандмауэра). |
Подробности
__construct(UserInterface $user, string $providerKey, array $roles)
Параметры
| UserInterface | $user | Пользователь! |
| string | $providerKey | Ключ провайдера (брандмауэра) |
| array | $roles | Массив ролей |
Исключения
| InvalidArgumentException |
Role[] getRoles()
Возвращает роли пользователя.
Значение возврата
| Role[] | Массив экземпляров Role |
string getUsername()
Возвращает имя пользователя.
Значение возврата
| string |
mixed getUser()
Возвращает представление пользователя.
Значение возврата
| mixed | Может быть экземпляром UserInterface, объектом, реализующим метод __toString, или именем пользователя как обычной строкой |
setUser(mixed $user)
Устанавливает пользователя в токен.
Пользователь может быть экземпляром UserInterface или объектом, реализующим метод __toString, или именем пользователя как обычной строкой.
Параметры
| mixed | $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 |
mixed getCredentials()
Предназначен только для аутентифицированного токена, где учетные данные уже использовались и поэтому очищены.
{@inheritdoc}
Значение возврата
| mixed | Учетные данные пользователя |
string getProviderKey()
Возвращает ключ провайдера (брандмауэра).
Значение возврата
| string |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Security/Guard/Token/PostAuthenticationGuardToken.html
