CCacheHttpSession

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

cacheID свойство

public string $cacheID;

Идентификатор компонента приложения кеша. По умолчанию 'cache' (основной компонент кеша приложения).

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

public boolean getUseCustomStorage()

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

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

calculateKey() метод

protected string calculateKey(string $id)

protected function calculateKey($id)
{
    return self::CACHE_KEY_PREFIX.$id;
}

Генерирует уникальный ключ для хранения данных сеанса в кэше.

destroySession() метод

public boolean destroySession(string $id)

public function destroySession($id)
{
    $this->_cache->delete($this->calculateKey($id));
    return true;
}

Обработчик уничтожения сеанса. Не вызывать этот метод напрямую.

Начиная с версии 1.1.18, этот метод всегда возвращает true. Подробнее см. https://github.com/yiisoft/yii/issues/4020

getUseCustomStorage() метод

public boolean getUseCustomStorage()

public function getUseCustomStorage()
{
    return true;
}

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

init() метод

public void init()

public function init()
{
    $this->_cache=Yii::app()->getComponent($this->cacheID);
    if(!($this->_cache instanceof ICache))
        throw new CException(Yii::t('yii','CCacheHttpSession.cacheID is invalid. Please make sure "{id}" refers to a valid cache application component.',
            array('{id}'=>$this->cacheID)));
    parent::init();
}

Инициализирует компонент приложения. Этот метод переопределяет реализацию родительского класса, проверяя доступность кеша.

readSession() метод

public string readSession(string $id)

public function readSession($id)
{
    $data=$this->_cache->get($this->calculateKey($id));
    return $data===false?'':$data;
}

Обработчик чтения сеанса. Не вызывать этот метод напрямую.

writeSession() метод

public boolean writeSession(string $id, string $data)

public function writeSession($id,$data)
{
    return $this->_cache->set($this->calculateKey($id),$data,$this->getTimeout());
}

Обработчик записи сеанса. Не вызывать этот метод напрямую.