0 關注者

類別 yii\widgets\ListView

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

ListView 小部件用於顯示來自資料提供器的資料。每個資料模型都使用指定的視圖呈現。

有關 ListView 的更多詳細資訊和使用資訊,請參閱關於資料小部件的指南文章

公共屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$afterItem Closure 一個匿名函數,在每次呈現資料模型後調用一次。 yii\widgets\ListView
$autoIdPrefix string 自動產生的小部件 ID 的前綴。 yii\base\Widget
$beforeItem Closure 一個匿名函數,在每次呈現資料模型之前調用一次。 yii\widgets\ListView
$behaviors yii\base\Behavior[] 附加到此元件的行為列表。 yii\base\Component
$dataProvider yii\data\DataProviderInterface 視圖的資料提供器。 yii\widgets\BaseListView
$emptyText string|false $dataProvider 沒有任何資料時要顯示的 HTML 內容。 yii\widgets\BaseListView
$emptyTextOptions array 列表視圖的 emptyText 的 HTML 屬性。 yii\widgets\BaseListView
$id string|null 小部件的 ID。 yii\base\Widget
$itemOptions array|Closure 每個資料模型的呈現結果容器的 HTML 屬性。 yii\widgets\ListView
$itemView string|callable 用於呈現每個資料項目的視圖名稱,或用於呈現每個資料項目的回呼函數(例如,匿名函數)。 yii\widgets\ListView
$layout string 決定列表視圖的不同部分應如何組織的佈局。 yii\widgets\BaseListView
$options array 列表視圖的容器標籤的 HTML 屬性。 yii\widgets\ListView
$pager array 分頁器小部件的配置。 yii\widgets\BaseListView
$separator string 在任何兩個連續項目之間顯示的 HTML 代碼。 yii\widgets\ListView
$showOnEmpty boolean 如果 $dataProvider 沒有返回任何資料,是否顯示空的列表視圖。 yii\widgets\BaseListView
$sorter array 排序器小部件的配置。 yii\widgets\BaseListView
$summary string 要顯示為列表視圖摘要的 HTML 內容。 yii\widgets\BaseListView
$summaryOptions array 列表視圖摘要的 HTML 屬性。 yii\widgets\BaseListView
$view yii\web\View 可用於呈現視圖或視圖檔案的視圖物件。 yii\base\Widget
$viewParams array $itemView 正在呈現時,要傳遞給它的其他參數。 yii\widgets\ListView
$viewPath string 包含此小部件的視圖檔案的目錄。 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
afterRun() 此方法在小部件執行後立即調用。 yii\base\Widget
attachBehavior() 將行為附加到此元件。 yii\base\Component
attachBehaviors() 將行為列表附加到元件。 yii\base\Component
beforeRun() 此方法在小部件執行之前立即調用。 yii\base\Widget
begin() 開始一個小部件。 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() 結束一個小部件。 yii\base\Widget
ensureBehaviors() 確保在 behaviors() 中宣告的行為已附加到此元件。 yii\base\Component
getBehavior() 傳回指定的行為物件。 yii\base\Component
getBehaviors() 傳回附加到此元件的所有行為。 yii\base\Component
getId() 傳回小部件的 ID。 yii\base\Widget
getView() 傳回可用於呈現視圖或視圖檔案的視圖物件。 yii\base\Widget
getViewPath() 傳回包含此小工具檢視檔的目錄。 yii\base\Widget
hasEventHandlers() 傳回一個值,指出是否有任何處理常式附加到指定的事件。 yii\base\Component
hasMethod() 傳回一個值,指出是否已定義方法。 yii\base\Component
hasProperty() 傳回一個值,指出是否為此元件定義了屬性。 yii\base\Component
init() 初始化檢視。 yii\widgets\BaseListView
off() 從此元件卸載現有的事件處理常式。 yii\base\Component
on() 將事件處理常式附加到事件。 yii\base\Component
render() 渲染檢視。 yii\base\Widget
renderEmpty() 渲染 HTML 內容,指示列表檢視沒有資料。 yii\widgets\BaseListView
renderFile() 渲染檢視檔。 yii\base\Widget
renderItem() 渲染單一資料模型。 yii\widgets\ListView
renderItems() 渲染所有資料模型。 yii\widgets\ListView
renderPager() 渲染分頁器。 yii\widgets\BaseListView
renderSection() 渲染指定名稱的區段。 yii\widgets\BaseListView
renderSorter() 渲染排序器。 yii\widgets\BaseListView
renderSummary() 渲染摘要文字。 yii\widgets\BaseListView
run() 執行小工具。 yii\widgets\BaseListView
setId() 設定小工具的 ID。 yii\base\Widget
setView() 設定此小工具要使用的檢視物件。 yii\base\Widget
trigger() 觸發事件。 yii\base\Component
widget() 建立小工具實例並執行它。 yii\base\Widget

受保護方法

隱藏繼承的方法

方法 描述 定義於
renderAfterItem() 呼叫 $afterItem 閉包,傳回執行結果。 yii\widgets\ListView
renderBeforeItem() 呼叫 $beforeItem 閉包,傳回執行結果。 yii\widgets\ListView

事件

隱藏繼承的事件

事件 類型 描述 定義於
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

屬性詳細資訊

隱藏繼承的屬性

$afterItem 公開屬性 (自版本 2.0.11 起可用)

一個匿名函數,在每次呈現資料模型後調用一次。

它應該具有與 $beforeItem 相同的簽名。

函式的傳回結果將直接渲染。注意:如果函式傳回 null,則在項目之後不會渲染任何內容。

另請參閱 renderAfterItem()

public Closure $afterItem null
$beforeItem 公開屬性 (自版本 2.0.11 起可用)

在渲染每個資料模型之前呼叫一次的匿名函式。它應該具有以下簽名

function ($model, $key, $index, $widget)
  • $model:目前正在渲染的資料模型
  • $key:與目前資料模型相關聯的鍵值
  • $index:由 $dataProvider 傳回的模型陣列中,資料模型從零開始的索引
  • $widget:ListView 物件

函式的傳回結果將直接渲染。注意:如果函式傳回 null,則在項目之前不會渲染任何內容。

另請參閱 renderBeforeItem()

public Closure $beforeItem null
$itemOptions 公開屬性

每個資料模型的渲染結果容器的 HTML 屬性。這可以是指定用於渲染每個資料項目的通用 HTML 屬性的陣列,或傳回 HTML 屬性陣列的匿名函式。對於 $dataProvider 傳回的每個資料模型,將會呼叫一次匿名函式。"tag" 元素指定容器元素的標籤名稱,預設為 "div"。如果 "tag" 為 false,則表示不會渲染容器元素。

如果此屬性指定為匿名函式,則它應該具有以下簽名

function ($model, $key, $index, $widget)

另請參閱 yii\helpers\Html::renderTagAttributes(),以取得有關如何渲染屬性的詳細資訊。

$itemView 公開屬性

用於渲染每個資料項目的檢視名稱,或用於渲染每個資料項目的回呼 (例如匿名函式)。如果它指定檢視名稱,則以下變數將在檢視中可用

  • $model:mixed,資料模型
  • $key:mixed,與資料項目相關聯的鍵值
  • $index:integer,由 $dataProvider 傳回的項目陣列中,資料項目從零開始的索引。
  • $widget:ListView,此小工具實例

請注意,檢視名稱會由 $view 物件的目前內容解析為檢視檔。

如果此屬性指定為回呼,則它應該具有以下簽名

function ($model, $key, $index, $widget)
public string|callable $itemView null
$options 公開屬性

列表檢視的容器標籤的 HTML 屬性。"tag" 元素指定容器元素的標籤名稱,預設為 "div"。

另請參閱 yii\helpers\Html::renderTagAttributes(),以取得有關如何渲染屬性的詳細資訊。

public array $options = [
    
'class' => 'list-view',
]
$separator 公開屬性

在任何兩個連續項目之間顯示的 HTML 代碼。

public string $separator "\n"
$viewParams 公開屬性

$itemView 正在渲染時,要傳遞給它的其他參數。只有當 $itemView 是表示檢視名稱的字串時,才會使用此屬性。

public array $viewParams = []

方法詳細資訊

隱藏繼承的方法

__call() 公開方法

定義在: 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() 公開方法

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

在通過克隆現有物件創建物件後調用此方法。

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

public void __clone ( )

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

            
__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\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() 公開方法

定義在: 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() 公開方法

定義在: 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() 公開方法

定義在: 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);
}

            
afterRun() 公開方法 (自版本 2.0.11 起可用)

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

此方法在小部件執行後立即調用。

此方法將觸發 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() 公開方法

定義在: 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() 公開方法

定義在: 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() 公開方法 (自版本 2.0.11 起可用)

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

此方法在小部件執行之前立即調用。

此方法將觸發 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() 公開靜態方法

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

開始一個小部件。

此方法會建立呼叫類別的實例。它會將組態套用於已建立的實例。稍後應呼叫相符的 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() 公開方法

定義在: 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 [];
}

            
canGetProperty() 公開方法

定義在: 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 method

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

從元件中分離所有行為。

public void detachBehaviors ( )

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

            
end() public static method

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

結束一個小部件。

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

另請參閱 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 method

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

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

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

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

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

附加到此組件的行為列表

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

            
getId() public method

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

傳回小部件的 ID。

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

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

return string|null

小部件的 ID。

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

            
getView() public method

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

傳回可用於呈現視圖或視圖檔案的視圖物件。

render()renderFile() 方法將使用此 view 物件來實作實際的 view 渲染。如果未設定,則預設為「view」應用程式組件。

public yii\web\View getView ( )
return yii\web\View

可用於呈現視圖或視圖檔案的視圖物件。

                public function getView()
{
    if ($this->_view === null) {
        $this->_view = Yii::$app->getView();
    }
    return $this->_view;
}

            
getViewPath() public method

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

傳回包含此小工具檢視檔的目錄。

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

public string getViewPath ( )
return string

包含此小部件的視圖檔案的目錄。

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

            
hasEventHandlers() public method

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

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

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

定義於: yii\widgets\BaseListView::init()

初始化檢視。

public void init ( )

                public function init()
{
    parent::init();
    if ($this->dataProvider === null) {
        throw new InvalidConfigException('The "dataProvider" property must be set.');
    }
    if ($this->emptyText === null) {
        $this->emptyText = Yii::t('yii', 'No results found.');
    }
    if (!isset($this->options['id'])) {
        $this->options['id'] = $this->getId();
    }
}

            
off() public method

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

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

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

渲染檢視。

要渲染的 view 可以用以下格式之一指定

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

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

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

view 名稱。

$params array

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

return string

渲染結果。

throws yii\base\InvalidArgumentException

如果 view 檔案不存在。

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

            
renderAfterItem() protected method (available since version 2.0.11)

呼叫 $afterItem 閉包,傳回執行結果。

如果 $afterItem 不是閉包,則會傳回 null

另請參閱 $afterItem

protected string|null renderAfterItem ( $model, $key, $index )
$model mixed

要渲染的資料模型

$key mixed

與資料模型相關聯的鍵值

$index integer

資料模型在 $dataProvider 傳回的模型陣列中的從零開始的索引。

return string|null

$afterItem 呼叫結果,或當 $afterItem 不是閉包時為 null

                protected function renderAfterItem($model, $key, $index)
{
    if ($this->afterItem instanceof Closure) {
        return call_user_func($this->afterItem, $model, $key, $index, $this);
    }
    return null;
}

            
renderBeforeItem() protected method (available since version 2.0.11)

呼叫 $beforeItem 閉包,傳回執行結果。

如果 $beforeItem 不是閉包,則會傳回 null

另請參閱 $beforeItem

protected string|null renderBeforeItem ( $model, $key, $index )
$model mixed

要渲染的資料模型

$key mixed

與資料模型相關聯的鍵值

$index integer

資料模型在 $dataProvider 傳回的模型陣列中的從零開始的索引。

return string|null

$beforeItem 呼叫結果,或當 $beforeItem 不是閉包時為 null

                protected function renderBeforeItem($model, $key, $index)
{
    if ($this->beforeItem instanceof Closure) {
        return call_user_func($this->beforeItem, $model, $key, $index, $this);
    }
    return null;
}

            
renderEmpty() public method

定義於: yii\widgets\BaseListView::renderEmpty()

渲染 HTML 內容,指示列表檢視沒有資料。

另請參閱 $emptyText

public string renderEmpty ( )
return string

渲染結果

                public function renderEmpty()
{
    if ($this->emptyText === false) {
        return '';
    }
    $options = $this->emptyTextOptions;
    $tag = ArrayHelper::remove($options, 'tag', 'div');
    return Html::tag($tag, $this->emptyText, $options);
}

            
renderFile() public method

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

渲染檢視檔。

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

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

$params array

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

return string

渲染結果。

throws yii\base\InvalidArgumentException

如果 view 檔案不存在。

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

            
renderItem() public method

渲染單一資料模型。

public string renderItem ( $model, $key, $index )
$model mixed

要渲染的資料模型

$key mixed

與資料模型相關聯的鍵值

$index integer

資料模型在 $dataProvider 傳回的模型陣列中的從零開始的索引。

return string

渲染結果

                public function renderItem($model, $key, $index)
{
    if ($this->itemView === null) {
        $content = $key;
    } elseif (is_string($this->itemView)) {
        $content = $this->getView()->render($this->itemView, array_merge([
            'model' => $model,
            'key' => $key,
            'index' => $index,
            'widget' => $this,
        ], $this->viewParams));
    } else {
        $content = call_user_func($this->itemView, $model, $key, $index, $this);
    }
    if ($this->itemOptions instanceof Closure) {
        $options = call_user_func($this->itemOptions, $model, $key, $index, $this);
    } else {
        $options = $this->itemOptions;
    }
    $tag = ArrayHelper::remove($options, 'tag', 'div');
    $options['data-key'] = is_array($key) ? json_encode($key, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE) : (string) $key;
    return Html::tag($tag, $content, $options);
}

            
renderItems() public method

渲染所有資料模型。

public string renderItems ( )
return string

渲染結果

                public function renderItems()
{
    $models = $this->dataProvider->getModels();
    $keys = $this->dataProvider->getKeys();
    $rows = [];
    foreach (array_values($models) as $index => $model) {
        $key = $keys[$index];
        if (($before = $this->renderBeforeItem($model, $key, $index)) !== null) {
            $rows[] = $before;
        }
        $rows[] = $this->renderItem($model, $key, $index);
        if (($after = $this->renderAfterItem($model, $key, $index)) !== null) {
            $rows[] = $after;
        }
    }
    return implode($this->separator, $rows);
}

            
renderPager() public method

定義於: yii\widgets\BaseListView::renderPager()

渲染分頁器。

public string renderPager ( )
return string

渲染結果

                public function renderPager()
{
    $pagination = $this->dataProvider->getPagination();
    if ($pagination === false || $this->dataProvider->getCount() <= 0) {
        return '';
    }
    /* @var $class LinkPager */
    $pager = $this->pager;
    $class = ArrayHelper::remove($pager, 'class', LinkPager::className());
    $pager['pagination'] = $pagination;
    $pager['view'] = $this->getView();
    return $class::widget($pager);
}

            
renderSection() public method

定義於: yii\widgets\BaseListView::renderSection()

渲染指定名稱的區段。

如果名稱的 section 不受支援,則會傳回 false。

public string|boolean renderSection ( $name )
$name string

section 名稱,例如 {summary}{items}

return string|boolean

section 的渲染結果,如果名稱的 section 不受支援,則為 false。

                public function renderSection($name)
{
    switch ($name) {
        case '{summary}':
            return $this->renderSummary();
        case '{items}':
            return $this->renderItems();
        case '{pager}':
            return $this->renderPager();
        case '{sorter}':
            return $this->renderSorter();
        default:
            return false;
    }
}

            
renderSorter() public method

定義於: yii\widgets\BaseListView::renderSorter()

渲染排序器。

public string renderSorter ( )
return string

渲染結果

                public function renderSorter()
{
    $sort = $this->dataProvider->getSort();
    if ($sort === false || empty($sort->attributes) || $this->dataProvider->getCount() <= 0) {
        return '';
    }
    /* @var $class LinkSorter */
    $sorter = $this->sorter;
    $class = ArrayHelper::remove($sorter, 'class', LinkSorter::className());
    $sorter['sort'] = $sort;
    $sorter['view'] = $this->getView();
    return $class::widget($sorter);
}

            
renderSummary() public method

定義於: yii\widgets\BaseListView::renderSummary()

渲染摘要文字。

public void renderSummary ( )

                public function renderSummary()
{
    $count = $this->dataProvider->getCount();
    if ($count <= 0) {
        return '';
    }
    $summaryOptions = $this->summaryOptions;
    $tag = ArrayHelper::remove($summaryOptions, 'tag', 'div');
    if (($pagination = $this->dataProvider->getPagination()) !== false) {
        $totalCount = $this->dataProvider->getTotalCount();
        $begin = $pagination->getPage() * $pagination->pageSize + 1;
        $end = $begin + $count - 1;
        if ($begin > $end) {
            $begin = $end;
        }
        $page = $pagination->getPage() + 1;
        $pageCount = $pagination->pageCount;
        if (($summaryContent = $this->summary) === null) {
            return Html::tag($tag, Yii::t('yii', 'Showing <b>{begin, number}-{end, number}</b> of <b>{totalCount, number}</b> {totalCount, plural, one{item} other{items}}.', [
                    'begin' => $begin,
                    'end' => $end,
                    'count' => $count,
                    'totalCount' => $totalCount,
                    'page' => $page,
                    'pageCount' => $pageCount,
                ]), $summaryOptions);
        }
    } else {
        $begin = $page = $pageCount = 1;
        $end = $totalCount = $count;
        if (($summaryContent = $this->summary) === null) {
            return Html::tag($tag, Yii::t('yii', 'Total <b>{count, number}</b> {count, plural, one{item} other{items}}.', [
                'begin' => $begin,
                'end' => $end,
                'count' => $count,
                'totalCount' => $totalCount,
                'page' => $page,
                'pageCount' => $pageCount,
            ]), $summaryOptions);
        }
    }
    if ($summaryContent === '') {
        return '';
    }
    return Html::tag($tag, Yii::$app->getI18n()->format($summaryContent, [
        'begin' => $begin,
        'end' => $end,
        'count' => $count,
        'totalCount' => $totalCount,
        'page' => $page,
        'pageCount' => $pageCount,
    ], Yii::$app->language), $summaryOptions);
}

            
run() public method

定義於: yii\widgets\BaseListView::run()

執行小工具。

public void run ( )

                public function run()
{
    if ($this->showOnEmpty || $this->dataProvider->getCount() > 0) {
        $content = preg_replace_callback('/{\\w+}/', function ($matches) {
            $content = $this->renderSection($matches[0]);
            return $content === false ? $matches[0] : $content;
        }, $this->layout);
    } else {
        $content = $this->renderEmpty();
    }
    $options = $this->options;
    $tag = ArrayHelper::remove($options, 'tag', 'div');
    echo Html::tag($tag, $content, $options);
}

            
setId() public method

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

設定小工具的 ID。

public void setId ( $value )
$value string

小部件的 ID。

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

            
setView() public method

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

設定此小工具要使用的檢視物件。

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

可用於呈現視圖或視圖檔案的視圖物件。

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

            
trigger() public method

定義於: 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);
}

            
widget() 公開靜態方法

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

建立小工具實例並執行它。

此方法會傳回 widget 的渲染結果。

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

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

return string

widget 的渲染結果。

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;
}