0 關注者

類別 yii\behaviors\CacheableWidgetBehavior

所有類別 | 屬性 | 方法
繼承yii\behaviors\CacheableWidgetBehavior » yii\base\Behavior » yii\base\BaseObject
實作yii\base\Configurable
自版本起可用2.0.14
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/behaviors/CacheableWidgetBehavior.php

可快取的小工具行為會根據指定的持續時間和相依性自動快取小工具內容。

如果應用程式已配置 cache 組件，則可以不進行任何配置就使用此行為。預設情況下，小工具將快取一分鐘。

以下範例將無限期地快取文章小工具，直到任何文章被修改為止。

use yii\behaviors\CacheableWidgetBehavior;

public function behaviors()
{
    return [
        [
            'class' => CacheableWidgetBehavior::class,
            'cacheDuration' => 0,
            'cacheDependency' => [
                'class' => 'yii\caching\DbDependency',
                'sql' => 'SELECT MAX(updated_at) FROM posts',
            ],
        ],
    ];
}

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$cache yii\caching\CacheInterface|string|array 快取物件或快取組件 ID，或是用於建立快取物件的配置陣列。 yii\behaviors\CacheableWidgetBehavior
$cacheDependency yii\caching\Dependency|array|null 快取相依性或用於建立快取相依性的配置陣列，或 null 表示沒有快取相依性。 yii\behaviors\CacheableWidgetBehavior
$cacheDuration integer 快取持續時間，以秒為單位。 yii\behaviors\CacheableWidgetBehavior
$cacheEnabled boolean 是否啟用快取。 yii\behaviors\CacheableWidgetBehavior
$cacheKeyVariations string[]|string 字串陣列或單一字串，會導致被快取內容的變化 (例如：應用程式語言、GET 參數)。 yii\behaviors\CacheableWidgetBehavior
$owner yii\base\Component|null 這個行為的擁有者 yii\base\Behavior

公共方法

隱藏繼承的方法

方法 描述 定義於
__call() 呼叫指定的非類別方法。 yii\base\BaseObject
__construct() 建構子。 yii\base\BaseObject
__get() 傳回物件屬性的值。 yii\base\BaseObject
__isset() 檢查屬性是否已設定，亦即已定義且非空值。 yii\base\BaseObject
__set() 設定物件屬性的值。 yii\base\BaseObject
__unset() 設定物件屬性為空值。 yii\base\BaseObject
afterRun() 輸出小工具內容並結束片段快取。 yii\behaviors\CacheableWidgetBehavior
attach() 將行為物件附加到元件。 yii\behaviors\CacheableWidgetBehavior
beforeRun() 開始片段快取。如果可以從快取中擷取其內容，則防止擁有者小工具執行。 yii\behaviors\CacheableWidgetBehavior
canGetProperty() 傳回一個值，指示屬性是否可以讀取。 yii\base\BaseObject
canSetProperty() 傳回一個值，指示屬性是否可以設定。 yii\base\BaseObject
className() 傳回此類別的完整限定名稱。 yii\base\BaseObject
detach() 從元件中分離行為物件。 yii\base\Behavior
events() 為 $owner 的事件宣告事件處理器。 yii\base\Behavior
hasMethod() 傳回一個值，指示方法是否已定義。 yii\base\BaseObject
hasProperty() 傳回一個值，指示屬性是否已定義。 yii\base\BaseObject
init() 初始化物件。 yii\base\BaseObject

屬性詳情

隱藏繼承的屬性

$cache public property

快取物件、快取元件 ID 或用於建立快取物件的組態陣列。預設為 cache 應用程式元件。

public yii\caching\CacheInterface|string|array $cache = 'cache'
$cacheDependency public property

快取相依性或用於建立快取相依性的配置陣列，或 null 表示沒有快取相依性。

例如，

[
    'class' => 'yii\caching\DbDependency',
    'sql' => 'SELECT MAX(updated_at) FROM posts',
]

將使小工具快取依賴於所有文章的上次修改時間。如果任何文章的修改時間變更，快取內容將會失效。

public yii\caching\Dependency|array|null $cacheDependency = null
$cacheDuration public property

快取持續時間（以秒為單位）。設定為 0 表示快取資料永遠不會過期。預設為 60 秒或 1 分鐘。

public integer $cacheDuration = 60
$cacheEnabled public property

是否啟用快取。允許根據特定條件開啟和關閉小工具快取。以下組態將在傳遞特殊 GET 參數時停用快取。

empty(Yii::$app->request->get('disable-caching'))
public boolean $cacheEnabled = true
$cacheKeyVariations public property

字串陣列或單一字串，會導致被快取內容的變化 (例如：應用程式語言、GET 參數)。

以下變更設定將導致內容根據目前的應用程式語言以不同版本快取。

[
    Yii::$app->language,
]
public string[]|string $cacheKeyVariations = []

方法詳情

隱藏繼承的方法

__call() public method

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

呼叫指定的非類別方法。

請勿直接呼叫此方法，因為它是 PHP 的魔術方法，當呼叫不明方法時會隱式呼叫。

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

方法名稱
$params 陣列

方法參數
傳回 mixed

方法傳回值
拋出 yii\base\UnknownMethodException

當呼叫不明方法時

 

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

定義於： 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() public method

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

傳回物件屬性的值。

請勿直接呼叫此方法，因為它是 PHP 的魔術方法，當執行 $value = $object->property; 時會隱式呼叫。

另請參閱 __set()。

public mixed __get ( $name )
$name 字串

屬性名稱
傳回 mixed

屬性值
拋出 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() public method

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

檢查屬性是否已設定，亦即已定義且非空值。

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

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

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

public boolean __isset ( $name )
$name 字串

屬性名稱或事件名稱
傳回 boolean

名稱屬性是否已設定（非空值）。

 

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

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

設定物件屬性的值。

請勿直接呼叫此方法，因為它是 PHP 的魔術方法，當執行 $object->property = $value; 時會隱式呼叫。

另請參閱 __get()。

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

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

屬性值
拋出 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() public method

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

設定物件屬性為空值。

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

請注意，如果屬性未定義，此方法將不會執行任何動作。如果屬性為唯讀，則會拋出例外。

另請參閱 https://php.dev.org.tw/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);
    }
}
afterRun() public method

輸出小工具內容並結束片段快取。

public void afterRun ( $event )
$event yii\base\WidgetEvent

Widget::EVENT_AFTER_RUN 事件。

 

                public function afterRun($event)
{
    echo $event->result;
    $event->result = null;
    $this->owner->view->endCache();
}
attach() public method

將行為物件附加到元件。

預設實作將設定 $owner 屬性，並附加在 events() 中宣告的事件處理器。如果您覆寫此方法，請務必呼叫父類別實作。

public void attach ( $owner )
$owner yii\base\Component

此行為要附加到的元件。

 

                public function attach($owner)
{
    parent::attach($owner);
    $this->initializeEventHandlers();
}
beforeRun() public method

開始片段快取。如果可以從快取中擷取其內容，則防止擁有者小工具執行。

public void beforeRun ( $event )
$event yii\base\WidgetEvent

Widget::EVENT_BEFORE_RUN 事件。

 

                public function beforeRun($event)
{
    $cacheKey = $this->getCacheKey();
    $fragmentCacheConfiguration = $this->getFragmentCacheConfiguration();
    if (!$this->owner->view->beginCache($cacheKey, $fragmentCacheConfiguration)) {
        $event->isValid = false;
    }
}
canGetProperty() public method

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

傳回一個值，指示屬性是否可以讀取。

如果屬性可讀取

  • 類別具有與指定名稱相關聯的 getter 方法（在此情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；

另請參閱 canSetProperty()。

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

屬性名稱
$checkVars boolean

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

屬性是否可以讀取

 

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

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

傳回一個值，指示屬性是否可以設定。

如果屬性可寫入

  • 類別具有與指定名稱相關聯的 setter 方法（在此情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；

另請參閱 canGetProperty()。

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

屬性名稱
$checkVars boolean

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

屬性是否可以寫入

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() public static method
自 2.0.14 版起已過時。在 PHP >=5.5 上，請改用 ::class。

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

傳回此類別的完整限定名稱。

public static string className ( )
傳回 字串

此類別的完整限定名稱。

 

                public static function className()
{
    return get_called_class();
}
detach() public method

定義於： yii\base\Behavior::detach()

從元件中分離行為物件。

預設實作將取消設定 $owner 屬性，並分離在 events() 中宣告的事件處理器。如果您覆寫此方法，請務必呼叫父類別實作。

public void detach ( )

                public function detach()
{
    if ($this->owner) {
        foreach ($this->_attachedEvents as $event => $handler) {
            $this->owner->off($event, is_string($handler) ? [$this, $handler] : $handler);
        }
        $this->_attachedEvents = [];
        $this->owner = null;
    }
}
events() public method

定義於： yii\base\Behavior::events()

為 $owner 的事件宣告事件處理器。

子類別可以覆寫此方法，以宣告應將哪些 PHP 回呼附加到 $owner 元件的事件。

當行為附加到擁有者時，回呼將附加到 $owner 的事件；當行為從元件中分離時，它們將從事件中分離。

回呼可以是下列任何一種

  • 此行為中的方法：'handleClick'，相當於 [$this, 'handleClick']
  • 物件方法：[$object, 'handleClick']
  • 靜態方法：['Page', 'handleClick']
  • 匿名函式：function ($event) { ... }

以下是一個範例

[
    Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
    Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]
public array events ( )
傳回 陣列

事件（陣列鍵）和對應的事件處理器方法（陣列值）。

 

                public function events()
{
    return [];
}
hasMethod() public method

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

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

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

public boolean hasMethod ( $name )
$name 字串

方法名稱
傳回 boolean

方法是否已定義

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() public method

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

傳回一個值，指示屬性是否已定義。

如果屬性已定義

  • 類別具有與指定名稱相關聯的 getter 或 setter 方法（在此情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；

另請參閱

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

屬性名稱
$checkVars boolean

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

屬性是否已定義

 

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

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

初始化物件。

在使用給定組態初始化物件之後，會在建構子結尾呼叫此方法。

public void init ( )

                public function init()
{
}