CCacheHttpSession

Property Details

cacheID property

public string $cacheID;

the ID of the cache application component. Defaults to 'cache' (the primary cache application component.)

useCustomStorage property read-only

public boolean getUseCustomStorage()

Returns a value indicating whether to use custom session storage. This method overrides the parent implementation and always returns true.

Method Details

calculateKey() method

protected string calculateKey(string $id)

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

Generates a unique key used for storing session data in cache.

destroySession() method

public boolean destroySession(string $id)

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

Session destroy handler. Do not call this method directly.

Since 1.1.18 release, this method always returns true. Please refer to the following issue for more details: https://github.com/yiisoft/yii/issues/4020

getUseCustomStorage() method

public boolean getUseCustomStorage()

public function getUseCustomStorage()
{
    return true;
}

Returns a value indicating whether to use custom session storage. This method overrides the parent implementation and always returns true.

init() method

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();
}

Initializes the application component. This method overrides the parent implementation by checking if cache is available.

readSession() method

public string readSession(string $id)

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

Session read handler. Do not call this method directly.

writeSession() method

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

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

Session write handler. Do not call this method directly.