PostAuthenticationGuardToken
class PostAuthenticationGuardToken extends AbstractToken implements GuardTokenInterface
Используется в качестве токена "аутентифицированного" пользователя, хотя позже его можно установить в состояние "неаутентифицированного".
Если вы используете аутентификацию Guard, вы обязательно должны использовать класс, реализующий GuardTokenInterface, как токен аутентифицированного пользователя (например, этот класс).
Методы
| __construct(UserInterface $user, string $providerKey, array $roles) | ||
| RoleInterface[] | getRoles() Возвращает роли пользователя. | from AbstractToken |
| string | getUsername() Возвращает имя пользователя. | from AbstractToken |
| mixed | getUser() Возвращает представление пользователя. | from AbstractToken |
| setUser(mixed $user) Устанавливает пользователя в токен. | from AbstractToken | |
| bool | isAuthenticated() Возвращает, аутентифицирован ли пользователь или нет. | from AbstractToken |
| setAuthenticated($authenticated) Устанавливает флаг аутентификации. | from AbstractToken | |
| eraseCredentials() Удаляет конфиденциальную информацию из токена. | from AbstractToken | |
| serialize() {@inheritdoc} | ||
| unserialize($serialized) {@inheritdoc} | ||
| array | getAttributes() Возвращает атрибуты токена. | from AbstractToken |
| setAttributes(array $attributes) Устанавливает атрибуты токена. | from AbstractToken | |
| bool | hasAttribute(string $name) Возвращает true, если атрибут существует. | from AbstractToken |
| mixed | getAttribute(string $name) Возвращает значение атрибута. | from AbstractToken |
| setAttribute(string $name, mixed $value) Устанавливает атрибут. | from AbstractToken | |
| string | __toString() Возвращает строковое представление токена. | from AbstractToken |
| mixed | getCredentials() Предполагается, что это только аутентифицированный токен, где учетные данные уже использованы и, следовательно, очищены. | |
| string | getProviderKey() Возвращает ключ провайдера (файрвола). |
Детали
__construct(UserInterface $user, string $providerKey, array $roles)
Параметры
| UserInterface | $user | Пользователь! |
| string | $providerKey | Ключ поставщика (брандмауэра) |
| array | $roles | Массив ролей |
Исключения
| InvalidArgumentException |
RoleInterface[] getRoles()
Возвращает роли пользователя.
Значение возврата
| RoleInterface[] | Массив экземпляров RoleInterface |
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/3.4/Symfony/Component/Security/Guard/Token/PostAuthenticationGuardToken.html
