Spec-Zone.ru › Symfony 2.8

AnonymousToken

class AnonymousToken extends AbstractToken

AnonymousToken представляет анонимный токен.

Методы

__construct(string $secret, string|object $user, array $roles = array())
RoleInterface[] getRoles()

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

из AbstractToken
string getUsername()

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

из AbstractToken
mixed getUser()

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

из AbstractToken
setUser(mixed $user)

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

из AbstractToken
bool isAuthenticated()

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

из AbstractToken
setAuthenticated($authenticated)

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

из AbstractToken
eraseCredentials()

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

из AbstractToken
serialize()

{@inheritdoc}

unserialize($serialized)

{@inheritdoc}

array getAttributes()

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

из AbstractToken
setAttributes(array $attributes)

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

из AbstractToken
bool hasAttribute(string $name)

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

из AbstractToken
mixed getAttribute(string $name)

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

из AbstractToken
setAttribute(string $name, mixed $value)

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

из AbstractToken
string __toString()

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

из AbstractToken
mixed getCredentials()

Возвращает учетные данные пользователя.

getKey() deprecated
string getSecret()

Возвращает секрет.

Подробности

__construct(string $secret, string|object $user, array $roles = array())

Параметры

string $secret Секрет, используемый для проверки, что токен создан приложением, а не злонамеренным клиентом
string|object $user Пользователь может быть экземпляром UserInterface или объектом, реализующим метод __toString, или именем пользователя как обычной строкой
array $roles Массив ролей

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

mixed getCredentials()

Возвращает учетные данные пользователя.

Значение возврата

mixed Учетные данные пользователя

getKey() deprecated

deprecated

Since версия 2.8, будет удалена в 3.0. Используйте getSecret() вместо этого.

string getSecret()

Возвращает секрет.

Значение возврата

string

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

Spec-Zone.ru

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