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

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