Spec-Zone.ru › Symfony 3.2

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

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

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.2/Symfony/Component/Security/Core/Authentication/Token/RememberMeToken.html

Spec-Zone.ru

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