Spec-Zone.ru › Symfony 4.0

AnonymousToken

class AnonymousToken extends AbstractToken

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

Методы

__construct(string $secret, string|object $user, array $roles = array())
Role[] 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()

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

string getSecret()

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

Подробности

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

Параметры

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

Role[] getRoles()

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

Значение, возвращаемое функцией

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

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 Учетные данные пользователя

string getSecret()

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

Значение, возвращаемое функцией

string

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

Spec-Zone.ru

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