CDirectoryCacheDependency

Property Details

directory property

public string $directory;

the directory whose change is used to determine if the dependency has been changed. If any of the files under the directory is changed, the dependency is considered as changed.

namePattern property

public string $namePattern;

the regular expression matching valid file/directory names. Only the matching files or directories will be checked for changes. Defaults to null, meaning all files/directories will qualify.

recursiveLevel property

public integer $recursiveLevel;

the depth of the subdirectories to be recursively checked. If the value is less than 0, it means unlimited depth. If the value is 0, it means checking the files directly under the specified directory.

Method Details

__construct() method

public void __construct(string $directory=NULL)

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

Constructor.

generateDependentData() method

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

Generates the data needed to determine if dependency has been changed. This method returns the modification timestamps for files under the directory.

generateTimestamps() method

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

Determines the last modification time for files under the directory. This method may go recursively into subdirectories if recursiveLevel is not 0.

validateDirectory() method

protected boolean validateDirectory(string $directory)

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

Checks to see if the specified subdirectory should be checked for dependency. This method is invoked when dependency of the whole directory is being checked. By default, it always returns true, meaning the subdirectory should be checked. You may override this method to check only certain subdirectories.

validateFile() method

protected boolean validateFile(string $fileName)

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

Checks to see if the file should be checked for dependency. This method is invoked when dependency of the whole directory is being checked. By default, it always returns true, meaning the file should be checked. You may override this method to check only certain files.