Интерфейс Token
интерфейс TokenInterface реализует Serializable
TokenInterface — это интерфейс для информации об аутентификации пользователя.
Методы
| string | __toString() Возвращает строковое представление токена. | |
| RoleInterface[] | getRoles() Возвращает роли пользователя. | |
| mixed | getCredentials() Возвращает учетные данные пользователя. | |
| mixed | getUser() Возвращает представление пользователя. | |
| setUser(mixed $user) Устанавливает пользователя. | ||
| string | getUsername() Возвращает имя пользователя. | |
| bool | isAuthenticated() Возвращает, аутентифицирован ли пользователь или нет. | |
| setAuthenticated(bool $isAuthenticated) Устанавливает флаг аутентификации. | ||
| eraseCredentials() Удаляет конфиденциальную информацию из токена. | ||
| array | getAttributes() Возвращает атрибуты токена. | |
| setAttributes(array $attributes) Устанавливает атрибуты токена. | ||
| bool | hasAttribute(string $name) Возвращает true, если атрибут существует. | |
| mixed | getAttribute(string $name) Возвращает значение атрибута. | |
| setAttribute(string $name, mixed $value) Устанавливает атрибут. |
Подробности
string __toString()
Возвращает строковое представление токена.
Используется только для отладки.
Значение, возвращаемое методом
| string |
RoleInterface[] getRoles()
Возвращает роли пользователя.
Значение, возвращаемое методом
| RoleInterface[] | Массив экземпляров RoleInterface |
mixed getCredentials()
Возвращает учетные данные пользователя.
Значение, возвращаемое методом
| mixed | Учетные данные пользователя |
mixed getUser()
Возвращает представление пользователя.
Значение, возвращаемое методом
| mixed | Может быть экземпляром UserInterface, объектом, реализующим метод __toString, или именем пользователя как обычной строкой |
См. также
| AbstractToken::setUser() |
setUser(mixed $user)
Устанавливает пользователя.
Параметры
| mixed | $user |
string getUsername()
Возвращает имя пользователя.
Значение, возвращаемое методом
| string |
bool isAuthenticated()
Возвращает, аутентифицирован ли пользователь или нет.
Значение, возвращаемое методом
| bool | true, если токен аутентифицирован, иначе false |
setAuthenticated(bool $isAuthenticated)
Устанавливает флаг аутентификации.
Параметры
| bool | $isAuthenticated | Флаг аутентификации |
eraseCredentials()
Удаляет конфиденциальную информацию из токена.
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 | Значение атрибута |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Security/Core/Authentication/Token/TokenInterface.html