Spec-Zone.ru › Symfony 2.7

RememberMeToken

class RememberMeToken extends AbstractToken

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

Методы

__construct(UserInterface $user, string $providerKey, string $key)
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()

Возвращает ключ провайдера.

string getKey()

Возвращает ключ.

mixed getCredentials()

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

Подробности

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

Параметры

UserInterface $user
string $providerKey
string $key

Исключения

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 getKey()

Возвращает ключ.

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

string Ключ

mixed getCredentials()

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

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

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

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

Spec-Zone.ru

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