Spec-Zone.ru › Symfony 3.1

Интерфейс Token

интерфейс TokenInterface реализует 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/2.7/Symfony/Component/Security/Core/Authentication/Token/TokenInterface.html

Spec-Zone.ru

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