Spec-Zone.ru › Symfony 3.0

TokenInterface

interface TokenInterface implements Serializable

TokenInterface — интерфейс для информации об аутентификации пользователя.

Методы

string __toString()

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

RoleInterface[] getRoles()

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

mixed getCredentials()

Возвращает данные пользователя для аутентификации.

mixed getUser()

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

setUser(mixed $user)

Устанавливает пользователя.

string getUsername()

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

bool isAuthenticated()

Возвращает, аутентифицирован ли пользователь.

setAuthenticated(bool $isAuthenticated)

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

eraseCredentials()

Удаляет конфиденциальную информацию из токена.

array getAttributes()

Возвращает атрибуты токена.

setAttributes(array $attributes)

Устанавливает атрибуты токена.

bool hasAttribute(string $name)

Возвращает true, если атрибут существует.

mixed getAttribute(string $name)

Возвращает значение атрибута.

setAttribute(string $name, mixed $value)

Устанавливает атрибут.

Подробности

string __toString()

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

Используется только для отладки.

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

string

RoleInterface[] getRoles()

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

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

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

mixed getCredentials()

Возвращает данные пользователя для аутентификации.

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

mixed Данные пользователя для аутентификации

mixed getUser()

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

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

mixed Может быть экземпляром UserInterface, объектом, реализующим метод __toString, или именем пользователя как обычной строкой

См. также

AbstractToken::setUser()

setUser(mixed $user)

Устанавливает пользователя.

Параметры

mixed $user

string getUsername()

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

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

string

bool isAuthenticated()

Возвращает, аутентифицирован ли пользователь.

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

bool true, если токен аутентифицирован, иначе false

setAuthenticated(bool $isAuthenticated)

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

Параметры

bool $isAuthenticated Флаг аутентификации

eraseCredentials()

Удаляет конфиденциальную информацию из токена.

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 Значение атрибута

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Security/Core/Authentication/Token/TokenInterface.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API