0 关注者

类 yii\caching\FileDependency

所有类 | 属性 | 方法
继承yii\caching\FileDependency » yii\caching\Dependency » yii\base\BaseObject
实现yii\base\Configurable
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/caching/FileDependency.php

FileDependency 代表一个基于文件最后修改时间的依赖关系。

如果通过 $fileName 指定的文件的最后修改时间发生了改变，则该依赖关系被认为发生了改变。

有关缓存的更多详细信息和使用信息，请参阅缓存指南文章。

公共属性

隐藏继承属性

属性 类型 描述 定义于
$data 混合 保存在缓存中的依赖关系数据，之后会与最新的依赖关系数据进行比较。 yii\caching\Dependency
$fileName 字符串 文件的路径或 路径别名，其最后修改时间用于检查依赖关系是否已更改。 yii\caching\FileDependency
$reusable 布尔值 该依赖关系是否可重用。 yii\caching\Dependency

公共方法

隐藏继承方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\BaseObject
__construct() 构造函数。 yii\base\BaseObject
__get() 返回对象属性的值。 yii\base\BaseObject
__isset() 检查属性是否已设置，即已定义且不为空。 yii\base\BaseObject
__set() 设置对象属性的值。 yii\base\BaseObject
__unset() 将对象属性设置为 null。 yii\base\BaseObject
canGetProperty() 返回一个值，指示属性是否可读。 yii\base\BaseObject
canSetProperty() 返回一个值，指示属性是否可写。 yii\base\BaseObject
className() 返回此类的完全限定名称。 yii\base\BaseObject
evaluateDependency() 通过生成和保存与依赖关系相关的数据来评估依赖关系。 yii\caching\Dependency
getHasChanged() 返回一个值，指示依赖关系是否已更改。 yii\caching\Dependency
hasMethod() 返回一个值，指示方法是否已定义。 yii\base\BaseObject
hasProperty() 返回一个值，指示属性是否已定义。 yii\base\BaseObject
init() 初始化对象。 yii\base\BaseObject
isChanged() 检查依赖关系是否已更改。 yii\caching\Dependency
resetReusableData() 重置可重用依赖关系的所有缓存数据。 yii\caching\Dependency

受保护方法

隐藏继承方法

方法 描述 定义于
generateDependencyData() 生成确定依赖关系是否已更改所需的数据。 yii\caching\FileDependency
generateReusableHash() 生成一个可用于检索可重用依赖关系数据的唯一哈希值。 yii\caching\Dependency

属性详细信息

隐藏继承属性

$fileName 公共属性

文件的路径或 路径别名，其最后修改时间用于检查依赖关系是否已更改。

public string $fileName = null

方法详细信息

隐藏继承方法

__call() 公共方法

定义于: yii\base\BaseObject::__call()

调用不是类方法的命名方法。

不要直接调用此方法，因为它是一个 PHP 魔术方法，当调用未知方法时会隐式调用它。

public mixed __call ( $name, $params )
$name 字符串

方法名称
$params 数组

方法参数
返回值 混合

方法返回值
抛出 yii\base\UnknownMethodException

当调用未知方法时

 

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__construct() 公共方法

定义于: yii\base\BaseObject::__construct()

构造函数。

默认实现做两件事

  • 使用给定的配置 $config 初始化对象。
  • 调用 init()。

如果此方法在子类中被重写，建议

  • 构造函数的最后一个参数是一个配置数组，就像这里 $config 一样。
  • 在构造函数的末尾调用父类的实现。
public void __construct ( $config = [] )
$config 数组

用于初始化对象属性的名称-值对

 

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}
__get() 公共方法

定义于: yii\base\BaseObject::__get()

返回对象属性的值。

不要直接调用此方法，因为它是一个 PHP 魔术方法，当执行 $value = $object->property; 时会隐式调用它。

另请参阅 __set()。

public 混合类型 __get ( $name )
$name 字符串

属性名称
返回值 混合

属性值
抛出 yii\base\UnknownPropertyException

如果属性未定义
抛出 yii\base\InvalidCallException

如果属性为只写

 

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter();
    } elseif (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
__isset() 公共方法

定义于： yii\base\BaseObject::__isset()

检查属性是否已设置，即已定义且不为空。

不要直接调用此方法，因为它是一个 PHP 魔术方法，会在执行 isset($object->property) 时被隐式调用。

请注意，如果属性未定义，将返回 false。

另请参见 https://php.ac.cn/manual/en/function.isset.php.

public 布尔值 __isset ( $name )
$name 字符串

属性名称或事件名称
返回值 布尔值

命名的属性是否已设置（不为空）。

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() 公共方法

定义于： yii\base\BaseObject::__set()

设置对象属性的值。

不要直接调用此方法，因为它是一个 PHP 魔术方法，会在执行 $object->property = $value; 时被隐式调用。

另请参见 __get().

public void __set ( $name, $value )
$name 字符串

属性名称或事件名称
$value 混合

属性值
抛出 yii\base\UnknownPropertyException

如果属性未定义
抛出 yii\base\InvalidCallException

如果属性为只读

 

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}
__unset() 公共方法

定义于： yii\base\BaseObject::__unset()

将对象属性设置为 null。

不要直接调用此方法，因为它是一个 PHP 魔术方法，会在执行 unset($object->property) 时被隐式调用。

请注意，如果属性未定义，此方法将不会执行任何操作。如果属性为只读，它将抛出异常。

另请参见 https://php.ac.cn/manual/en/function.unset.php.

public void __unset ( $name )
$name 字符串

属性名称
抛出 yii\base\InvalidCallException

如果属性为只读。

 

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}
canGetProperty() 公共方法

定义于： yii\base\BaseObject::canGetProperty()

返回一个值，指示属性是否可读。

一个属性是可读的，如果

  • 该类具有与指定名称关联的 getter 方法（在这种情况下，属性名称不区分大小写）；
  • 该类具有与指定名称相匹配的成员变量（当 $checkVars 为 true 时）；

另请参见 canSetProperty().

public 布尔值 canGetProperty ( $name, $checkVars = true )
$name 字符串

属性名称
$checkVars 布尔值

是否将成员变量视为属性
返回值 布尔值

属性是否可读

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() 公共方法

定义于： yii\base\BaseObject::canSetProperty()

返回一个值，指示属性是否可写。

一个属性是可写的，如果

  • 该类具有与指定名称关联的 setter 方法（在这种情况下，属性名称不区分大小写）；
  • 该类具有与指定名称相匹配的成员变量（当 $checkVars 为 true 时）；

另请参见 canGetProperty().

public 布尔值 canSetProperty ( $name, $checkVars = true )
$name 字符串

属性名称
$checkVars 布尔值

是否将成员变量视为属性
返回值 布尔值

属性是否可写

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() 公共静态方法
自 2.0.14 版起已弃用。在 PHP >=5.5 中，请使用 ::class 代替。

定义于： yii\base\BaseObject::className()

返回此类的完全限定名称。

public static 字符串 className ( )
返回值 字符串

此类的完全限定名称。

 

                public static function className()
{
    return get_called_class();
}
evaluateDependency() 公共方法

定义于： yii\caching\Dependency::evaluateDependency()

通过生成和保存与依赖关系相关的数据来评估依赖关系。

此方法由缓存调用，用于在将数据写入缓存之前进行评估。

public void evaluateDependency ( $cache )
$cache yii\caching\CacheInterface

当前正在评估此依赖关系的缓存组件

 

                public function evaluateDependency($cache)
{
    if ($this->reusable) {
        $hash = $this->generateReusableHash();
        if (!array_key_exists($hash, self::$_reusableData)) {
            self::$_reusableData[$hash] = $this->generateDependencyData($cache);
        }
        $this->data = self::$_reusableData[$hash];
    } else {
        $this->data = $this->generateDependencyData($cache);
    }
}
generateDependencyData() 受保护方法

生成确定依赖关系是否已更改所需的数据。

此方法返回文件的最后修改时间。

protected 混合类型 generateDependencyData ( $cache )
$cache yii\caching\CacheInterface

当前正在评估此依赖关系的缓存组件
返回值 混合

用于确定依赖关系是否已更改所需的数据。
抛出 yii\base\InvalidConfigException

如果 $fileName 未设置

 

                protected function generateDependencyData($cache)
{
    if ($this->fileName === null) {
        throw new InvalidConfigException('FileDependency::fileName must be set');
    }
    $fileName = Yii::getAlias($this->fileName);
    clearstatcache(false, $fileName);
    return @filemtime($fileName);
}
generateReusableHash() 受保护方法

定义于： yii\caching\Dependency::generateReusableHash()

生成一个可用于检索可重用依赖关系数据的唯一哈希值。

另请参见 $reusable.

protected 字符串 generateReusableHash ( )
返回值 字符串

此缓存依赖关系的唯一哈希值。

 

                protected function generateReusableHash()
{
    $clone = clone $this;
    $clone->data = null; // https://github.com/yiisoft/yii2/issues/3052
    try {
        $serialized = serialize($clone);
    } catch (\Exception $e) {
        // unserializable properties are nulled
        foreach ($clone as $name => $value) {
            if (is_object($value) && $value instanceof \Closure) {
                $clone->{$name} = null;
            }
        }
        $serialized = serialize($clone);
    }
    return sha1($serialized);
}
getHasChanged() 公共方法
自 2.0.11 版起已弃用。将在 2.1 版中移除。请使用 isChanged() 代替。

定义于： yii\caching\Dependency::getHasChanged()

返回一个值，指示依赖关系是否已更改。

public 布尔值 getHasChanged ( $cache )
$cache yii\caching\CacheInterface

当前正在评估此依赖关系的缓存组件
返回值 布尔值

依赖关系是否已更改。

 

                public function getHasChanged($cache)
{
    return $this->isChanged($cache);
}
hasMethod() 公共方法

定义于： yii\base\BaseObject::hasMethod()

返回一个值，指示方法是否已定义。

默认实现调用 php 函数 method_exists()。当您实现 php 魔术方法 __call() 时，您可以重写此方法。

public 布尔值 hasMethod ( $name )
$name 字符串

方法名称
返回值 布尔值

方法是否已定义

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() 公共方法

定义于: yii\base\BaseObject::hasProperty()

返回一个值，指示属性是否已定义。

如果定义了属性，则

  • 该类具有与指定名称关联的 getter 或 setter 方法（在这种情况下，属性名称不区分大小写）；
  • 该类具有与指定名称相匹配的成员变量（当 $checkVars 为 true 时）；

另请参阅

public boolean hasProperty ( $name, $checkVars = true )
$name 字符串

属性名称
$checkVars 布尔值

是否将成员变量视为属性
返回值 布尔值

属性是否已定义

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() 公共方法

定义于: yii\base\BaseObject::init()

初始化对象。

此方法在构造函数结束时被调用，此时对象已使用给定的配置初始化。

public void init ( )

                public function init()
{
}
isChanged() 公共方法 (自版本 2.0.11 起可用)

定义于: yii\caching\Dependency::isChanged()

检查依赖关系是否已更改。

public boolean isChanged ( $cache )
$cache yii\caching\CacheInterface

当前正在评估此依赖关系的缓存组件
返回值 布尔值

依赖关系是否已更改。

 

                public function isChanged($cache)
{
    if ($this->reusable) {
        $hash = $this->generateReusableHash();
        if (!array_key_exists($hash, self::$_reusableData)) {
            self::$_reusableData[$hash] = $this->generateDependencyData($cache);
        }
        $data = self::$_reusableData[$hash];
    } else {
        $data = $this->generateDependencyData($cache);
    }
    return $data !== $this->data;
}
resetReusableData() 公共静态方法

定义于: yii\caching\Dependency::resetReusableData()

重置可重用依赖关系的所有缓存数据。

public static void resetReusableData ( )

                public static function resetReusableData()
{
    self::$_reusableData = [];
}