CDirectoryCacheDependency

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

directory свойство

public string $directory;

директория, изменение которой используется для определения, была ли изменена зависимость. Если любой из файлов в директории изменен, зависимость считается изменённой.

namePattern свойство

public string $namePattern;

регулярное выражение для сопоставления допустимых имён файлов/каталогов. Только соответствующие файлы или каталоги будут проверяться на изменения. По умолчанию равно null, что означает, что все файлы/каталоги подходят.

recursiveLevel свойство

public integer $recursiveLevel;

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

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

__construct() метод

public void __construct(string $directory=NULL)

public function __construct($directory=null)
{
    $this->directory=$directory;
}

Конструктор.

generateDependentData() метод

protected mixed generateDependentData()

protected function generateDependentData()
{
    if($this->directory!==null)
        return $this->generateTimestamps($this->directory);
    else
        throw new CException(Yii::t('yii','CDirectoryCacheDependency.directory cannot be empty.'));
}

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

generateTimestamps() метод

protected array generateTimestamps(string $directory, integer $level=0)

protected function generateTimestamps($directory,$level=0)
{
    if(($dir=@opendir($directory))===false)
        throw new CException(Yii::t('yii','"{path}" is not a valid directory.',
            array('{path}'=>$directory)));
    $timestamps=array();
    while(($file=readdir($dir))!==false)
    {
        $path=$directory.DIRECTORY_SEPARATOR.$file;
        if($file==='.' || $file==='..')
            continue;
        if($this->namePattern!==null && !preg_match($this->namePattern,$file))
            continue;
        if(is_file($path))
        {
            if($this->validateFile($path))
                $timestamps[$path]=filemtime($path);
        }
        else
        {
            if(($this->recursiveLevel<0 || $level<$this->recursiveLevel) && $this->validateDirectory($path))
                $timestamps=array_merge($timestamps, $this->generateTimestamps($path,$level+1));
        }
    }
    closedir($dir);
    return $timestamps;
}

Определяет время последнего изменения файлов в каталоге. Этот метод может рекурсивно входить во вложенные каталоги, если recursiveLevel не равно 0.

validateDirectory() метод

protected boolean validateDirectory(string $directory)

protected function validateDirectory($directory)
{
    return true;
}

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

validateFile() метод

protected boolean validateFile(string $fileName)

protected function validateFile($fileName)
{
    return true;
}

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