Spec-Zone.ru › Symfony 2.7

AbstractToken

class AbstractToken implements TokenInterface

Базовый класс для экземпляров Token.

Методы

__construct(array $roles = array())
RoleInterface[] getRoles()

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

string getUsername()

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

mixed getUser()

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

setUser(mixed $user)

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

bool isAuthenticated()

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

setAuthenticated($authenticated)

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

eraseCredentials()

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

serialize()

{@inheritdoc}

unserialize($serialized)

{@inheritdoc}

array getAttributes()

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

setAttributes(array $attributes)

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

bool hasAttribute(string $name)

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

mixed getAttribute(string $name)

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

setAttribute(string $name, mixed $value)

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

string __toString()

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

Подробности

__construct(array $roles = array())

Параметры

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($authenticated)

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

Параметры

$authenticated

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

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

Spec-Zone.ru

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