CFileCache

Property Details

cacheFileMode property (available since v1.1.16)

public integer $cacheFileMode;

the permission to be set for new cache files. This value will be used by PHP chmod function. Defaults to 0666, meaning the file is read-writable by all users.

cacheFileSuffix property

public string $cacheFileSuffix;

cache file suffix. Defaults to '.bin'.

cachePath property

public string $cachePath;

the directory to store cache files. Defaults to null, meaning using 'protected/runtime/cache' as the directory.

cachePathMode property (available since v1.1.16)

public integer $cachePathMode;

the permission to be set for directory to store cache files This value will be used by PHP chmod function. Defaults to 0777, meaning the directory can be read, written and executed by all users.

directoryLevel property

public integer $directoryLevel;

the level of sub-directories to store cache files. Defaults to 0, meaning no sub-directories. If the system has huge number of cache files (e.g. 10K+), you may want to set this value to be 1 or 2 so that the file system is not over burdened. The value of this property should not exceed 16 (less than 3 is recommended).

embedExpiry property (available since v1.1.14)

public boolean $embedExpiry;

whether cache entry expiration time should be embedded into a physical file. Defaults to false meaning that the file modification time will be used to store expire value. True value means that first ten bytes of the file would be reserved and used to store expiration time. On some systems PHP is not allowed to change file modification time to be in future even with 777 permissions, so this property could be useful in this case.

gCProbability property

public integer getGCProbability()
public void setGCProbability(integer $value)

the probability (parts per million) that garbage collection (GC) should be performed when storing a piece of data in the cache. Defaults to 100, meaning 0.01% chance.

Method Details

addValue() method

protected boolean addValue(string $key, string $value, integer $expire)

protected function addValue($key,$value,$expire)
{
    $cacheFile=$this->getCacheFile($key);
    if($this->filemtime($cacheFile)>time())
        return false;
    return $this->setValue($key,$value,$expire);
}

Stores a value identified by a key into cache if the cache does not contain this key. This is the implementation of the method declared in the parent class.

deleteValue() method

protected boolean deleteValue(string $key)

protected function deleteValue($key)
{
    $cacheFile=$this->getCacheFile($key);
    return @unlink($cacheFile);
}

Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class.

flushValues() method (available since v1.1.5)

protected boolean flushValues()

protected function flushValues()
{
    $this->gc(false);
    return true;
}

Deletes all values from cache. This is the implementation of the method declared in the parent class.

gc() method

public void gc(boolean $expiredOnly=true, string $path=NULL)

public function gc($expiredOnly=true,$path=null)
{
    if($path===null)
        $path=$this->cachePath;
    if(($handle=opendir($path))===false)
        return;
    while(($file=readdir($handle))!==false)
    {
        if($file[0]==='.')
            continue;
        $fullPath=$path.DIRECTORY_SEPARATOR.$file;
        if(is_dir($fullPath))
            $this->gc($expiredOnly,$fullPath);
        elseif($expiredOnly && $this->filemtime($fullPath)<time() || !$expiredOnly)
            @unlink($fullPath);
    }
    closedir($handle);
}

Removes expired cache files.

getCacheFile() method

protected string getCacheFile(string $key)

protected function getCacheFile($key)
{
    if($this->directoryLevel>0)
    {
        $base=$this->cachePath;
        for($i=0;$i<$this->directoryLevel;++$i)
        {
            if(($prefix=substr($key,$i+$i,2))!==false)
                $base.=DIRECTORY_SEPARATOR.$prefix;
        }
        return $base.DIRECTORY_SEPARATOR.$key.$this->cacheFileSuffix;
    }
    else
        return $this->cachePath.DIRECTORY_SEPARATOR.$key.$this->cacheFileSuffix;
}

Returns the cache file path given the cache key.

getGCProbability() method

public integer getGCProbability()

public function getGCProbability()
{
    return $this->_gcProbability;
}

getValue() method

protected string|boolean getValue(string $key)

protected function getValue($key)
{
    $cacheFile=$this->getCacheFile($key);
    if(($time=$this->filemtime($cacheFile))>time())
        return @file_get_contents($cacheFile,false,null,$this->embedExpiry ? 10 : null);
    elseif($time>0)
        @unlink($cacheFile);
    return false;
}

Retrieves a value from cache with a specified key. This is the implementation of the method declared in the parent class.

init() method

public void init()

public function init()
{
    parent::init();
    if($this->cachePath===null)
        $this->cachePath=Yii::app()->getRuntimePath().DIRECTORY_SEPARATOR.'cache';
    if(!is_dir($this->cachePath))
    {
        mkdir($this->cachePath,$this->cachePathMode,true);
        chmod($this->cachePath,$this->cachePathMode);
    }
}

Initializes this application component. This method is required by the IApplicationComponent interface.

setGCProbability() method

public void setGCProbability(integer $value)

public function setGCProbability($value)
{
    $value=(int)$value;
    if($value<0)
        $value=0;
    if($value>1000000)
        $value=1000000;
    $this->_gcProbability=$value;
}

setValue() method

protected boolean setValue(string $key, string $value, integer $expire)

protected function setValue($key,$value,$expire)
{
    if(!$this->_gced && mt_rand(0,1000000)<$this->_gcProbability)
    {
        $this->gc();
        $this->_gced=true;
    }

    if($expire<=0)
        $expire=31536000; // 1 year
    $expire+=time();

    $cacheFile=$this->getCacheFile($key);
    if($this->directoryLevel>0)
    {
        $cacheDir=dirname($cacheFile);
        @mkdir($cacheDir,$this->cachePathMode,true);
        @chmod($cacheDir,$this->cachePathMode);
    }
    if(@file_put_contents($cacheFile,$this->embedExpiry ? $expire.$value : $value,LOCK_EX)!==false)
    {
        @chmod($cacheFile,$this->cacheFileMode);
        return $this->embedExpiry ? true : @touch($cacheFile,$expire);
    }
    else
        return false;
}

Stores a value identified by a key in cache. This is the implementation of the method declared in the parent class.