Spec-Zone.ru › Symfony 2.8

RememberMeToken

class RememberMeToken extends AbstractToken

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

Методы

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

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

from AbstractToken
string getUsername()

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

from AbstractToken
mixed getUser()

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

from AbstractToken
setUser(mixed $user)

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

from AbstractToken
bool isAuthenticated()

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

from AbstractToken
setAuthenticated($authenticated)

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

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

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

getKey() deprecated
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 Секрет поставщика

getKey() устарело

устарело

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

string getSecret()

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

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

string

mixed getCredentials()

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

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

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

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

Spec-Zone.ru

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