PreAuthenticatedToken
class PreAuthenticatedToken extends AbstractToken
PreAuthenticatedToken реализует токен предварительной аутентификации.
Методы
| __construct(string|object $user, mixed $credentials, string $providerKey, array $roles = array()) Конструктор. | ||
| RoleInterface[] | getRoles() Возвращает роли пользователя. | from AbstractToken |
| string | getUsername() Возвращает имя пользователя. | from AbstractToken |
| mixed | getUser() Возвращает представление пользователя. | from AbstractToken |
| setUser(mixed $user) Устанавливает пользователя в токен. | from AbstractToken | |
| bool | isAuthenticated() Возвращает, аутентифицирован ли пользователь или нет. | from AbstractToken |
| setAuthenticated($authenticated) Устанавливает флаг аутентификации. | from AbstractToken | |
| eraseCredentials() Удаляет конфиденциальную информацию из токена. | ||
| serialize() {@inheritdoc} | ||
| unserialize($str) {@inheritdoc} | ||
| 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 |
| string | getProviderKey() Возвращает ключ поставщика. | |
| mixed | getCredentials() Возвращает учетные данные пользователя. |
Подробности
__construct(string|object $user, mixed $credentials, string $providerKey, array $roles = array())
Конструктор.
Параметры
| string|object | $user | Пользователь может быть экземпляром UserInterface или объектом, реализующим метод __toString, или именем пользователя в виде обычной строки. |
| mixed | $credentials | Учетные данные пользователя |
| string | $providerKey | Ключ поставщика |
| array | $roles | Массив ролей |
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($str)
{@inheritdoc}
Параметры
| $str |
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 |
string getProviderKey()
Возвращает ключ поставщика.
Значение результата
| string | Ключ поставщика |
mixed getCredentials()
Возвращает учетные данные пользователя.
Значение результата
| mixed | Учетные данные пользователя |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Security/Core/Authentication/Token/PreAuthenticatedToken.html