IUserIdentity

Пакет	system.base
Наследование	интерфейс IUserIdentity
Подклассы	CBaseUserIdentity, CUserIdentity
С	1.0
Исходный код	framework/base/interfaces.php

Интерфейс IUserIdentity реализуется классом идентификатора пользователя.

Идентификатор представляет собой способ аутентификации пользователя и извлечения информации, необходимой для уникальной идентификации пользователя. Обычно используется с компонентом приложения пользователя.

Публичные методы

Метод	Описание	Определен в
authenticate()	Аутентифицирует пользователя.	IUserIdentity
getId()	Возвращает значение, уникально представляющее идентификатор.	IUserIdentity
getIsAuthenticated()	Возвращает значение, указывающее, является ли идентификатор аутентифицированным.	IUserIdentity
getName()	Возвращает отображаемое имя для идентификатора (например, имя пользователя).	IUserIdentity
getPersistentStates()	Возвращает дополнительную информацию об идентификаторе, которая должна сохраняться во время сеанса пользователя.	IUserIdentity

Подробные сведения о методах

authenticate() метод

abstract public boolean authenticate()
{return}	boolean	успешность аутентификации.

Исходный код: framework/base/interfaces.php#255 (показать)

public function authenticate();

Аутентифицирует пользователя. Информация, необходимая для аутентификации пользователя, обычно предоставляется в конструкторе.

getId() метод

abstract public mixed getId()
{return}	mixed	значение, уникально представляющее идентификатор (например, значение первичного ключа).

Исходный код: framework/base/interfaces.php#265 (показать)

public function getId();

Возвращает значение, уникально представляющее идентификатор.

getIsAuthenticated() метод

abstract public boolean getIsAuthenticated()
{return}	boolean	действительность идентификатора.

Исходный код: framework/base/interfaces.php#260 (показать)

public function getIsAuthenticated();

Возвращает значение, указывающее, является ли идентификатор аутентифицированным.

getName() метод

abstract public string getName()
{return}	string	отображаемое имя идентификатора.

Исходный код: framework/base/interfaces.php#270 (показать)

public function getName();

Возвращает отображаемое имя для идентификатора (например, имя пользователя).

getPersistentStates() метод

abstract public array getPersistentStates()
{return}	array	дополнительная информация об идентификаторе, которая должна сохраняться во время сеанса пользователя (исключая id).

Исходный код: framework/base/interfaces.php#275 (показать)

public function getPersistentStates();

Возвращает дополнительную информацию об идентификаторе, которая должна сохраняться во время сеанса пользователя.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/IUserIdentity