GuardTokenInterface
интерфейс GuardTokenInterface реализует TokenInterface
Маркерный интерфейс, который реализуют оба токена стражи.
Любые токены, передаваемые в GuardAuthenticationProvider (т. е. любые токены, которые обрабатываются системой проверки подлинности стражи), должны реализовывать этот интерфейс.
Методы
| string | __toString() Возвращает строковое представление токена. | из TokenInterface |
| RoleInterface[] | getRoles() Возвращает роли пользователя. | из TokenInterface |
| mixed | getCredentials() Возвращает учетные данные пользователя. | из TokenInterface |
| mixed | getUser() Возвращает представление пользователя. | из TokenInterface |
| setUser(mixed $user) Устанавливает пользователя. | из TokenInterface | |
| string | getUsername() Возвращает имя пользователя. | из TokenInterface |
| bool | isAuthenticated() Возвращает, аутентифицирован ли пользователь или нет. | из TokenInterface |
| setAuthenticated(bool $isAuthenticated) Устанавливает флаг аутентификации. | из TokenInterface | |
| eraseCredentials() Удаляет конфиденциальную информацию из токена. | из TokenInterface | |
| array | getAttributes() Возвращает атрибуты токена. | из TokenInterface |
| setAttributes(array $attributes) Устанавливает атрибуты токена. | из TokenInterface | |
| bool | hasAttribute(string $name) Возвращает true, если атрибут существует. | из TokenInterface |
| mixed | getAttribute(string $name) Возвращает значение атрибута. | из TokenInterface |
| setAttribute(string $name, mixed $value) Устанавливает атрибут. | из TokenInterface |
Подробности
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/2.8/Symfony/Component/Security/Guard/Token/GuardTokenInterface.html
