CBaseUserIdentity

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

errorCode свойство

public integer $errorCode;

код ошибки аутентификации. Если произошла ошибка, код ошибки будет отличным от нуля. По умолчанию равен 100, означающему неизвестную идентичность. Вызов authenticate изменит это значение.

errorMessage свойство

public string $errorMessage;

сообщение об ошибке аутентификации. По умолчанию пустая строка.

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

public mixed getId()

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

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

public boolean getIsAuthenticated()

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

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

public string getName()

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

persistentStates свойство

public array getPersistentStates()
public void setPersistentStates(array $states)

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

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

clearState() метод

public void clearState(string $name)

public function clearState($name)
{
    unset($this->_state[$name]);
}

Удаляет указанное состояние.

getId() метод

public mixed getId()

public function getId()
{
    return $this->getName();
}

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

getIsAuthenticated() метод

public boolean getIsAuthenticated()

public function getIsAuthenticated()
{
    return $this->errorCode==self::ERROR_NONE;
}

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

getName() метод

public string getName()

public function getName()
{
    return '';
}

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

getPersistentStates() метод

public array getPersistentStates()

public function getPersistentStates()
{
    return $this->_state;
}

Возвращает состояния идентификатора, которые должны сохраняться. Этот метод необходим для IUserIdentity.

getState() метод

public mixed getState(string $name, mixed $defaultValue=NULL)

public function getState($name,$defaultValue=null)
{
    return isset($this->_state[$name])?$this->_state[$name]:$defaultValue;
}

Получает сохраненное состояние по указанному имени.

setPersistentStates() метод

public void setPersistentStates(array $states)

public function setPersistentStates($states)
{
    $this->_state = $states;
}

Устанавливает массив постоянных состояний.

setState() метод

public void setState(string $name, mixed $value)

public function setState($name,$value)
{
    $this->_state[$name]=$value;
}

Устанавливает состояние с заданным именем и значением.