0 追蹤者

類別 yii\widgets\FragmentCache

繼承關係yii\widgets\FragmentCache » yii\base\Widget » yii\base\Component » yii\base\BaseObject
實作介面yii\base\Configurable, yii\base\DynamicContentAwareInterface, yii\base\ViewContextInterface
使用 Traityii\base\DynamicContentAwareTrait
自版本起可用2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/widgets/FragmentCache.php

FragmentCache 由 yii\base\View 用於提供頁面片段的快取。

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$autoIdPrefix string 自動產生的 Widget ID 的前綴。 yii\base\Widget
$behaviors yii\base\Behavior[] 附加到此元件的行為列表。 yii\base\Component
$cache yii\caching\CacheInterface|array|string 快取物件或快取物件的應用程式元件 ID。 yii\widgets\FragmentCache
$cachedContent string|false 快取的內容。 yii\widgets\FragmentCache
$dependency array|yii\caching\Dependency 快取內容所依賴的依賴關係。 yii\widgets\FragmentCache
$duration integer 資料在快取中保持有效的秒數。 yii\widgets\FragmentCache
$dynamicPlaceholders array 佔位符列表。 yii\base\DynamicContentAwareTrait
$enabled boolean 是否啟用片段快取。 yii\widgets\FragmentCache
$id string|null Widget 的 ID。 yii\base\Widget
$variations string[]|string 導致快取內容變化的因素列表。 yii\widgets\FragmentCache
$view yii\web\View 可用於渲染視圖或視圖檔案的視圖物件。 yii\base\Widget
$viewPath string 包含此 Widget 的視圖檔案的目錄。 yii\base\Widget

公開方法

隱藏繼承的方法

方法 描述 定義於
__call() 呼叫非類別方法的具名方法。 yii\base\Component
__clone() 在透過複製現有物件建立物件後,會呼叫此方法。 yii\base\Component
__construct() 建構子。 yii\base\BaseObject
__get() 傳回元件屬性的值。 yii\base\Component
__isset() 檢查屬性是否已設定,即已定義且非 null。 yii\base\Component
__set() 設定元件屬性的值。 yii\base\Component
__unset() 將元件屬性設定為 null。 yii\base\Component
addDynamicPlaceholder() 為動態內容新增佔位符。 yii\base\DynamicContentAwareTrait
afterRun() 此方法在 Widget 執行後立即調用。 yii\base\Widget
attachBehavior() 將行為附加到此元件。 yii\base\Component
attachBehaviors() 將行為列表附加到元件。 yii\base\Component
beforeRun() 此方法在 Widget 執行前立即調用。 yii\base\Widget
begin() 開始一個 Widget。 yii\base\Widget
behaviors() 傳回此元件應表現為的行為列表。 yii\base\Component
canGetProperty() 傳回一個值,指示屬性是否可讀取。 yii\base\Component
canSetProperty() 傳回一個值,指示屬性是否可設定。 yii\base\Component
className() 傳回此類別的完整限定名稱。 yii\base\BaseObject
detachBehavior() 從元件中分離行為。 yii\base\Component
detachBehaviors() 從元件中分離所有行為。 yii\base\Component
end() 結束一個 Widget。 yii\base\Widget
ensureBehaviors() 確保在 behaviors() 中宣告的行為已附加到此元件。 yii\base\Component
getBehavior() 傳回具名的行為物件。 yii\base\Component
getBehaviors() 傳回附加到此元件的所有行為。 yii\base\Component
getCachedContent() 如果可用,則傳回快取的內容。 yii\widgets\FragmentCache
getDynamicPlaceholders() 傳回動態內容的佔位符列表。此方法在內部用於實作內容快取功能。 yii\base\DynamicContentAwareTrait
getId() 傳回 Widget 的 ID。 yii\base\Widget
getViewPath() 傳回包含此 Widget 的視圖檔案的目錄。 yii\base\Widget
hasEventHandlers() 傳回一個值,指示是否有名稱事件附加任何處理常式。 yii\base\Component
hasMethod() 傳回一個值,指示是否已定義方法。 yii\base\Component
hasProperty() 傳回一個值,指示是否為此元件定義了屬性。 yii\base\Component
init() 初始化 FragmentCache 物件。 yii\widgets\FragmentCache
off() 從此元件中分離現有的事件處理常式。 yii\base\Component
on() 將事件處理常式附加到事件。 yii\base\Component
render() 渲染視圖。 yii\base\Widget
renderFile() 渲染視圖檔案。 yii\base\Widget
run() 標記要快取內容的結束。 yii\widgets\FragmentCache
setDynamicPlaceholders() 設定動態內容的佔位符列表。此方法在內部用於實作內容快取功能。 yii\base\DynamicContentAwareTrait
setId() 設定 Widget 的 ID。 yii\base\Widget
setView() 設定此 Widget 要使用的視圖物件。 yii\base\Widget
trigger() 觸發事件。 yii\base\Component
widget() 建立 Widget 實例並執行它。 yii\base\Widget

保護方法

隱藏繼承的方法

方法 描述 定義於
calculateKey() 產生用於在快取中儲存內容的唯一金鑰。 yii\widgets\FragmentCache
getView() 傳回檢視物件,該物件可用於使用動態內容呈現檢視畫面或檢視檔案。 yii\base\DynamicContentAwareTrait
updateDynamicContent() 將 $content 中的預留位置替換為已評估的動態陳述式的結果。 yii\base\DynamicContentAwareTrait

事件

隱藏繼承的事件

事件 類型 描述 定義於
EVENT_AFTER_RUN yii\base\WidgetEvent 在執行小工具之後立即引發的事件。(自版本 2.0.11 起可用) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent 在執行小工具之前立即引發的事件。(自版本 2.0.11 起可用) yii\base\Widget
EVENT_INIT yii\base\Event 當小工具透過 init() 初始化時觸發的事件。(自版本 2.0.11 起可用) yii\base\Widget

屬性詳情

隱藏繼承的屬性

$cache public property

快取物件或快取物件的應用程式元件 ID。在建立 FragmentCache 物件之後,如果您想要變更此屬性,則應僅將其指定為快取物件。從版本 2.0.2 開始,這也可以是建立物件的組態陣列。

$cachedContent public property

快取的內容。如果在快取中找不到有效的內容,則傳回 False。

public string|false $cachedContent null
$dependency public property

快取內容所依賴的相依性。這可以是 yii\caching\Dependency 物件或用於建立相依性物件的組態陣列。例如:

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

會使輸出快取依賴所有文章的上次修改時間。如果任何文章的修改時間變更,快取內容將會失效。

$duration public property

資料在快取中保持有效的秒數。使用 0 表示快取資料永不過期。

public integer $duration 60
$enabled public property

是否啟用片段快取。您可以根據特定設定(例如,僅針對 GET 請求啟用片段快取)使用此屬性來開啟和關閉片段快取。

public boolean $enabled true
$variations public property

會導致快取內容變化的因素列表。每個因素都是代表變化的字串(例如,語言、GET 參數)。以下變化設定將導致根據目前的應用程式語言以不同版本快取內容

[
    Yii::$app->language,
]
public string[]|string $variations null

方法詳情

隱藏繼承的方法

__call() public method

定義於: yii\base\Component::__call()

呼叫非類別方法的具名方法。

此方法將檢查是否有任何附加的行為具有指定的名稱方法,並在可用時執行它。

不要直接呼叫此方法,因為它是 PHP 魔術方法,當調用未知方法時,它會被隱式呼叫。

public mixed __call ( $name, $params )
$name string

方法名稱

$params array

方法參數

return mixed

方法傳回值

throws yii\base\UnknownMethodException

當呼叫未知方法時

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() public method

定義於: yii\base\Component::__clone()

在透過複製現有物件建立物件後,會呼叫此方法。

它會移除所有行為,因為它們已附加到舊物件。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() public method

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

定義於: yii\base\Component::__get()

傳回元件屬性的值。

此方法將依以下順序檢查並採取相應動作

  • 由 getter 定義的屬性:傳回 getter 結果
  • 行為的屬性:傳回行為屬性值

不要直接呼叫此方法,因為它是 PHP 魔術方法,當執行 $value = $component->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)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (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\Component::__isset()

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

此方法將依以下順序檢查並採取相應動作

  • 由 setter 定義的屬性:傳回屬性是否已設定
  • 行為的屬性:傳回屬性是否已設定
  • 針對不存在的屬性傳回 false

不要直接呼叫此方法,因為它是 PHP 魔術方法,當執行 isset($component->property) 時,它會被隱式呼叫。

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

public boolean __isset ( $name )
$name string

屬性名稱或事件名稱

return boolean

命名的屬性是否已設定

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() public method

定義於: yii\base\Component::__set()

設定元件屬性的值。

此方法將依以下順序檢查並採取相應動作

  • 由 setter 定義的屬性:設定屬性值
  • 格式為 "on xyz" 的事件:將處理常式附加到事件 "xyz"
  • 格式為 "as xyz" 的行為:附加名為 "xyz" 的行為
  • 行為的屬性:設定行為屬性值

不要直接呼叫此方法,因為它是 PHP 魔術方法,當執行 $component->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)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() public method

定義於: yii\base\Component::__unset()

將元件屬性設定為 null。

此方法將依以下順序檢查並採取相應動作

  • 由 setter 定義的屬性:將屬性值設定為 null
  • 行為的屬性:將屬性值設定為 null

不要直接呼叫此方法,因為它是 PHP 魔術方法,當執行 unset($component->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);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
addDynamicPlaceholder() public method

定義於: yii\base\DynamicContentAwareTrait::addDynamicPlaceholder()

為動態內容新增佔位符。

此方法在內部用於實作內容快取功能。

public void addDynamicPlaceholder ( $name, $statements )
$name string

預留位置名稱。

$statements string

用於產生動態內容的 PHP 陳述式。

                public function addDynamicPlaceholder($name, $statements)
{
    $this->_dynamicPlaceholders[$name] = $statements;
}

            
afterRun() public method (available since version 2.0.11)

定義於: yii\base\Widget::afterRun()

此方法在 Widget 執行後立即調用。

此方法將觸發 EVENT_AFTER_RUN 事件。此方法的傳回值將用作小工具傳回值。

如果您覆寫此方法,您的程式碼應如下所示

public function afterRun($result)
{
    $result = parent::afterRun($result);
    // your custom code here
    return $result;
}
public mixed afterRun ( $result )
$result mixed

小工具傳回結果。

return mixed

處理過的小工具結果。

                public function afterRun($result)
{
    $event = new WidgetEvent();
    $event->result = $result;
    $this->trigger(self::EVENT_AFTER_RUN, $event);
    return $event->result;
}

            
attachBehavior() public method

定義於: yii\base\Component::attachBehavior()

將行為附加到此元件。

此方法將根據給定的組態建立行為物件。之後,將透過呼叫 yii\base\Behavior::attach() 方法將行為物件附加到此元件。

另請參閱 detachBehavior()

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行為的名稱。

$behavior string|array|yii\base\Behavior

行為組態。這可以是以下其中之一

return yii\base\Behavior

行為物件

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() public method

定義於: yii\base\Component::attachBehaviors()

將行為列表附加到元件。

每個行為都以其名稱索引,並且應該是 yii\base\Behavior 物件、指定行為類別的字串,或是用於建立行為的組態陣列。

另請參閱 attachBehavior()

public void attachBehaviors ( $behaviors )
$behaviors array

要附加到元件的行為列表

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
beforeRun() public method (available since version 2.0.11)

定義於: yii\base\Widget::beforeRun()

此方法在 Widget 執行前立即調用。

此方法將觸發 EVENT_BEFORE_RUN 事件。此方法的傳回值將決定小工具是否應繼續執行。

當覆寫此方法時,請確保您呼叫父類別實作,如下所示

public function beforeRun()
{
    if (!parent::beforeRun()) {
        return false;
    }

    // your custom code here

    return true; // or false to not run the widget
}
public boolean beforeRun ( )
return boolean

小工具是否應繼續執行。

                public function beforeRun()
{
    $event = new WidgetEvent();
    $this->trigger(self::EVENT_BEFORE_RUN, $event);
    return $event->isValid;
}

            
begin() public static method

定義於: yii\base\Widget::begin()

開始一個 Widget。

此方法會建立呼叫類別的實例。它會將組態套用到建立的實例。稍後應呼叫相符的 end() 呼叫。由於某些小工具可能會使用輸出緩衝,因此應在同一個檢視畫面中進行 end() 呼叫,以避免破壞輸出緩衝的巢狀結構。

另請參閱 end()

public static static begin ( $config = [] )
$config array

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

return yii\base\Widget

新建立的小工具實例

                public static function begin($config = [])
{
    $config['class'] = get_called_class();
    /* @var $widget Widget */
    $widget = Yii::createObject($config);
    self::$stack[] = $widget;
    return $widget;
}

            
behaviors() public method

定義於: yii\base\Component::behaviors()

傳回此元件應表現為的行為列表。

子類別可以覆寫此方法,以指定它們想要表現為的行為。

此方法的傳回值應為行為物件或組態的陣列,以行為名稱索引。行為組態可以是指定行為類別的字串,或是以下結構的陣列

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

請注意,行為類別必須從 yii\base\Behavior 擴展。行為可以使用名稱或匿名方式附加。當名稱用作陣列索引鍵時,使用此名稱,稍後可以使用 getBehavior() 檢索行為,或使用 detachBehavior() 分離行為。匿名行為無法檢索或分離。

在此方法中宣告的行為將自動(按需)附加到元件。

public array behaviors ( )
return array

行為組態。

                public function behaviors()
{
    return [];
}

            
calculateKey() protected method

產生用於在快取中儲存內容的唯一金鑰。

產生的金鑰取決於 $id$variations

protected mixed calculateKey ( )
return mixed

有效的快取金鑰

                protected function calculateKey()
{
    return array_merge([__CLASS__, $this->getId()], (array)$this->variations);
}

            
canGetProperty() public method

定義於: yii\base\Component::canGetProperty()

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

如果符合以下任一條件,則可以讀取屬性

  • 類別具有與指定名稱關聯的 getter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的可讀屬性(當 $checkBehaviors 為 true 時)。

另請參閱 canSetProperty()

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此元件的屬性

return boolean

屬性是否可以讀取

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() public method

定義於: yii\base\Component::canSetProperty()

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

如果符合以下任一條件,則可以寫入屬性

  • 類別具有與指定名稱關聯的 setter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的可寫屬性(當 $checkBehaviors 為 true 時)。

另請參閱 canGetProperty()

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此元件的屬性

return boolean

屬性是否可以寫入

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() public static method
自 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();
}

            
detachBehavior() public method

定義於: yii\base\Component::detachBehavior()

從元件中分離行為。

行為的 yii\base\Behavior::detach() 方法將會被調用。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行為的名稱。

return yii\base\Behavior|null

已分離的行為。如果行為不存在,則為 Null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() public 方法

定義於: yii\base\Component::detachBehaviors()

從元件中分離所有行為。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
end() public static 方法

定義於: yii\base\Widget::end()

結束一個 Widget。

請注意,小組件的渲染結果會直接輸出。

另請參閱 begin()

public static static end ( )
return yii\base\Widget

已結束的小組件實例。

throws yii\base\InvalidCallException

如果 begin()end() 呼叫沒有正確地巢狀。

                public static function end()
{
    if (!empty(self::$stack)) {
        $widget = array_pop(self::$stack);
        $calledClass = get_called_class();
        if (Yii::$container->has($calledClass) && isset(Yii::$container->getDefinitions()[$calledClass]['class'])) {
            $calledClass = Yii::$container->getDefinitions()[$calledClass]['class'];
        }
        if (get_class($widget) === $calledClass) {
            /* @var $widget Widget */
            if ($widget->beforeRun()) {
                $result = $widget->run();
                $result = $widget->afterRun($result);
                echo $result;
            }
            return $widget;
        }
        throw new InvalidCallException('Expecting end() of ' . get_class($widget) . ', found ' . get_called_class());
    }
    throw new InvalidCallException('Unexpected ' . get_called_class() . '::end() call. A matching begin() is not found.');
}

            
ensureBehaviors() public 方法

定義於: yii\base\Component::ensureBehaviors()

確保在 behaviors() 中宣告的行為已附加到此元件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
getBehavior() public 方法

定義於: yii\base\Component::getBehavior()

傳回具名的行為物件。

public yii\base\Behavior|null getBehavior ( $name )
$name string

行為名稱。

return yii\base\Behavior|null

行為物件,如果行為不存在則為 null。

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() public 方法

定義於: yii\base\Component::getBehaviors()

傳回附加到此元件的所有行為。

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

附加到此組件的行為列表。

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getCachedContent() public 方法

如果可用,則傳回快取的內容。

public string|false getCachedContent ( )
return string|false

快取的內容。如果在快取中找不到有效的內容,則傳回 False。

                public function getCachedContent()
{
    if ($this->_content !== null) {
        return $this->_content;
    }
    $this->_content = false;
    if (!($this->cache instanceof CacheInterface)) {
        return $this->_content;
    }
    $key = $this->calculateKey();
    $data = $this->cache->get($key);
    if (!is_array($data) || count($data) !== 2) {
        return $this->_content;
    }
    list($this->_content, $placeholders) = $data;
    if (!is_array($placeholders) || count($placeholders) === 0) {
        return $this->_content;
    }
    $this->_content = $this->updateDynamicContent($this->_content, $placeholders, true);
    return $this->_content;
}

            
getDynamicPlaceholders() public 方法

定義於: yii\base\DynamicContentAwareTrait::getDynamicPlaceholders()

傳回動態內容的佔位符列表。此方法在內部用於實作內容快取功能。

public array getDynamicPlaceholders ( )
return array

佔位符列表。

                public function getDynamicPlaceholders()
{
    return $this->_dynamicPlaceholders;
}

            
getId() public 方法

定義於: yii\base\Widget::getId()

傳回 Widget 的 ID。

public string|null getId ( $autoGenerate true )
$autoGenerate boolean

是否在先前未設定 ID 的情況下自動產生。

return string|null

Widget 的 ID。

                public function getId($autoGenerate = true)
{
    if ($autoGenerate && $this->_id === null) {
        $this->_id = static::$autoIdPrefix . static::$counter++;
    }
    return $this->_id;
}

            
getView() protected abstract 方法

定義於: yii\base\DynamicContentAwareTrait::getView()

傳回檢視物件,該物件可用於使用動態內容呈現檢視畫面或檢視檔案。

protected abstract yii\base\View getView ( )
return yii\base\View

可用於渲染視圖或視圖檔案的視圖物件。

                abstract protected function getView();

            
getViewPath() public 方法

定義於: yii\base\Widget::getViewPath()

傳回包含此 Widget 的視圖檔案的目錄。

預設實作會傳回包含小組件類別檔案的目錄下的 'views' 子目錄。

public string getViewPath ( )
return string

包含此 Widget 的視圖檔案的目錄。

                public function getViewPath()
{
    $class = new ReflectionClass($this);
    return dirname($class->getFileName()) . DIRECTORY_SEPARATOR . 'views';
}

            
hasEventHandlers() public 方法

定義於: yii\base\Component::hasEventHandlers()

傳回一個值,指示是否有名稱事件附加任何處理常式。

public boolean hasEventHandlers ( $name )
$name string

事件名稱。

return boolean

是否有任何處理常式附加到事件。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() public 方法

定義於: yii\base\Component::hasMethod()

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

如果滿足以下條件,則方法被定義:

  • 類別具有指定名稱的方法。
  • 附加的行為具有給定名稱的方法(當 $checkBehaviors 為 true 時)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

屬性名稱

$checkBehaviors boolean

是否將行為的方法視為此組件的方法。

return boolean

方法是否已定義。

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() public 方法

定義於: yii\base\Component::hasProperty()

傳回一個值,指示是否為此元件定義了屬性。

如果滿足以下條件,則屬性被定義:

  • 類別具有與指定名稱關聯的 getter 或 setter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的屬性(當 $checkBehaviors 為 true 時)。

另請參閱

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此元件的屬性

return boolean

屬性是否已定義。

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

            
init() public 方法

初始化 FragmentCache 物件。

public void init ( )

                public function init()
{
    parent::init();
    $this->cache = $this->enabled ? Instance::ensure($this->cache, 'yii\caching\CacheInterface') : null;
    if ($this->cache instanceof CacheInterface && $this->getCachedContent() === false) {
        $this->getView()->pushDynamicContent($this);
        ob_start();
        ob_implicit_flush(false);
    }
}

            
off() public 方法

定義於: yii\base\Component::off()

從此元件中分離現有的事件處理常式。

此方法與 on() 相反。

注意:如果為事件名稱傳遞了萬用字元模式,則只會移除使用此萬用字元註冊的處理常式,而使用符合此萬用字元的純名稱註冊的處理常式將會保留。

另請參閱 on()

public boolean off ( $name, $handler null )
$name string

事件名稱。

$handler callable|null

要移除的事件處理常式。如果為 null,則會移除附加到具名事件的所有處理常式。

return boolean

如果找到並分離處理常式。

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() public 方法

定義於: yii\base\Component::on()

將事件處理常式附加到事件。

事件處理常式必須是有效的 PHP 回呼。以下是一些範例:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件處理常式必須使用以下簽名定義:

function ($event)

其中 $event 是一個 yii\base\Event 物件,其中包含與事件關聯的參數。

自 2.0.14 版起,您可以將事件名稱指定為萬用字元模式。

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另請參閱 off()

public void on ( $name, $handler, $data null, $append true )
$name string

事件名稱。

$handler 可呼叫 (callable)

事件處理常式。

$data mixed

在觸發事件時要傳遞給事件處理常式的資料。當調用事件處理常式時,可以透過 yii\base\Event::$data 存取此資料。

$append boolean

是否將新的事件處理常式附加到現有處理常式列表的末尾。如果為 false,則新的處理常式將插入到現有處理常式列表的開頭。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
render() public 方法

定義於: yii\base\Widget::render()

渲染視圖。

要渲染的視圖可以使用以下格式之一指定:

  • 路徑別名(例如 "@app/views/site/index")。
  • 應用程式內的絕對路徑(例如 "//site/index"):視圖名稱以雙斜線開頭。實際的視圖檔案將在應用程式的 視圖路徑 下尋找。
  • 模組內的絕對路徑(例如 "/site/index"):視圖名稱以單斜線開頭。實際的視圖檔案將在當前活動模組的 視圖路徑 下尋找。
  • 相對路徑(例如 "index"):實際的視圖檔案將在 $viewPath 下尋找。

如果視圖名稱不包含檔案副檔名,則將使用預設副檔名 .php

public string render ( $view, $params = [] )
$view string

視圖名稱。

$params array

應在視圖中提供的參數(名稱-值對)。

return string

渲染結果。

throws yii\base\InvalidArgumentException

如果視圖檔案不存在。

                public function render($view, $params = [])
{
    return $this->getView()->render($view, $params, $this);
}

            
renderFile() public 方法

定義於: yii\base\Widget::renderFile()

渲染視圖檔案。

public string renderFile ( $file, $params = [] )
$file string

要渲染的視圖檔案。這可以是檔案路徑或 路徑別名

$params array

應在視圖中提供的參數(名稱-值對)。

return string

渲染結果。

throws yii\base\InvalidArgumentException

如果視圖檔案不存在。

                public function renderFile($file, $params = [])
{
    return $this->getView()->renderFile($file, $params, $this);
}

            
run() public 方法

標記要快取內容的結束。

在此方法呼叫之前和 init() 之後顯示的內容將被擷取並儲存在快取中。如果已在快取中找到有效內容,則此方法不執行任何操作。

public void run ( )

                public function run()
{
    if (($content = $this->getCachedContent()) !== false) {
        echo $content;
    } elseif ($this->cache instanceof CacheInterface) {
        $this->getView()->popDynamicContent();
        $content = ob_get_clean();
        if ($content === false || $content === '') {
            return;
        }
        if (is_array($this->dependency)) {
            $this->dependency = Yii::createObject($this->dependency);
        }
        $data = [$content, $this->getDynamicPlaceholders()];
        $this->cache->set($this->calculateKey(), $data, $this->duration, $this->dependency);
        echo $this->updateDynamicContent($content, $this->getDynamicPlaceholders());
    }
}

            
setDynamicPlaceholders() public 方法

定義於: yii\base\DynamicContentAwareTrait::setDynamicPlaceholders()

設定動態內容的佔位符列表。此方法在內部用於實作內容快取功能。

public void setDynamicPlaceholders ( $placeholders )
$placeholders array

佔位符列表。

                public function setDynamicPlaceholders($placeholders)
{
    $this->_dynamicPlaceholders = $placeholders;
}

            
setId() public 方法

定義於: yii\base\Widget::setId()

設定 Widget 的 ID。

public void setId ( $value )
$value string

小組件的 ID。

                public function setId($value)
{
    $this->_id = $value;
}

            
setView() public 方法

定義於: yii\base\Widget::setView()

設定此 Widget 要使用的視圖物件。

public void setView ( $view )
$view yii\base\View

可用於渲染視圖或視圖檔案的視圖物件。

                public function setView($view)
{
    $this->_view = $view;
}

            
trigger() public 方法

定義於: yii\base\Component::trigger()

觸發事件。

此方法表示事件的發生。它會調用事件的所有附加處理常式,包括類別層級的處理常式。

public void trigger ( $name, yii\base\Event $event null )
$name string

事件名稱。

$event yii\base\Event|null

事件實例。如果未設定,將會建立預設的 yii\base\Event 物件。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}

            
updateDynamicContent() protected 方法

定義於: yii\base\DynamicContentAwareTrait::updateDynamicContent()

將 $content 中的預留位置替換為已評估的動態陳述式的結果。

protected string updateDynamicContent ( $content, $placeholders, $isRestoredFromCache false )
$content string

要解析的內容。

$placeholders string[]

佔位符及其值。

$isRestoredFromCache boolean

內容是否將從快取還原。

return string

最終內容。

                protected function updateDynamicContent($content, $placeholders, $isRestoredFromCache = false)
{
    if (empty($placeholders) || !is_array($placeholders)) {
        return $content;
    }
    if (count($this->getView()->getDynamicContents()) === 0) {
        // outermost cache: replace placeholder with dynamic content
        foreach ($placeholders as $name => $statements) {
            $placeholders[$name] = $this->getView()->evaluateDynamicContent($statements);
        }
        $content = strtr($content, $placeholders);
    }
    if ($isRestoredFromCache) {
        $view = $this->getView();
        foreach ($placeholders as $name => $statements) {
            $view->addDynamicPlaceholder($name, $statements);
        }
    }
    return $content;
}

            
widget() public static 方法

定義於: yii\base\Widget::widget()

建立 Widget 實例並執行它。

小組件的渲染結果由此方法傳回。

public static string widget ( $config = [] )
$config array

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

return string

小組件的渲染結果。

throws Throwable

                public static function widget($config = [])
{
    ob_start();
    ob_implicit_flush(false);
    try {
        /* @var $widget Widget */
        $config['class'] = get_called_class();
        $widget = Yii::createObject($config);
        $out = '';
        if ($widget->beforeRun()) {
            $result = $widget->run();
            $out = $widget->afterRun($result);
        }
    } catch (\Exception $e) {
        // close the output buffer opened above if it has not been closed already
        if (ob_get_level() > 0) {
            ob_end_clean();
        }
        throw $e;
    } catch (\Throwable $e) {
        // close the output buffer opened above if it has not been closed already
        if (ob_get_level() > 0) {
            ob_end_clean();
        }
        throw $e;
    }
    return ob_get_clean() . $out;
}