CDirectoryCacheDependency
优质
小牛编辑
134浏览
2023-12-01
所有包 | 属性 | 方法
CDirectoryCacheDependency指基于目录改变的依赖项。
CDirectoryCacheDependency执行基于指定目录下 文件修改时间的依赖项检查。 被检查的目录通过directory指定。
默认情况下，所有在指定目录及其子目录下的文件都会 被检查。若任意文件的最后修改时间改变， 或者文件数目变化， 则认为依赖项改变了。指定recursiveLevel 以限制检查目录的深度。
注意，目录的依赖项检查消耗很高，因为它涉及到 访问目录下多个文件的修改时间。
源码： framework/caching/dependencies/CDirectoryCacheDependency.php#56 (显示)
源码： framework/caching/dependencies/CDirectoryCacheDependency.php#66 (显示)
源码： framework/caching/dependencies/CDirectoryCacheDependency.php#81 (显示)
源码： framework/caching/dependencies/CDirectoryCacheDependency.php#130 (显示)
源码： framework/caching/dependencies/CDirectoryCacheDependency.php#117 (显示)
| 包 | system.caching.dependencies |
|---|---|
| 继承 | class CDirectoryCacheDependency » CCacheDependency » CComponent |
| 实现 | ICacheDependency |
| 源自 | 1.0 |
| 版本 | $Id: CDirectoryCacheDependency.php 3500 2011-12-20 16:25:43Z mdomba $ |
| 源码 | framework/caching/dependencies/CDirectoryCacheDependency.php |
CDirectoryCacheDependency执行基于指定目录下 文件修改时间的依赖项检查。 被检查的目录通过directory指定。
默认情况下，所有在指定目录及其子目录下的文件都会 被检查。若任意文件的最后修改时间改变， 或者文件数目变化， 则认为依赖项改变了。指定recursiveLevel 以限制检查目录的深度。
注意，目录的依赖项检查消耗很高，因为它涉及到 访问目录下多个文件的修改时间。
公共属性
隐藏继承属性
| 属性 | 类型 | 描述 | 定义在 |
|---|---|---|---|
| dependentData | mixed | 用以决定依赖项是否被改变的数据。 这些数据是可用的在evaluateDependency被调用后。 | CCacheDependency |
| directory | string | 用以决定依赖项是否被改变的目录。 该目录下的任何文件被改变，则认为依赖项改变了。 | CDirectoryCacheDependency |
| hasChanged | boolean | 依赖项是否被改变。 | CCacheDependency |
| namePattern | string | 匹配有效文件名或目录名的正则表达式。 只有匹配的文件或者目录会被检查是否改变。 默认为null，意味着所有文件或目录都匹配。 | CDirectoryCacheDependency |
| recursiveLevel | integer | 递归检查的子目录深度。 若该值小于0，它意味着不限制深度。If the value is less than 0, it means unlimited depth. | CDirectoryCacheDependency |
公共方法
隐藏继承方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| __call() | 如果类中没有调的方法名，则调用这个方法。 | CComponent |
| __construct() | 构造器。 | CDirectoryCacheDependency |
| __get() | 返回一个属性值、一个事件处理程序列表或一个行为名称。 | CComponent |
| __isset() | 检查一个属性是否为null。 | CComponent |
| __set() | 设置一个组件的属性值。 | CComponent |
| __unset() | 设置一个组件的属性为null。 | CComponent |
| asa() | 返回这个名字的行为对象。 | CComponent |
| attachBehavior() | 附加一个行为到组件。 | CComponent |
| attachBehaviors() | 附加一个行为列表到组件。 | CComponent |
| attachEventHandler() | 为事件附加一个事件处理程序。 | CComponent |
| canGetProperty() | 确定属性是否可读。 | CComponent |
| canSetProperty() | 确定属性是否可写。 | CComponent |
| detachBehavior() | 从组件中分离一个行为。 | CComponent |
| detachBehaviors() | 从组件中分离所有行为。 | CComponent |
| detachEventHandler() | 分离一个存在的事件处理程序。 | CComponent |
| disableBehavior() | 禁用一个附加行为。 | CComponent |
| disableBehaviors() | 禁用组件附加的所有行为。 | CComponent |
| enableBehavior() | 启用一个附加行为。 | CComponent |
| enableBehaviors() | 启用组件附加的所有行为。 | CComponent |
| evaluateDependency() | 根据依赖关系来生存和保存数据以计算依赖项。 | CCacheDependency |
| evaluateExpression() | 计算一个PHP表达式，或根据组件上下文执行回调。 | CComponent |
| getDependentData() | 返回用以决定依赖项是否被改变的数据。 这些数据是可用的在evaluateDependency被调用后。 | CCacheDependency |
| getEventHandlers() | 返回一个事件的附加处理程序列表。 | CComponent |
| getHasChanged() | 返回依赖项是否被改变。 | CCacheDependency |
| hasEvent() | 确定一个事件是否定义。 | CComponent |
| hasEventHandler() | 检查事件是否有附加的处理程序。 | CComponent |
| hasProperty() | 确定属性是否被定义。 | CComponent |
| raiseEvent() | 发起一个事件。 | CComponent |
受保护方法
隐藏继承方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| generateDependentData() | 生成决定依赖项是否被改变需要的数据。 | CDirectoryCacheDependency |
| generateTimestamps() | 确定目录下文件的最后修改时间。 | CDirectoryCacheDependency |
| validateDirectory() | 检查以查看指定子目录是否应该为依赖项被检查。 | CDirectoryCacheDependency |
| validateFile() | 检查以查看该文件是否应该为依赖项被检查。 | CDirectoryCacheDependency |
属性详细
directory 属性 public string $directory;用以决定依赖项是否被改变的目录。 该目录下的任何文件被改变，则认为依赖项改变了。
namePattern 属性 public string $namePattern;匹配有效文件名或目录名的正则表达式。 只有匹配的文件或者目录会被检查是否改变。 默认为null，意味着所有文件或目录都匹配。
recursiveLevel 属性 public integer $recursiveLevel;递归检查的子目录深度。 若该值小于0，它意味着不限制深度。If the value is less than 0, it means unlimited depth. 若该值为0，它意味着只检查指定目录下的文件。
方法详细
__construct() 方法| public void __construct(string $directory=NULL) | ||
| $directory | string | 被检查的目录。 |
publicfunction__construct($directory=null)
{
$this->directory=$directory;
}构造器。
generateDependentData() 方法| protected mixed generateDependentData() | ||
| {return} | mixed | 决定依赖项是否被改变需要的数据。 |
protectedfunctiongenerateDependentData()
{
if($this->directory!==null)
return$this->generateTimestamps($this->directory);
else
thrownewCException(Yii::t('yii','CDirectoryCacheDependency.directorycannotbeempty.'));
}生成决定依赖项是否被改变需要的数据。 该方法返回目录下的文件修改时间戳。
generateTimestamps() 方法| protected array generateTimestamps(string $directory, integer $level=0) | ||
| $directory | string | 目录名 |
| $level | integer | 递归级别 |
| {return} | array | 以文件路径为索引的文件修改时间列表 |
protectedfunctiongenerateTimestamps($directory,$level=0)
{
if(($dir=@opendir($directory))===false)
thrownewCException(Yii::t('yii','"{path}"isnotavaliddirectory.',
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) | ||
| $directory | string | 可能为依赖项被检查的目录名。 |
| {return} | boolean | 该子目录是否应该被检查。 |
protectedfunctionvalidateDirectory($directory)
{
returntrue;
}检查以查看指定子目录是否应该为依赖项被检查。 该方法在整个目录的依赖项被检查时调用。 默认情况下，它总是返回true，即该子目录应该被检查。 你可以重写此方法只检查特定的子目录。
validateFile() 方法| protected boolean validateFile(string $fileName) | ||
| $fileName | string | 可能为依赖项被检查的文件名。 |
| {return} | boolean | 该文件是否应该被检查。 |
protectedfunctionvalidateFile($fileName)
{
returntrue;
}检查以查看该文件是否应该为依赖项被检查。 该方法在整个目录的依赖项被检查时调用。 默认情况下，它总是返回true，即该文件应该被检查。 你可以重写此方法只检查特定的文件。