Spec-Zone.ru › Symfony 4.1

AnonymousToken

class AnonymousToken extends AbstractToken

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

Методы

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

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

из AbstractToken
string getUsername()

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

из AbstractToken
string|object getUser()

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

из AbstractToken
setUser(string|object $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

string|object getUser()

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

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

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

setUser(string|object $user)

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

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

Параметры

string|object $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.
https://api.symfony.com/4.1/Symfony/Component/Security/Core/Authentication/Token/AnonymousToken.html

Spec-Zone.ru

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