1 關注者

類別 yii\widgets\LinkPager

繼承關係yii\widgets\LinkPager » 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/LinkPager.php

LinkPager 顯示導向不同目標頁面的超連結列表。

LinkPager 與 yii\data\Pagination 物件搭配使用,該物件指定總頁數和目前頁碼。

請注意,LinkPager 僅產生必要的 HTML 標記。為了使其看起來像真正的分頁器,您應為其提供一些 CSS 樣式。使用預設配置,LinkPager 應能在使用 Twitter Bootstrap CSS 框架時看起來不錯。

有關 LinkPager 的更多詳細資訊和使用資訊,請參閱關於分頁的指南文章

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$activePageCssClass 字串 作用中(目前選取)頁面按鈕的 CSS 類別。 yii\widgets\LinkPager
$autoIdPrefix 字串 自動產生 widget ID 的前綴。 yii\base\Widget
$behaviors yii\base\Behavior[] 附加到此元件的行為列表。 yii\base\Component
$disableCurrentPageButton 布林值 是否將目前頁面按鈕呈現為停用狀態。 yii\widgets\LinkPager
$disabledListItemSubTagOptions 陣列 要在停用的列表元素內產生的停用標籤的選項。 yii\widgets\LinkPager
$disabledPageCssClass 字串 停用頁面按鈕的 CSS 類別。 yii\widgets\LinkPager
$firstPageCssClass 字串 「第一頁」按鈕的 CSS 類別。 yii\widgets\LinkPager
$firstPageLabel 字串|布林值 「第一頁」按鈕的文字標籤。 yii\widgets\LinkPager
$hideOnSinglePage 布林值 當只有一頁存在時隱藏 widget。 yii\widgets\LinkPager
$id 字串|null Widget 的 ID。 yii\base\Widget
$lastPageCssClass 字串 「最後一頁」按鈕的 CSS 類別。 yii\widgets\LinkPager
$lastPageLabel 字串|布林值 「最後一頁」按鈕的文字標籤。 yii\widgets\LinkPager
$linkContainerOptions 陣列 將套用到所有連結容器的 HTML 屬性 yii\widgets\LinkPager
$linkOptions 陣列 分頁器容器標籤中連結的 HTML 屬性。 yii\widgets\LinkPager
$maxButtonCount 整數 可以顯示的最大頁面按鈕數量。 yii\widgets\LinkPager
$nextPageCssClass 字串 「下一頁」按鈕的 CSS 類別。 yii\widgets\LinkPager
$nextPageLabel 字串|布林值 「下一頁」按鈕的標籤。 yii\widgets\LinkPager
$options 陣列 分頁器容器標籤的 HTML 屬性。 yii\widgets\LinkPager
$pageCssClass 字串 每個頁面按鈕的 CSS 類別。 yii\widgets\LinkPager
$pagination yii\data\Pagination 此分頁器關聯的分頁物件。 yii\widgets\LinkPager
$prevPageCssClass 字串 「上一頁」按鈕的 CSS 類別。 yii\widgets\LinkPager
$prevPageLabel 字串|布林值 「上一頁」按鈕的文字標籤。 yii\widgets\LinkPager
$registerLinkTags 布林值 是否在 HTML 標頭中註冊上一頁、下一頁、第一頁和最後一頁的連結標籤。 yii\widgets\LinkPager
$view yii\web\View 可用於呈現視圖或視圖檔案的視圖物件。 yii\base\Widget
$viewPath 字串 包含此 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
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
getId() 傳回 widget 的 ID。 yii\base\Widget
getView() 傳回可用於呈現視圖或視圖檔案的視圖物件。 yii\base\Widget
getViewPath() 傳回包含此 widget 視圖檔案的目錄。 yii\base\Widget
hasEventHandlers() 傳回值,指示是否有任何處理常式附加到指定的事件。 yii\base\Component
hasMethod() 傳回值,指示是否已定義方法。 yii\base\Component
hasProperty() 傳回值,指示是否為此元件定義了屬性。 yii\base\Component
init() 初始化分頁器。 yii\widgets\LinkPager
off() 從此元件分離現有的事件處理常式。 yii\base\Component
on() 將事件處理程序附加到事件。 yii\base\Component
render() 渲染視圖。 yii\base\Widget
renderFile() 渲染視圖檔案。 yii\base\Widget
run() 執行小工具。 yii\widgets\LinkPager
setId() 設定小工具的 ID。 yii\base\Widget
setView() 設定此小工具要使用的視圖物件。 yii\base\Widget
trigger() 觸發事件。 yii\base\Component
widget() 建立小工具實例並執行它。 yii\base\Widget

受保護的方法

隱藏繼承的方法

方法 描述 定義於
getPageRange() yii\widgets\LinkPager
registerLinkTags() 在 html 標頭中註冊 prev、next、first 和 last 頁面的關聯連結標籤。 yii\widgets\LinkPager
renderPageButton() 渲染頁面按鈕。 yii\widgets\LinkPager
renderPageButtons() 渲染頁面按鈕。 yii\widgets\LinkPager

事件

隱藏繼承的事件

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

屬性詳情

隱藏繼承的屬性

$activePageCssClass 公開屬性

作用中(目前選取)頁面按鈕的 CSS 類別。

public string $activePageCssClass 'active'
$disableCurrentPageButton 公開屬性 (自 2.0.12 版本起可用)

是否將目前頁面按鈕呈現為停用狀態。

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

用於在停用清單元素內產生的停用標籤的選項。為了自訂 html 標籤,請使用 tag 鍵。

$disabledListItemSubTagOptions = ['tag' => 'div', 'class' => 'disabled-div'];
$disabledPageCssClass 公開屬性

停用頁面按鈕的 CSS 類別。

public string $disabledPageCssClass 'disabled'
$firstPageCssClass 公開屬性

「第一頁」按鈕的 CSS 類別。

public string $firstPageCssClass 'first'
$firstPageLabel 公開屬性

"第一頁" 按鈕的文字標籤。請注意,這將不會進行 HTML 編碼。如果指定為 true,則頁碼將用作標籤。預設值為 false,表示不會顯示 "第一頁" 按鈕。

$hideOnSinglePage 公開屬性

當只有一頁存在時隱藏 widget。

public boolean $hideOnSinglePage true
$lastPageCssClass 公開屬性

「最後一頁」按鈕的 CSS 類別。

public string $lastPageCssClass 'last'
$lastPageLabel 公開屬性

"最後一頁" 按鈕的文字標籤。請注意,這將不會進行 HTML 編碼。如果指定為 true,則頁碼將用作標籤。預設值為 false,表示不會顯示 "最後一頁" 按鈕。

public string|boolean $lastPageLabel false
$linkContainerOptions 公開屬性 (自 2.0.13 版本起可用)

將套用到所有連結容器的 HTML 屬性

$linkOptions 公開屬性

分頁器容器標籤中連結的 HTML 屬性。

另請參閱 yii\helpers\Html::renderTagAttributes() 以瞭解如何渲染屬性的詳細資訊。

public array $linkOptions = []
$maxButtonCount 公開屬性

可以顯示的最大頁面按鈕數量。預設值為 10。

$nextPageCssClass 公開屬性

「下一頁」按鈕的 CSS 類別。

public string $nextPageCssClass 'next'
$nextPageLabel 公開屬性

"下一頁" 按鈕的標籤。請注意,這將不會進行 HTML 編碼。如果此屬性為 false,則不會顯示 "下一頁" 按鈕。

public string|boolean $nextPageLabel '»'
$options 公開屬性

分頁器容器標籤的 HTML 屬性。

另請參閱 yii\helpers\Html::renderTagAttributes() 以瞭解如何渲染屬性的詳細資訊。

public array $options = [
    
'class' => 'pagination',
]
$pageCssClass 公開屬性 (自 2.0.7 版本起可用)

每個頁面按鈕的 CSS 類別。

public string $pageCssClass null
$pagination 公開屬性

此分頁器關聯的分頁物件。您必須設定此屬性才能使 LinkPager 運作。

$prevPageCssClass 公開屬性

「上一頁」按鈕的 CSS 類別。

public string $prevPageCssClass 'prev'
$prevPageLabel 公開屬性

"上一頁" 按鈕的文字標籤。請注意,這將不會進行 HTML 編碼。如果此屬性為 false,則不會顯示 "上一頁" 按鈕。

public string|boolean $prevPageLabel '«'
$registerLinkTags 公開屬性

是否在 HTML 標頭中註冊 prev、next、first 和 last 頁面的連結標籤。預設值為 false,以避免在一個頁面上使用多個分頁器時發生衝突。

另請參閱

public boolean $registerLinkTags false

方法詳情

隱藏繼承的方法

__call() 公開方法

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

呼叫指定的非類別方法。

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

請勿直接呼叫此方法,因為它是 PHP 魔術方法,當呼叫未知方法時會隱式呼叫。

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

方法名稱

$params 陣列

方法參數

傳回 mixed

方法傳回值

拋出 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 陣列

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

                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 字串

屬性名稱

傳回 mixed

屬性值或行為屬性的值

拋出 yii\base\UnknownPropertyException

如果未定義屬性

拋出 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 字串

屬性名稱或事件名稱

傳回 布林值

名稱的屬性是否已設定

                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 字串

屬性名稱或事件名稱

$value mixed

屬性值

拋出 yii\base\UnknownPropertyException

如果未定義屬性

拋出 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 字串

屬性名稱

拋出 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()

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

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

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

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

小工具傳回結果。

傳回 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 字串

行為的名稱。

$behavior string|array|yii\base\Behavior

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

傳回 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 陣列

要附加到組件的行為列表

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

            
beforeRun() public method (自 2.0.11 版本起可用)

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

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

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

當覆寫此方法時,請確保您像下面這樣呼叫父層實作

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

    // your custom code here

    return true; // or false to not run the widget
}
public boolean beforeRun ( )
傳回 布林值

widget 是否應繼續執行。

                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() 呼叫。由於某些 widget 可能會使用輸出緩衝,因此應在相同的視圖中進行 end() 呼叫,以避免破壞輸出緩衝的巢狀結構。

另請參閱 end()

public static static begin ( $config = [] )
$config 陣列

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

傳回 yii\base\Widget

新建立的 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 ( )
傳回 陣列

行為組態。

                public function behaviors()
{
    return [];
}

            
canGetProperty() public method

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

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

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

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

另請參閱 canSetProperty()

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

屬性名稱

$checkVars 布林值

是否將成員變數視為屬性

$checkBehaviors 布林值

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

傳回 布林值

屬性是否可以讀取

                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 字串

屬性名稱

$checkVars 布林值

是否將成員變數視為屬性

$checkBehaviors 布林值

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

傳回 布林值

屬性是否可以寫入

                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 ( )
傳回 字串

此類別的完整限定名稱。

                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 字串

行為的名稱。

傳回 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()

結束 widget。

請注意,widget 的渲染結果會直接輸出。

另請參閱 begin()

public static static end ( )
傳回 yii\base\Widget

已結束的 widget 實例。

拋出 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 字串

行為名稱

傳回 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 ( )
傳回 yii\base\Behavior[]

附加到此組件的行為列表

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

            
getId() public method

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

傳回 widget 的 ID。

public string|null getId ( $autoGenerate true )
$autoGenerate 布林值

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

傳回 字串|null

Widget 的 ID。

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

            
getPageRange() protected method

protected array getPageRange ( )
傳回 陣列

需要顯示的起始和結束頁碼。

                protected function getPageRange()
{
    $currentPage = $this->pagination->getPage();
    $pageCount = $this->pagination->getPageCount();
    $beginPage = max(0, $currentPage - (int) ($this->maxButtonCount / 2));
    if (($endPage = $beginPage + $this->maxButtonCount - 1) >= $pageCount) {
        $endPage = $pageCount - 1;
        $beginPage = max(0, $endPage - $this->maxButtonCount + 1);
    }
    return [$beginPage, $endPage];
}

            
getView() public method

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

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

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

public yii\web\View getView ( )
傳回 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()

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

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

public string getViewPath ( )
傳回 字串

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

                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 字串

事件名稱

傳回 布林值

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

                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 字串

屬性名稱

$checkBehaviors 布林值

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

傳回 布林值

方法是否已定義

                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 字串

屬性名稱

$checkVars 布林值

是否將成員變數視為屬性

$checkBehaviors 布林值

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

傳回 布林值

屬性是否已定義

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

            
init() public method

初始化分頁器。

public void init ( )

                public function init()
{
    parent::init();
    if ($this->pagination === null) {
        throw new InvalidConfigException('The "pagination" property must be set.');
    }
}

            
off() public method

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

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

此方法與 on() 相反。

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

另請參閱 on()

public boolean off ( $name, $handler null )
$name 字串

事件名稱

$handler callable|null

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

傳回 布林值

如果找到並分離處理常式

                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 字串

事件名稱

$handler 可呼叫 (callable)

事件處理常式

$data mixed

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

$append 布林值

是否將新的事件處理常式附加到現有處理常式列表的末尾。如果為 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]);
    }
}

            
registerLinkTags() protected method

在 html 標頭中註冊 prev、next、first 和 last 頁面的關聯連結標籤。

這些連結是使用 yii\data\Pagination::getLinks() 產生的。

另請參閱 https://www.w3.org/TR/html401/struct/links.html#h-12.1.2

protected void registerLinkTags ( )

                protected function registerLinkTags()
{
    $view = $this->getView();
    foreach ($this->pagination->getLinks() as $rel => $href) {
        $view->registerLinkTag(['rel' => $rel, 'href' => $href], $rel);
    }
}

            
render() public method

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

渲染視圖。

要呈現的視圖可以使用下列格式之一指定

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

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

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

視圖名稱。

$params 陣列

應該在視圖中可用的參數 (名稱-值 組)。

傳回 字串

呈現結果。

拋出 yii\base\InvalidArgumentException

如果視圖檔案不存在。

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

            
renderFile() public method

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

渲染視圖檔案。

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

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

$params 陣列

應該在視圖中可用的參數 (名稱-值 組)。

傳回 字串

呈現結果。

拋出 yii\base\InvalidArgumentException

如果視圖檔案不存在。

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

            
renderPageButton() protected method

渲染頁面按鈕。

您可以覆寫此方法來自訂頁面按鈕的產生方式。

protected string renderPageButton ( $label, $page, $class, $disabled, $active )
$label 字串

按鈕的文字標籤

$page 整數

頁碼

$class 字串

頁面按鈕的 CSS 類別。

$disabled 布林值

此頁面按鈕是否停用

$active 布林值

此頁面按鈕是否為活動狀態

傳回 字串

呈現結果

                protected function renderPageButton($label, $page, $class, $disabled, $active)
{
    $options = $this->linkContainerOptions;
    $linkWrapTag = ArrayHelper::remove($options, 'tag', 'li');
    Html::addCssClass($options, empty($class) ? $this->pageCssClass : $class);
    if ($active) {
        Html::addCssClass($options, $this->activePageCssClass);
    }
    if ($disabled) {
        Html::addCssClass($options, $this->disabledPageCssClass);
        $disabledItemOptions = $this->disabledListItemSubTagOptions;
        $tag = ArrayHelper::remove($disabledItemOptions, 'tag', 'span');
        return Html::tag($linkWrapTag, Html::tag($tag, $label, $disabledItemOptions), $options);
    }
    $linkOptions = $this->linkOptions;
    $linkOptions['data-page'] = $page;
    return Html::tag($linkWrapTag, Html::a($label, $this->pagination->createUrl($page), $linkOptions), $options);
}

            
renderPageButtons() protected method

渲染頁面按鈕。

protected string renderPageButtons ( )
傳回 字串

呈現結果

                protected function renderPageButtons()
{
    $pageCount = $this->pagination->getPageCount();
    if ($pageCount < 2 && $this->hideOnSinglePage) {
        return '';
    }
    $buttons = [];
    $currentPage = $this->pagination->getPage();
    // first page
    $firstPageLabel = $this->firstPageLabel === true ? '1' : $this->firstPageLabel;
    if ($firstPageLabel !== false) {
        $buttons[] = $this->renderPageButton($firstPageLabel, 0, $this->firstPageCssClass, $currentPage <= 0, false);
    }
    // prev page
    if ($this->prevPageLabel !== false) {
        if (($page = $currentPage - 1) < 0) {
            $page = 0;
        }
        $buttons[] = $this->renderPageButton($this->prevPageLabel, $page, $this->prevPageCssClass, $currentPage <= 0, false);
    }
    // internal pages
    list($beginPage, $endPage) = $this->getPageRange();
    for ($i = $beginPage; $i <= $endPage; ++$i) {
        $buttons[] = $this->renderPageButton($i + 1, $i, null, $this->disableCurrentPageButton && $i == $currentPage, $i == $currentPage);
    }
    // next page
    if ($this->nextPageLabel !== false) {
        if (($page = $currentPage + 1) >= $pageCount - 1) {
            $page = $pageCount - 1;
        }
        $buttons[] = $this->renderPageButton($this->nextPageLabel, $page, $this->nextPageCssClass, $currentPage >= $pageCount - 1, false);
    }
    // last page
    $lastPageLabel = $this->lastPageLabel === true ? $pageCount : $this->lastPageLabel;
    if ($lastPageLabel !== false) {
        $buttons[] = $this->renderPageButton($lastPageLabel, $pageCount - 1, $this->lastPageCssClass, $currentPage >= $pageCount - 1, false);
    }
    $options = $this->options;
    $tag = ArrayHelper::remove($options, 'tag', 'ul');
    return Html::tag($tag, implode("\n", $buttons), $options);
}

            
run() public method

執行小工具。

此方法覆寫父類別的實作,以顯示產生的頁面按鈕。

public void run ( )

                public function run()
{
    if ($this->registerLinkTags) {
        $this->registerLinkTags();
    }
    echo $this->renderPageButtons();
}

            
setId() public method

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

設定小工具的 ID。

public void setId ( $value )
$value 字串

小工具的 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 字串

事件名稱

$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() public static method

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

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

小工具呈現結果由此方法傳回。

public static string widget ( $config = [] )
$config 陣列

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

傳回 字串

小工具的呈現結果。

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