Spec-Zone.ru › Symfony 3.1

PreAuthenticatedToken

class PreAuthenticatedToken extends AbstractToken

PreAuthenticatedToken реализует предварительно аутентифицированный токен.

Методы

__construct(string|object $user, mixed $credentials, string $providerKey, array $roles = array())

Конструктор.

RoleInterface[] getRoles()

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

из AbstractToken
string getUsername()

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

из AbstractToken
mixed getUser()

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

из AbstractToken
setUser(mixed $user)

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

из AbstractToken
bool isAuthenticated()

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

из AbstractToken
setAuthenticated($authenticated)

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

из AbstractToken
eraseCredentials()

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

serialize()

{@inheritdoc}

unserialize($str)

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

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

mixed getCredentials()

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

Подробности

__construct(string|object $user, mixed $credentials, string $providerKey, array $roles = array())

Конструктор.

Параметры

string|object $user Пользователь может быть экземпляром UserInterface или объектом, реализующим метод __toString, или именем пользователя как обычной строкой.
mixed $credentials Учетные данные пользователя
string $providerKey Ключ провайдера
array $roles Массив ролей

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

{@inheritdoc}

Параметры

$str

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 Ключ провайдера

mixed getCredentials()

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

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

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

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

Spec-Zone.ru

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