Spec-Zone.ru › Yii 1.1

CUserIdentity

Пакет system.web.auth
Наследование class CUserIdentity » CBaseUserIdentity » CComponent
Реализует IUserIdentity
С момента 1.0
Исходный код framework/web/auth/CUserIdentity.php
CUserIdentity — базовый класс для представления идентичностей, которые аутентифицированы на основе имени пользователя и пароля.

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

По умолчанию CUserIdentity предполагает, что имя пользователя является уникальным идентификатором и, следовательно, использует его в качестве ID идентичности.

Свойства

Свойство Тип Описание Определено в
errorCode integer код ошибки аутентификации. CBaseUserIdentity
errorMessage string сообщение об ошибке аутентификации. CBaseUserIdentity
id string Возвращает уникальный идентификатор идентичности. CUserIdentity
isAuthenticated boolean Возвращает значение, указывающее, аутентифицирована ли идентичность. CBaseUserIdentity
name string Возвращает отображаемое имя идентичности. CUserIdentity
password string пароль CUserIdentity
persistentStates array Возвращает состояния идентичности, которые должны быть сохранены. CBaseUserIdentity
username string имя пользователя CUserIdentity

Общедоступные методы

Метод Описание Определено в
__call() Вызывает метод по имени, который не является методом класса. CComponent
__construct() Конструктор. CUserIdentity
__get() Возвращает значение свойства, список обработчиков событий или поведение на основе его имени. CComponent
__isset() Проверяет, является ли значение свойства null. CComponent
__set() Устанавливает значение свойства компонента. CComponent
__unset() Устанавливает свойство компонента в null. CComponent
asa() Возвращает объект поведения по имени. CComponent
attachBehavior() Прикрепляет поведение к этому компоненту. CComponent
attachBehaviors() Прикрепляет список поведений к компоненту. CComponent
attachEventHandler() Прикрепляет обработчик события к событию. CComponent
authenticate() Аутентифицирует пользователя на основе имени пользователя и пароля. CUserIdentity
canGetProperty() Определяет, можно ли считать свойство. CComponent
canSetProperty() Определяет, можно ли установить свойство. CComponent
clearState() Удаляет указанное состояние. CBaseUserIdentity
detachBehavior() Открепляет поведение от компонента. CComponent
detachBehaviors() Открепляет все поведения от компонента. CComponent
detachEventHandler() Открепляет существующий обработчик события. CComponent
disableBehavior() Отключает прикрепленное поведение. CComponent
disableBehaviors() Отключает все прикрепленные поведения к этому компоненту. CComponent
enableBehavior() Включает прикрепленное поведение. CComponent
enableBehaviors() Включает все прикрепленные к этому компоненту поведения. CComponent
evaluateExpression() Вычисляет PHP-выражение или обратный вызов в контексте этого компонента. CComponent
getEventHandlers() Возвращает список прикрепленных обработчиков событий для события. CComponent
getId() Возвращает уникальный идентификатор идентичности. CUserIdentity
getIsAuthenticated() Возвращает значение, указывающее, аутентифицирована ли идентичность. CBaseUserIdentity
getName() Возвращает отображаемое имя идентичности. CUserIdentity
getPersistentStates() Возвращает состояния идентичности, которые должны быть сохранены. CBaseUserIdentity
getState() Получает сохраненное состояние по заданному имени. CBaseUserIdentity
hasEvent() Определяет, определено ли событие. CComponent
hasEventHandler() Проверяет, есть ли у заданного события прикрепленные обработчики. CComponent
hasProperty() Определяет, определено ли свойство. CComponent
raiseEvent() Вызывает событие. CComponent
setPersistentStates() Устанавливает массив постоянных состояний. CBaseUserIdentity
setState() Устанавливает заданное состояние с заданным значением. CBaseUserIdentity

Подробное описание свойств

id свойство только для чтения

public string getId()

Возвращает уникальный идентификатор идентичности. Реализация по умолчанию просто возвращает имя пользователя. Этот метод требуется IUserIdentity.

name свойство только для чтения

public string getName()

Возвращает отображаемое имя идентичности. Реализация по умолчанию просто возвращает имя пользователя. Этот метод требуется IUserIdentity.

password свойство

public string $password;

пароль

username свойство

public string $username;

имя пользователя

Подробное описание методов

__construct() метод

public void __construct(string $username, string $password)
$username string логин
$password string пароль
Исходный код: framework/web/auth/CUserIdentity.php#43 (показать)
public function __construct($username,$password)
{
    
$this->username=$username;
    
$this->password=$password;
}

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

authenticate() метод

public boolean authenticate()
{return} boolean успешность аутентификации.
Исходный код: framework/web/auth/CUserIdentity.php#56 (показать)
public function authenticate()
{
    throw new 
CException(Yii::t('yii','{class}::authenticate() must be implemented.',array('{class}'=>get_class($this))));
}

Производит аутентификацию пользователя на основе логина и пароля. Производные классы должны переопределять этот метод, иначе будет выброшено исключение. Этот метод необходим для IUserIdentity.

getId() метод

public string getId()
{return} string уникальный идентификатор личности.
Исходный код: framework/web/auth/CUserIdentity.php#67 (показать)
public function getId()
{
    return 
$this->username;
}

Возвращает уникальный идентификатор личности. По умолчанию возвращает логин. Этот метод необходим для IUserIdentity.

getName() метод

public string getName()
{return} string отображаемое имя личности.
Исходный код: framework/web/auth/CUserIdentity.php#78 (показать)
public function getName()
{
    return 
$this->username;
}

Возвращает отображаемое имя личности. По умолчанию возвращает логин. Этот метод необходим для IUserIdentity.

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

Spec-Zone.ru

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