CFileCache

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

cacheFileMode свойство (доступно с версии v1.1.16)

public integer $cacheFileMode;

разрешения, которые будут установлены для новых файлов кэша. Это значение будет использоваться функцией PHP chmod. По умолчанию 0666, что означает, что файл читабелен и записывается всеми пользователями.

cacheFileSuffix свойство

public string $cacheFileSuffix;

приставка имени файла кэша. По умолчанию '.bin'.

cachePath свойство

public string $cachePath;

директория для хранения файлов кэша. По умолчанию null, что означает использование 'protected/runtime/cache' в качестве директории.

cachePathMode свойство (доступно с версии v1.1.16)

public integer $cachePathMode;

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

directoryLevel свойство

public integer $directoryLevel;

уровень поддиректорий для хранения файлов кэша. По умолчанию 0, что означает отсутствие поддиректорий. Если система имеет большое количество файлов кэша (например, 10К+), вы можете установить это значение в 1 или 2, чтобы не перегрузить файловую систему. Значение этого свойства не должно превышать 16 (рекомендуется менее 3).

embedExpiry свойство (доступно начиная с v1.1.14)

public boolean $embedExpiry;

указывает, следует ли время истечения срока действия записи кэша встраивать в физический файл. По умолчанию значение false, что означает, что для хранения значения срока действия будет использоваться время последнего изменения файла. Значение true означает, что первые десять байтов файла будут зарезервированы и использованы для хранения времени истечения срока действия. На некоторых системах PHP запрещено изменять время последнего изменения файла на будущее, даже с разрешениями 777, поэтому это свойство может быть полезно в таком случае.

gCProbability свойство

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

вероятность (частей на миллион), что сборка мусора (GC) должна быть выполнена при сохранении фрагмента данных в кэше. По умолчанию значение 100, что означает 0,01% вероятность.

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

addValue() метод

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

Сохраняет значение, идентифицируемое ключом, в кэше, если в кэше нет значения с таким ключом. Это реализация метода, объявленного в родительском классе.

deleteValue() метод

protected boolean deleteValue(string $key)

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

Удаляет значение с указанным ключом из кэша. Это реализация метода, объявленного в родительском классе.

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

protected boolean flushValues()

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

Удаляет все значения из кэша. Это реализация метода, объявленного в родительском классе.

gc() метод

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

Удаляет файлы кэша, срок действия которых истек.

getCacheFile() метод

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

Возвращает путь к файлу кэша, заданный ключом кэша.

getGCProbability() метод

public integer getGCProbability()

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

getValue() метод

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

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

init() метод

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

Инициализирует компонент приложения. Этот метод требуется интерфейсом IApplicationComponent.

setGCProbability() метод

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() метод

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

Сохраняет значение, идентифицируемое ключом, в кэше. Это реализация метода, объявленного в родительском классе.