PreAuthenticationGuardToken
class PreAuthenticationGuardToken extends AbstractToken implements GuardTokenInterface
Токен, используемый системой аутентификации стражи перед аутентификацией.
GuardAuthenticationListener создает его, который затем немедленно потребляется GuardAuthenticationProvider. Если аутентификация успешна, возвращается другой аутентифицированный токен.
Методы
| __construct(mixed $credentials, string $guardProviderKey) | ||
| RoleInterface[] | getRoles() Возвращает роли пользователя. | from AbstractToken |
| string | getUsername() Возвращает имя пользователя. | from AbstractToken |
| mixed | getUser() Возвращает представление пользователя. | from AbstractToken |
| setUser(mixed $user) Устанавливает пользователя в токене. | from AbstractToken | |
| bool | isAuthenticated() Возвращает, аутентифицирован ли пользователь. | from AbstractToken |
| setAuthenticated($authenticated) Устанавливает флаг аутентификации. | ||
| eraseCredentials() Удаляет конфиденциальную информацию из токена. | from AbstractToken | |
| serialize() {@inheritdoc} | from AbstractToken | |
| unserialize($serialized) {@inheritdoc} | from AbstractToken | |
| array | getAttributes() Возвращает атрибуты токена. | from AbstractToken |
| setAttributes(array $attributes) Устанавливает атрибуты токена. | from AbstractToken | |
| bool | hasAttribute(string $name) Возвращает true, если атрибут существует. | from AbstractToken |
| mixed | getAttribute(string $name) Возвращает значение атрибута. | from AbstractToken |
| setAttribute(string $name, mixed $value) Устанавливает атрибут. | from AbstractToken | |
| string | __toString() Возвращает строковое представление токена. | from AbstractToken |
| getGuardProviderKey() | ||
| mixed | getCredentials() Возвращает учётные данные пользователя, которые могут быть массивом чего угодно (например, имя пользователя, пароль, любимый цвет). |
Подробности
__construct(mixed $credentials, string $guardProviderKey)
Параметры
| mixed | $credentials | |
| string | $guardProviderKey | Уникальный ключ, связывающий этот токен с конкретным AuthenticatorInterface |
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 |
getGuardProviderKey()
mixed getCredentials()
Возвращает учетные данные пользователя, которые могут быть массивом любого типа (например, имя пользователя, пароль, любимый цвет).
Значение результата
| mixed | Учетные данные пользователя |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.4/Symfony/Component/Security/Guard/Token/PreAuthenticationGuardToken.html
