Spec-Zone.ru › Symfony 3.4

RememberMeToken

class RememberMeToken extends AbstractToken

Токен аутентификации для "Remember-Me".

Методы

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

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

из AbstractToken
string getUsername()

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

из AbstractToken
mixed getUser()

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

из AbstractToken
setUser(mixed $user)

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

из AbstractToken
bool isAuthenticated()

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

из AbstractToken
setAuthenticated($authenticated)

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

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
string getProviderKey()

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

string getSecret()

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

mixed getCredentials()

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

Детали

__construct(UserInterface $user, string $providerKey, string $secret)

Параметры

UserInterface $user
string $providerKey
string $secret Секрет, используемый для проверки того, что токен создан приложением, а не злонамеренным клиентом

Исключения

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

string getProviderKey()

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

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

string Секрет поставщика

string getSecret()

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

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

string

mixed getCredentials()

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

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

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

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

Spec-Zone.ru

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