Преаутентифицированный токен

__construct(string|object $user, mixed $credentials, string $providerKey, array $roles = array())

Параметры

string|object	$user	Пользователь может быть экземпляром UserInterface или объектом, реализующим метод __toString, или именем пользователя в виде обычной строки
mixed	$credentials	Учетные данные пользователя
string	$providerKey	Ключ провайдера
array	$roles	Массив ролей

Роль[] getRoles()

Возвращает роли пользователя.

Значение результата

Роль[]

Массив экземпляров Role

string getUsername()

Возвращает имя пользователя.

Значение результата

string

string|object getUser()

Возвращает представление пользователя.

Значение результата

string|object

Может быть экземпляром UserInterface, объектом, реализующим метод __toString, или именем пользователя в виде обычной строки

setUser(string|object $user)

Устанавливает пользователя в токене.

Пользователь может быть экземпляром UserInterface или объектом, реализующим метод __toString, или именем пользователя в виде обычной строки.

Параметры

string|object

$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

Учетные данные пользователя