UsernamePasswordToken

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

Параметры

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

Исключения

InvalidArgumentException

Role[] getRoles()

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

Значение

Role[]

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

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

Ключ провайдера