CWebUser

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

absoluteAuthTimeout свойство (доступно с v1.1.14)

public integer $absoluteAuthTimeout;

время в секундах, после которого пользователь будет выведен из системы независимо от активности.

allowAutoLogin свойство

public boolean $allowAutoLogin;

включить или отключить авторизацию через куки. По умолчанию false.

authTimeout свойство (доступно с v1.1.7)

public integer $authTimeout;

время в секундах, после которого пользователь будет выведен из системы, если он неактивен. Если это свойство не задано, пользователь будет выведен из системы после истечения текущей сессии (см. CHttpSession::timeout).

autoRenewCookie свойство (доступно с v1.1.0)

public boolean $autoRenewCookie;

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

autoUpdateFlash свойство (доступно с v1.1.7)

public boolean $autoUpdateFlash;

автоматически обновлять срок действия всплывающих сообщений. По умолчанию true, что означает, что сообщения будут действительны только в текущем и следующем запросах. Если это свойство установлено в false, вы должны самостоятельно заботиться об удалении всплывающих сообщений после их использования. (Это можно сделать, вызвав getFlash с третьим параметром, равным true).

flashes свойство только для чтения (доступно с v1.1.3)

public array getFlashes(boolean $delete=true)

Возвращает все всплывающие сообщения. Этот метод похож на getFlash, за исключением того, что возвращает все доступные в данный момент всплывающие сообщения.

guestName свойство

public string $guestName;

имя для пользователя-гостя. По умолчанию 'Гость'. Используется методом getName, когда текущий пользователь гость (не авторизован).

id свойство

public mixed getId()
public void setId(mixed $value)

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

identityCookie свойство

public array $identityCookie;

значения свойств (в парах имя-значение), используемые для инициализации куки пользователя. Можно инициализировать любое свойство из CHttpCookie. Это свойство эффективно только если allowAutoLogin равно true.

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

public boolean getIsGuest()

Возвращает значение, указывающее, является ли пользователь гостем (не авторизован).

loginRequiredAjaxResponse свойство (доступно с v1.1.9)

public string $loginRequiredAjaxResponse;

значение, которое будет выведено в случае истечения сессии пользователя во время ajax-запроса. Когда происходит запрос и сессия пользователя истекла, loginRequired перенаправляет на loginUrl для входа в систему. Если это происходит во время ajax-запроса, вся HTML-страница входа в систему возвращается в результате этого ajax-запроса. Это может быть проблемой, если ajax-запрос ожидает получить массив json или определённую строку, так как страница входа в систему в этом случае игнорируется. Чтобы решить эту проблему, установите это свойство в желаемое возвращаемое значение.

Если это свойство установлено, это значение будет возвращено в результате ajax-запроса в случае истечения сессии пользователя.

loginUrl свойство

public string|array $loginUrl;

URL для входа в систему. Если используется массив, первый элемент должен быть маршрутом к действию входа в систему, а остальные пары имя-значение — параметрами GET для построения URL входа в систему (например, массив('/site/login')). Если это свойство равно null, вместо этого будет вызвано исключение 403 HTTP.

name свойство

public string getName()
public void setName(string $value)

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

returnUrl свойство

public string getReturnUrl(string $defaultUrl=NULL)
public void setReturnUrl(string $value)

Возвращает URL, на который должен быть перенаправлен пользователь после успешного входа в систему. Это свойство обычно используется действием входа в систему. Если вход успешен, действие должно считать это свойство и использовать его для перенаправления пользователя в браузере.

stateKeyPrefix свойство

public string getStateKeyPrefix()
public void setStateKeyPrefix(string $value)

префикс для имени переменных сессии, хранящих данные сессии пользователя.

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

__get() метод

public mixed __get(string $name)

public function __get($name)
{
    if($this->hasState($name))
        return $this->getState($name);
    else
        return parent::__get($name);
}

Магический метод PHP. Этот метод переопределен для того, чтобы постоянные состояния можно было получать как свойства.

__isset() метод

public boolean __isset(string $name)

public function __isset($name)
{
    if($this->hasState($name))
        return $this->getState($name)!==null;
    else
        return parent::__isset($name);
}

Магический метод PHP. Этот метод переопределен, чтобы проверять постоянные состояния на null.

__set() метод

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

public function __set($name,$value)
{
    if($this->hasState($name))
        $this->setState($name,$value);
    else
        parent::__set($name,$value);
}

Магический метод PHP. Этот метод переопределен, чтобы устанавливать постоянные состояния как свойства.

__unset() метод

public void __unset(string $name)

public function __unset($name)
{
    if($this->hasState($name))
        $this->setState($name,null);
    else
        parent::__unset($name);
}

Магический метод PHP. Этот метод переопределен для удаления постоянных состояний.

afterLogin() метод (доступно с v1.1.3)

protected void afterLogin(boolean $fromCookie)

protected function afterLogin($fromCookie)
{
}

Этот метод вызывается после успешного входа пользователя. Вы можете переопределить этот метод для выполнения постобработки (например, записи IP и времени входа пользователя; загрузки информации о правах пользователя).

afterLogout() метод (доступно с v1.1.3)

protected void afterLogout()

protected function afterLogout()
{
}

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

beforeLogin() метод (доступно с v1.1.3)

protected boolean beforeLogin(mixed $id, array $states, boolean $fromCookie)

protected function beforeLogin($id,$states,$fromCookie)
{
    return true;
}

Этот метод вызывается перед входом пользователя в систему. Вы можете переопределить этот метод, чтобы добавить дополнительную проверку безопасности. Например, при аутентификации по куки, вы можете проверить, что идентификатор пользователя вместе со случайным токеном в состоянии присутствует в базе данных. Это предотвратит хакеров от подделки произвольных куки-файлов идентификации, даже если они взломают закрытый ключ сервера.

beforeLogout() метод (доступен начиная с v1.1.3)

protected boolean beforeLogout()

protected function beforeLogout()
{
    return true;
}

Этот метод вызывается при вызове logout для выхода пользователя из системы. Если этот метод возвращает false, действие выхода будет отменено. Вы можете переопределить этот метод, чтобы добавить дополнительную проверку перед выходом пользователя из системы.

changeIdentity() метод

protected void changeIdentity(mixed $id, string $name, array $states)

protected function changeIdentity($id,$name,$states)
{
    Yii::app()->getSession()->regenerateID(true);
    $this->setId($id);
    $this->setName($name);
    $this->loadIdentityStates($states);
}

Изменяет текущего пользователя с указанной информацией об идентификации. Этот метод вызывается login и restoreFromCookie, когда текущий пользователь должен быть заполнен соответствующей информацией об идентификации. Производные классы могут переопределить этот метод, чтобы получить дополнительную информацию, связанную с пользователем. Убедитесь, что сначала вызывается родительская реализация.

checkAccess() метод

public boolean checkAccess(string $operation, array $params=array ( ), boolean $allowCaching=true)

public function checkAccess($operation,$params=array(),$allowCaching=true)
{
    if($allowCaching && $params===array() && isset($this->_access[$operation]))
        return $this->_access[$operation];

    $access=Yii::app()->getAuthManager()->checkAccess($operation,$this->getId(),$params);
    if($allowCaching && $params===array())
        $this->_access[$operation]=$access;

    return $access;
}

Производит проверку доступа для данного пользователя.

clearStates() метод

public void clearStates()

public function clearStates()
{
    $keys=array_keys($_SESSION);
    $prefix=$this->getStateKeyPrefix();
    $n=strlen($prefix);
    foreach($keys as $key)
    {
        if(!strncmp($key,$prefix,$n))
            unset($_SESSION[$key]);
    }
}

Очищает всю информацию об идентификации пользователя из постоянного хранилища. Это удалит данные, сохранённые с помощью setState.

createIdentityCookie() метод

protected CHttpCookie createIdentityCookie(string $name)

protected function createIdentityCookie($name)
{
    $cookie=new CHttpCookie($name,'');
    if(is_array($this->identityCookie))
    {
        foreach($this->identityCookie as $name=>$value)
            $cookie->$name=$value;
    }
    return $cookie;
}

Создаёт куки для хранения информации об идентификации.

getFlash() метод

public mixed getFlash(string $key, mixed $defaultValue=NULL, boolean $delete=true)

public function getFlash($key,$defaultValue=null,$delete=true)
{
    $value=$this->getState(self::FLASH_KEY_PREFIX.$key,$defaultValue);
    if($delete)
        $this->setFlash($key,null);
    return $value;
}

Возвращает сообщение флэша. Сообщение флэша доступно только в текущем и следующем запросах.

getFlashes() метод (доступен начиная с v1.1.3)

public array getFlashes(boolean $delete=true)

public function getFlashes($delete=true)
{
    $flashes=array();
    $prefix=$this->getStateKeyPrefix().self::FLASH_KEY_PREFIX;
    $keys=array_keys($_SESSION);
    $n=strlen($prefix);
    foreach($keys as $key)
    {
        if(!strncmp($key,$prefix,$n))
        {
            $flashes[substr($key,$n)]=$_SESSION[$key];
            if($delete)
                unset($_SESSION[$key]);
        }
    }
    if($delete)
        $this->setState(self::FLASH_COUNTERS,array());
    return $flashes;
}

Возвращает все сообщения флэша. Этот метод похож на getFlash, за исключением того, что он возвращает все доступные в данный момент сообщения флэша.

getId() метод

public mixed getId()

public function getId()
{
    return $this->getState('__id');
}

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

getIsGuest() метод

public boolean getIsGuest()

public function getIsGuest()
{
    return $this->getState('__id')===null;
}

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

getName() метод

public string getName()

public function getName()
{
    if(($name=$this->getState('__name'))!==null)
        return $name;
    else
        return $this->guestName;
}

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

getReturnUrl() метод

public string getReturnUrl(string $defaultUrl=NULL)

public function getReturnUrl($defaultUrl=null)
{
    if($defaultUrl===null)
    {
        $defaultReturnUrl=Yii::app()->getUrlManager()->showScriptName ? Yii::app()->getRequest()->getScriptUrl() : Yii::app()->getRequest()->getBaseUrl().'/';
    }
    else
    {
        $defaultReturnUrl=CHtml::normalizeUrl($defaultUrl);
    }
    return $this->getState('__returnUrl',$defaultReturnUrl);
}

Возвращает URL, на который пользователь должен быть перенаправлен после успешного входа в систему. Это свойство обычно используется действием входа в систему. Если вход в систему успешен, действие должно прочитать это свойство и использовать его для перенаправления браузера пользователя.

getState() метод

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

public function getState($key,$defaultValue=null)
{
    $key=$this->getStateKeyPrefix().$key;
    return isset($_SESSION[$key]) ? $_SESSION[$key] : $defaultValue;
}

Возвращает значение переменной, хранящейся в сессии пользователя.

Эта функция предназначена для использования классами-наследниками CWebUser, которые хотят хранить дополнительную информацию о пользователе в сессии пользователя. Переменная, если хранится в сессии пользователя с помощью setState, может быть получена обратно с помощью этой функции.

getStateKeyPrefix() метод

public string getStateKeyPrefix()

public function getStateKeyPrefix()
{
    if($this->_keyPrefix!==null)
        return $this->_keyPrefix;
    else
        return $this->_keyPrefix=md5('Yii.'.get_class($this).'.'.Yii::app()->getId());
}

hasFlash() метод

public boolean hasFlash(string $key)

public function hasFlash($key)
{
    return $this->getFlash($key, null, false)!==null;
}

hasState() метод

public boolean hasState(string $key)

public function hasState($key)
{
    $key=$this->getStateKeyPrefix().$key;
    return isset($_SESSION[$key]);
}

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

init() метод

public void init()

public function init()
{
    parent::init();
    Yii::app()->getSession()->open();
    if($this->getIsGuest() && $this->allowAutoLogin)
        $this->restoreFromCookie();
    elseif($this->autoRenewCookie && $this->allowAutoLogin)
        $this->renewCookie();
    if($this->autoUpdateFlash)
        $this->updateFlash();

    $this->updateAuthStatus();
}

Инициализирует компонент приложения. Этот метод переопределяет реализацию родительского класса, запуская сеанс, выполняя аутентификацию на основе cookie (если включена), и обновляя переменные всплывающих сообщений.

loadIdentityStates() метод

protected void loadIdentityStates(array $states)

protected function loadIdentityStates($states)
{
    $names=array();
    if(is_array($states))
    {
        foreach($states as $name=>$value)
        {
            $this->setState($name,$value);
            $names[$name]=true;
        }
    }
    $this->setState(self::STATES_VAR,$names);
}

Загружает состояния идентификатора из массива и сохраняет их в постоянном хранилище.

login() метод

public boolean login(IUserIdentity $identity, integer $duration=0)

public function login($identity,$duration=0)
{
    $id=$identity->getId();
    $states=$identity->getPersistentStates();
    if($this->beforeLogin($id,$states,false))
    {
        $this->changeIdentity($id,$identity->getName(),$states);

        if($duration>0)
        {
            if($this->allowAutoLogin)
                $this->saveToCookie($duration);
            else
                throw new CException(Yii::t('yii','{class}.allowAutoLogin must be set true in order to use cookie-based authentication.',
                    array('{class}'=>get_class($this))));
        }

        if ($this->absoluteAuthTimeout)
            $this->setState(self::AUTH_ABSOLUTE_TIMEOUT_VAR, time()+$this->absoluteAuthTimeout);
        $this->afterLogin(false);
    }
    return !$this->getIsGuest();
}

Производит вход пользователя.

Информация об идентификаторе пользователя будет сохранена в хранилище, которое сохраняется в течение сессии пользователя. По умолчанию хранилище — это просто хранилище сессии. Если параметр duration больше 0, будет отправлен cookie для подготовки к входу на основе cookie в будущем.

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

loginRequired() метод

public void loginRequired()

public function loginRequired()
{
    $app=Yii::app();
    $request=$app->getRequest();

    if(!$request->getIsAjaxRequest())
    {
        $this->setReturnUrl($request->getUrl());
        if(($url=$this->loginUrl)!==null)
        {
            if(is_array($url))
            {
                $route=isset($url[0]) ? $url[0] : $app->defaultController;
                $url=$app->createUrl($route,array_splice($url,1));
            }
            $request->redirect($url);
        }
    }
    elseif(isset($this->loginRequiredAjaxResponse))
    {
        echo $this->loginRequiredAjaxResponse;
        Yii::app()->end();
    }

    throw new CHttpException(403,Yii::t('yii','Login Required'));
}

Перенаправляет браузер пользователя на страницу входа в систему. Перед перенаправлением текущий URL (если это не URL AJAX) будет сохранён в returnUrl, чтобы браузер пользователя мог быть перенаправлен обратно на текущую страницу после успешного входа в систему. Убедитесь, что вы установили loginUrl, чтобы браузер пользователя мог быть перенаправлен на указанный URL входа после вызова этого метода. После вызова этого метода обработка текущего запроса будет завершена.

logout() метод

public void logout(boolean $destroySession=true)

public function logout($destroySession=true)
{
    if($this->beforeLogout())
    {
        if($this->allowAutoLogin)
        {
            Yii::app()->getRequest()->getCookies()->remove($this->getStateKeyPrefix());
            if($this->identityCookie!==null)
            {
                $cookie=$this->createIdentityCookie($this->getStateKeyPrefix());
                $cookie->value=null;
                $cookie->expire=0;
                Yii::app()->getRequest()->getCookies()->add($cookie->name,$cookie);
            }
        }
        if($destroySession)
            Yii::app()->getSession()->destroy();
        else
            $this->clearStates();
        $this->_access=array();
        $this->afterLogout();
    }
}

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

renewCookie() метод (доступен с версии v1.1.3)

protected void renewCookie()

protected function renewCookie()
{
    $request=Yii::app()->getRequest();
    $cookies=$request->getCookies();
    $cookie=$cookies->itemAt($this->getStateKeyPrefix());
    if($cookie && !empty($cookie->value) && ($data=Yii::app()->getSecurityManager()->validateData($cookie->value))!==false)
    {
        $data=@unserialize($data);
        if(is_array($data) && isset($data[0],$data[1],$data[2],$data[3]))
        {
            $this->saveToCookie($data[2]);
        }
    }
}

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

restoreFromCookie() метод

protected void restoreFromCookie()

protected function restoreFromCookie()
{
    $app=Yii::app();
    $request=$app->getRequest();
    $cookie=$request->getCookies()->itemAt($this->getStateKeyPrefix());
    if($cookie && !empty($cookie->value) && is_string($cookie->value) && ($data=$app->getSecurityManager()->validateData($cookie->value))!==false)
    {
        $data=@unserialize($data);
        if(is_array($data) && isset($data[0],$data[1],$data[2],$data[3]))
        {
            list($id,$name,$duration,$states)=$data;
            if($this->beforeLogin($id,$states,true))
            {
                $this->changeIdentity($id,$name,$states);
                if($this->autoRenewCookie)
                {
                    $this->saveToCookie($duration);
                }
                $this->afterLogin(true);
            }
        }
    }
}

Заполняет текущий объект пользователя информацией, полученной из cookie. Этот метод используется при автоматическом входе (allowAutoLogin) включен. Информация об идентификаторе пользователя извлекается из cookie. Используются достаточные меры безопасности, чтобы предотвратить несанкционированное изменение данных cookie.

saveIdentityStates() метод

protected array saveIdentityStates()

protected function saveIdentityStates()
{
    $states=array();
    foreach($this->getState(self::STATES_VAR,array()) as $name=>$dummy)
        $states[$name]=$this->getState($name);
    return $states;
}

Извлекает состояния идентификатора из постоянного хранилища и сохраняет их в виде массива.

saveToCookie() метод

protected void saveToCookie(integer $duration)

protected function saveToCookie($duration)
{
    $app=Yii::app();
    $cookie=$this->createIdentityCookie($this->getStateKeyPrefix());
    $cookie->expire=time()+$duration;
    $data=array(
        $this->getId(),
        $this->getName(),
        $duration,
        $this->saveIdentityStates(),
    );
    $cookie->value=$app->getSecurityManager()->hashData(serialize($data));
    $app->getRequest()->getCookies()->add($cookie->name,$cookie);
}

Сохраняет необходимые данные пользователя в cookie. Этот метод используется при включенном автоматическом входе (allowAutoLogin). Данный метод сохраняет идентификатор пользователя, имя пользователя, другие состояния аутентификации и ключ проверки в cookie. Эта информация используется для аутентификации при следующем посещении приложения пользователем.

setFlash() метод

public void setFlash(string $key, mixed $value, mixed $defaultValue=NULL)

public function setFlash($key,$value,$defaultValue=null)
{
    $this->setState(self::FLASH_KEY_PREFIX.$key,$value,$defaultValue);
    $counters=$this->getState(self::FLASH_COUNTERS,array());
    if($value===$defaultValue)
        unset($counters[$key]);
    else
        $counters[$key]=0;
    $this->setState(self::FLASH_COUNTERS,$counters,array());
}

Сохраняет сообщение всплывающей подсказки. Сообщение всплывающей подсказки доступно только в текущем и последующих запросах.

setId() метод

public void setId(mixed $value)

public function setId($value)
{
    $this->setState('__id',$value);
}

setName() метод

public void setName(string $value)

public function setName($value)
{
    $this->setState('__name',$value);
}

Устанавливает уникальный идентификатор пользователя (например, имя пользователя).

setReturnUrl() метод

public void setReturnUrl(string $value)

public function setReturnUrl($value)
{
    $this->setState('__returnUrl',$value);
}

setState() метод

public void setState(string $key, mixed $value, mixed $defaultValue=NULL)

public function setState($key,$value,$defaultValue=null)
{
    $key=$this->getStateKeyPrefix().$key;
    if($value===$defaultValue)
        unset($_SESSION[$key]);
    else
        $_SESSION[$key]=$value;
}

Сохраняет переменную в сессии пользователя.

Эта функция предназначена для использования наследниками класса CWebUser, которые хотят сохранить дополнительную информацию о пользователе в сессии. Сохраняя переменную с помощью этой функции, её можно позже получить с помощью getState. Переменная будет сохраняться между запросами страницы во время сессии пользователя.

setStateKeyPrefix() метод

public void setStateKeyPrefix(string $value)

public function setStateKeyPrefix($value)
{
    $this->_keyPrefix=$value;
}

updateAuthStatus() метод (доступен начиная с v1.1.7)

protected void updateAuthStatus()

protected function updateAuthStatus()
{
    if(($this->authTimeout!==null || $this->absoluteAuthTimeout!==null) && !$this->getIsGuest())
    {
        $expires=$this->getState(self::AUTH_TIMEOUT_VAR);
        $expiresAbsolute=$this->getState(self::AUTH_ABSOLUTE_TIMEOUT_VAR);

        if ($expires!==null && $expires < time() || $expiresAbsolute!==null && $expiresAbsolute < time())
            $this->logout(false);
        else
            $this->setState(self::AUTH_TIMEOUT_VAR,time()+$this->authTimeout);
    }
}

Обновляет статус аутентификации в соответствии с authTimeout. Если пользователь был неактивен в течение authTimeout секунд или истекло время {link absoluteAuthTimeout}, он будет автоматически выведен из системы.

updateFlash() метод

protected void updateFlash()

protected function updateFlash()
{
    $counters=$this->getState(self::FLASH_COUNTERS);
    if(!is_array($counters))
        return;
    foreach($counters as $key=>$count)
    {
        if($count)
        {
            unset($counters[$key]);
            $this->setState(self::FLASH_KEY_PREFIX.$key,null);
        }
        else
            $counters[$key]++;
    }
    $this->setState(self::FLASH_COUNTERS,$counters,array());
}

Обновляет внутренние счётчики для сообщений всплывающей подсказки. Этот метод используется в классе CWebApplication для поддержания доступности сообщений всплывающей подсказки.