AbstractToken
class AbstractToken implements TokenInterface
Базовый класс для экземпляров токенов.
Методы
| __construct(array $roles = array()) Конструктор. | ||
| RoleInterface[] | getRoles() Возвращает роли пользователя. | |
| string | getUsername() Возвращает имя пользователя. | |
| mixed | getUser() Возвращает представление пользователя. | |
| setUser(mixed $user) Устанавливает пользователя в токене. | ||
| bool | isAuthenticated() Возвращает, аутентифицирован ли пользователь. | |
| setAuthenticated($authenticated) Устанавливает флаг аутентификации. | ||
| eraseCredentials() Удаляет конфиденциальную информацию из токена. | ||
| serialize() {@inheritdoc} | ||
| unserialize($serialized) {@inheritdoc} | ||
| array | getAttributes() Возвращает атрибуты токена. | |
| setAttributes(array $attributes) Устанавливает атрибуты токена. | ||
| bool | hasAttribute(string $name) Возвращает true, если атрибут существует. | |
| mixed | getAttribute(string $name) Возвращает значение атрибута. | |
| setAttribute(string $name, mixed $value) Устанавливает атрибут. | ||
| string | __toString() Возвращает строковое представление токена. |
Подробное описание
__construct(array $roles = array())
Конструктор.
Параметры
| 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 |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.1/Symfony/Component/Security/Core/Authentication/Token/AbstractToken.html