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 時，如果其中一個依賴項未變更，則此依賴項被視為未變更。

有關快取 (Cache) 的更多詳細資訊和使用資訊，請參閱快取概觀的指南文章。

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$data mixed 儲存在快取中並在稍後與最新依賴項資料比較的依賴項資料。 yii\caching\Dependency
$dependOnAll boolean 此依賴項是否依賴於 $dependencies 中的每個依賴項。 yii\caching\ChainedDependency
$dependencies yii\caching\Dependency[] 此依賴項組成的依賴項列表。 yii\caching\ChainedDependency
$reusable boolean 此依賴項是否可重複使用。 yii\caching\Dependency

公開方法

隱藏繼承的方法

方法 描述 定義於
__call() 呼叫未定義為類別方法的具名方法。 yii\base\BaseObject
__construct() 建構子。 yii\base\BaseObject
__get() 傳回物件屬性的值。 yii\base\BaseObject
__isset() 檢查屬性是否已設定，即已定義且非 null。 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 string

方法名稱
$params array

方法參數
return mixed

方法回傳值
throws 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 array

將用於初始化物件屬性的名稱-值對

 

                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 string

屬性名稱
return mixed

屬性值
throws yii\base\UnknownPropertyException

如果屬性未定義
throws 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()

檢查屬性是否已設定，即已定義且非 null。

請勿直接呼叫此方法，因為它是一個 PHP 魔術方法，當執行 isset($object->property) 時會被隱式呼叫。

請注意，如果屬性未定義，將會回傳 false。

另請參閱 https://php.dev.org.tw/manual/en/function.isset.php。

public boolean __isset ( $name )
$name string

屬性名稱或事件名稱
return boolean

指示具名屬性是否已設定（非 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 string

屬性名稱或事件名稱
$value mixed

屬性值
throws yii\base\UnknownPropertyException

如果屬性未定義
throws 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.dev.org.tw/manual/en/function.unset.php。

public void __unset ( $name )
$name string

屬性名稱
throws 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 string

屬性名稱
$checkVars boolean

是否將成員變數視為屬性
return boolean

指示屬性是否可讀取

 

                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 string

屬性名稱
$checkVars boolean

是否將成員變數視為屬性
return boolean

指示屬性是否可寫入

 

                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 ( )
return string

此類別的完整限定名稱。

 

                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 method

產生判斷依賴項是否已變更所需的資料。

此方法在此類別中不執行任何動作。

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

目前正在評估此相依性的快取元件
return mixed

判斷相依性是否已變更所需的資料。

 

                protected function generateDependencyData($cache)
{
    return null;
}
generateReusableHash() protected method

定義於： yii\caching\Dependency::generateReusableHash()

產生可用於檢索可重複使用依賴項資料的唯一雜湊。

另請參閱 $reusable。

protected string generateReusableHash ( )
return string

此快取相依性的唯一雜湊值。

 

                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

目前正在評估此相依性的快取元件
return boolean

指示相依性是否已變更。

 

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

定義於： yii\base\BaseObject::hasMethod()

傳回一個值，指示是否已定義方法。

預設實作是對 php 函數 method_exists() 的呼叫。當您實作 php 魔術方法 __call() 時，您可以覆寫此方法。

public boolean hasMethod ( $name )
$name string

方法名稱
return boolean

指示方法是否已定義

 

                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 string

屬性名稱
$checkVars boolean

是否將成員變數視為屬性
return boolean

指示屬性是否已定義

 

                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

目前正在評估此相依性的快取元件
return boolean

指示相依性是否已變更。

 

                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 = [];
}