0 关注者

类 yii\caching\ChainedDependency

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

ChainedDependency 代表一个由其他依赖项组成的依赖项。

当 $dependOnAll 为 true 时，如果任何依赖项发生变化，则此依赖项被认为已发生变化；当 $dependOnAll 为 false 时，如果其中一个依赖项没有发生变化，则此依赖项被认为没有发生变化。

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

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$data 混合 保存在缓存中的依赖项数据，之后与最新的依赖项数据进行比较。 yii\caching\Dependency
$dependOnAll 布尔值 此依赖项是否依赖于 $dependencies 中的每个依赖项。 yii\caching\ChainedDependency
$dependencies yii\caching\Dependency[] 此依赖项组成的依赖项列表。每个数组元素必须是一个依赖项对象。 yii\caching\ChainedDependency
$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\ChainedDependency
getHasChanged() 返回一个值，指示依赖项是否已发生变化。 yii\caching\Dependency
hasMethod() 返回一个值，指示方法是否已定义。 yii\base\BaseObject
hasProperty() 返回一个值，指示属性是否已定义。 yii\base\BaseObject
init() 初始化对象。 yii\base\BaseObject
isChanged() 检查依赖项是否已发生变化。 yii\caching\ChainedDependency
resetReusableData() 重置所有可重用依赖项的缓存数据。 yii\caching\Dependency

受保护的方法

隐藏继承的方法

方法 描述 定义于
generateDependencyData() 生成确定依赖项是否已发生变化所需的数据。 yii\caching\ChainedDependency
generateReusableHash() 生成可用于检索可重用依赖项数据的唯一哈希值。 yii\caching\Dependency

属性详细信息

隐藏继承的属性

$dependOnAll 公共属性

此依赖项是否依赖于 $dependencies 中的每个依赖项。默认为 true，表示如果任何依赖项发生变化，则此依赖项被认为已发生变化。当它设置为 false 时，表示如果其中一个依赖项没有发生变化，则此依赖项被认为没有发生变化。

public boolean $dependOnAll = true
$dependencies 公共属性

此依赖项组成的依赖项列表。每个数组元素必须是一个依赖项对象。

public yii\caching\Dependency[] $dependencies = []

方法详细信息

隐藏继承的方法

__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 mixed __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 boolean __isset ( $name )
$name 字符串

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

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

 

                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 boolean 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 boolean 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 string className ( )
返回值 字符串

此类的完全限定名称。

 

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

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

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

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

 

                public function evaluateDependency($cache)
{
    foreach ($this->dependencies as $dependency) {
        $dependency->evaluateDependency($cache);
    }
}
generateDependencyData() 受保护方法

生成确定依赖项是否已发生变化所需的数据。

此方法在此类中不执行任何操作。

protected mixed generateDependencyData ( $cache )
$cache yii\caching\CacheInterface

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

确定依赖项是否已更改所需的数据。

 

                protected function generateDependencyData($cache)
{
    return null;
}
generateReusableHash() 受保护方法

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

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

另见 $reusable。

protected string 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 boolean 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 boolean 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 起可用)

检查依赖项是否已发生变化。

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

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

依赖项是否已更改。

 

                public function isChanged($cache)
{
    foreach ($this->dependencies as $dependency) {
        if ($this->dependOnAll && $dependency->isChanged($cache)) {
            return true;
        } elseif (!$this->dependOnAll && !$dependency->isChanged($cache)) {
            return false;
        }
    }
    return !$this->dependOnAll;
}
resetReusableData() 公共静态方法

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

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

public static void resetReusableData ( )

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