UsernamePasswordToken

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

Параметры

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

Исключения

InvalidArgumentException

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($isAuthenticated)

Устанавливает флаг аутентификации.

Параметры

$isAuthenticated

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

mixed getCredentials()

Возвращает учетные данные пользователя.

Значение возврата

mixed

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

string getProviderKey()

Возвращает ключ поставщика.

Значение возврата

string

Ключ поставщика