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

__construct(mixed $credentials, string $guardProviderKey)

Параметры

mixed	$credentials
string	$guardProviderKey	Уникальный ключ, связывающий этот токен с конкретным GuardAuthenticatorInterface

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

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