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