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

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

Конструктор.

Параметры

string|object	$user	Пользователь
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

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