UsernamePasswordToken

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

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

Параметры

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

Исключения

InvalidArgumentException

RoleInterface[] getRoles()

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

Возвращаемое значение

RoleInterface[]

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

string getUsername()

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

Возвращаемое значение

string

mixed getUser()

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

Возвращаемое значение

mixed

либо возвращает объект, который реализует __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

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