Spec-Zone.ru › Symfony 3.2

PostAuthenticationGuardToken

class PostAuthenticationGuardToken extends AbstractToken implements GuardTokenInterface

Используется как "аутентифицированный" токен, хотя его можно установить в состояние "неаутентифицированного" позже.

Если вы используете аутентификацию Guard, вы обязаны использовать класс, реализующий GuardTokenInterface, как аутентифицированный токен (например, этот класс).

Методы

__construct(UserInterface $user, string $providerKey, array $roles)
RoleInterface[] getRoles()

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

from AbstractToken
string getUsername()

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

from AbstractToken
mixed getUser()

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

from AbstractToken
setUser(mixed $user)

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

from AbstractToken
bool isAuthenticated()

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

from AbstractToken
setAuthenticated($authenticated)

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

from AbstractToken
eraseCredentials()

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

from AbstractToken
serialize()

{@inheritdoc}

unserialize($serialized)

{@inheritdoc}

array getAttributes()

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

from AbstractToken
setAttributes(array $attributes)

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

from AbstractToken
bool hasAttribute(string $name)

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

from AbstractToken
mixed getAttribute(string $name)

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

from AbstractToken
setAttribute(string $name, mixed $value)

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

from AbstractToken
string __toString()

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

from AbstractToken
mixed getCredentials()

Предполагается, что это только аутентифицированный токен, где учетные данные уже использовались и, следовательно, очищены.

string getProviderKey()

Возвращает ключ провайдера (брандмауэра).

Детали

__construct(UserInterface $user, string $providerKey, array $roles)

Параметры

UserInterface $user Пользователь!
string $providerKey Ключ провайдера (брандмауэра)
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

mixed getCredentials()

Предназначен только для аутентифицированного токена, где учетные данные уже использованы и, следовательно, очищены.

{@inheritdoc}

Значение результата

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

string getProviderKey()

Возвращает ключ провайдера (брандмауэра).

Значение результата

string

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Security/Guard/Token/PostAuthenticationGuardToken.html

Spec-Zone.ru

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