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