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

__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

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