0 追蹤者

類別 yii\widgets\LinkSorter

所有類別 | 屬性 | 方法 | 事件
繼承yii\widgets\LinkSorter » 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/LinkSorter.php

LinkSorter 為給定的排序定義渲染排序連結列表。

LinkSorter 將為 $sort 中宣告的每個屬性產生超連結。

關於 LinkSorter 的更多詳細資訊和使用方法,請參閱關於排序的指南文章。

公共屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$attributes array|null 支援排序的屬性列表。 yii\widgets\LinkSorter
$autoIdPrefix string 自動生成的 Widget ID 的前綴。 yii\base\Widget
$behaviors yii\base\Behavior[] 附加到此組件的行為列表。 yii\base\Component
$id string|null Widget 的 ID。 yii\base\Widget
$linkOptions array 排序器容器標籤中連結的 HTML 屬性,這些屬性會傳遞給 yii\data\Sort::link() yii\widgets\LinkSorter
$options array 排序器容器標籤的 HTML 屬性。 yii\widgets\LinkSorter
$sort yii\data\Sort|null 排序定義 yii\widgets\LinkSorter
$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
afterRun() 這個方法在小工具 (widget) 執行完成後立即被調用。 yii\base\Widget
attachBehavior() 將一個行為 (behavior) 附加到此組件。 yii\base\Component
attachBehaviors() 將一個行為 (behavior) 列表附加到此組件。 yii\base\Component
beforeRun() 這個方法在小工具 (widget) 執行之前立即被調用。 yii\base\Widget
begin() 開始一個小工具 (widget)。 yii\base\Widget
behaviors() 返回此組件應表現為的行為 (behavior) 列表。 yii\base\Component
canGetProperty() 返回一個值,指示屬性是否可以被讀取。 yii\base\Component
canSetProperty() 返回一個值,指示屬性是否可以被設置。 yii\base\Component
className() 返回此類別的完整限定名稱。 yii\base\BaseObject
detachBehavior() 從組件中分離一個行為 (behavior)。 yii\base\Component
detachBehaviors() 從組件中分離所有行為 (behavior)。 yii\base\Component
end() 結束一個小工具 (widget)。 yii\base\Widget
ensureBehaviors() 確保在 behaviors() 中宣告的行為 (behavior) 已附加到此組件。 yii\base\Component
getBehavior() 返回指定名稱的行為 (behavior) 物件。 yii\base\Component
getBehaviors() 返回附加到此組件的所有行為 (behavior)。 yii\base\Component
getId() 返回小工具 (widget) 的 ID。 yii\base\Widget
getView() 返回可用於渲染視圖 (views) 或視圖檔案的視圖 (view) 物件。 yii\base\Widget
getViewPath() 返回包含此小工具 (widget) 視圖檔案的目錄。 yii\base\Widget
hasEventHandlers() 返回一個值,指示是否有任何處理程序附加到指定的事件。 yii\base\Component
hasMethod() 返回一個值,指示是否已定義方法。 yii\base\Component
hasProperty() 返回一個值,指示是否為此組件定義了屬性。 yii\base\Component
init() 初始化排序器。 yii\widgets\LinkSorter
off() 從此組件中分離一個現有的事件處理程序。 yii\base\Component
on() 將一個事件處理程序附加到一個事件。 yii\base\Component
render() 渲染一個視圖 (view)。 yii\base\Widget
renderFile() 渲染一個視圖檔案。 yii\base\Widget
run() 執行小工具 (widget)。 yii\widgets\LinkSorter
setId() 設置小工具 (widget) 的 ID。 yii\base\Widget
setView() 設置此小工具 (widget) 要使用的視圖 (view) 物件。 yii\base\Widget
trigger() 觸發一個事件。 yii\base\Component
widget() 創建一個小工具 (widget) 實例並執行它。 yii\base\Widget

受保護的方法

隱藏繼承的方法

方法 描述 定義於
renderSortLinks() 渲染排序連結。 yii\widgets\LinkSorter

事件

隱藏繼承的事件

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

屬性詳細資訊

隱藏繼承的屬性

$attributes public property

支援排序的屬性列表。如果未設置,將使用 yii\data\Sort::$attributes 確定。

public array|null $attributes null
$linkOptions public property (自版本 2.0.6 起可用)

排序器容器標籤中連結的 HTML 屬性,這些屬性會傳遞給 yii\data\Sort::link()

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

public array $linkOptions = []
$options public property

排序器容器標籤的 HTML 屬性。

另請參閱

public array $options = [
    
'class' => 'sorter',
]
$sort public property

排序定義

public yii\data\Sort|null $sort null

方法詳細資訊

隱藏繼承的方法

__call() public method

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

調用指定的非類別方法。

此方法將檢查是否有任何附加的行為 (behavior) 具有指定的名稱方法,如果有,則執行它。

請勿直接調用此方法,因為它是一個 PHP 魔術方法,當調用未知方法時會被隱式調用。

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

方法名稱

$params array

方法參數

返回 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() public method

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

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

它移除所有行為 (behavior),因為它們附加到舊的物件。

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 結果
  • 行為 (behavior) 的屬性:返回行為屬性值

請勿直接調用此方法,因為它是一個 PHP 魔術方法,當執行 $value = $component->property; 時會被隱式調用。

另請參閱 __set()

public mixed __get ( $name )
$name string

屬性名稱

返回 mixed

屬性值或行為 (behavior) 屬性的值

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

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

檢查屬性是否已設置,即已定義且不為 null。

此方法將按以下順序檢查並相應地執行操作

  • 由 setter 定義的屬性:返回屬性是否已設置
  • 行為 (behavior) 的屬性:返回屬性是否已設置
  • 對於不存在的屬性,返回 false

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

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

public boolean __isset ( $name )
$name string

屬性名稱或事件名稱

返回 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" 的行為 (behavior):附加名為 "xyz" 的行為
  • 行為 (behavior) 的屬性:設置行為屬性值

請勿直接調用此方法,因為它是一個 PHP 魔術方法,當執行 $component->property = $value; 時會被隱式調用。

另請參閱 __get()

public void __set ( $name, $value )
$name string

屬性名稱或事件名稱

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

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

將組件屬性設置為 null。

此方法將按以下順序檢查並相應地執行操作

  • 由 setter 定義的屬性:將屬性值設置為 null
  • 行為 (behavior) 的屬性:將屬性值設置為 null

請勿直接調用此方法,因為它是一個 PHP 魔術方法,當執行 unset($component->property) 時會被隱式調用。

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

public void __unset ( $name )
$name string

屬性名稱

拋出 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() public method (自版本 2.0.11 起可用)

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

這個方法在小工具 (widget) 執行完成後立即被調用。

此方法將觸發 EVENT_AFTER_RUN 事件。此方法的返回值將用作小工具 (widget) 的返回值。

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

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

小工具 (widget) 返回結果。

返回 mixed

處理後的小工具 (widget) 結果。

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

將一個行為 (behavior) 附加到此組件。

此方法將根據給定的配置創建行為 (behavior) 物件。之後,將通過調用 yii\base\Behavior::attach() 方法將行為物件附加到此組件。

另請參閱 detachBehavior()

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

行為 (behavior) 的名稱。

$behavior string|array|yii\base\Behavior

行為 (behavior) 配置。可以是以下之一

返回 yii\base\Behavior

行為 (behavior) 物件

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

            
attachBehaviors() public method

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

將一個行為 (behavior) 列表附加到此組件。

每個行為 (behavior) 都以其名稱索引,並且應該是一個 yii\base\Behavior 物件、一個指定行為類別的字串,或一個用於創建行為的配置陣列。

另請參閱 attachBehavior()

public void attachBehaviors ( $behaviors )
$behaviors array

要附加到組件的行為 (behavior) 列表

                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 ( )
返回 boolean

小工具 (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 array

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

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

返回此組件應表現為的行為 (behavior) 列表。

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

此方法的返回值應為行為 (behavior) 物件或配置的陣列,並以行為名稱索引。行為配置可以是指定行為類別的字串,或具有以下結構的陣列

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

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

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

public array behaviors ( )
返回 array

行為 (behavior) 配置。

                public function behaviors()
{
    return [];
}

            
canGetProperty() public method

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

返回一個值,指示屬性是否可以被讀取。

如果滿足以下條件,則可以讀取屬性

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

另請參閱 canSetProperty()

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

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

返回 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 時);
  • 附加的行為 (behavior) 具有給定名稱的可寫屬性(當 $checkBehaviors 為 true 時)。

另請參閱 canGetProperty()

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

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

返回 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 ( )
返回 string

此類別的完整限定名稱。

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

            
detachBehavior() public method

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

從組件中分離一個行為 (behavior)。

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

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

行為的名稱。

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

從組件中分離所有行為 (behavior)。

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 ( )
返回 yii\base\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 方法

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

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

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

返回指定名稱的行為 (behavior) 物件。

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

行為名稱

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

返回附加到此組件的所有行為 (behavior)。

public yii\base\Behavior[] getBehaviors ( )
返回 yii\base\Behavior[]

附加到此組件的行為列表

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

            
getId() public 方法

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

返回小工具 (widget) 的 ID。

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

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

返回 string|null

Widget 的 ID。

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

            
getView() public 方法

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

返回可用於渲染視圖 (views) 或視圖檔案的視圖 (view) 物件。

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 方法

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

返回包含此小工具 (widget) 視圖檔案的目錄。

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

public string getViewPath ( )
返回 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

事件名稱

返回 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

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

返回 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

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

返回 boolean

屬性是否已定義

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

            
init() public 方法

初始化排序器。

public void init ( )

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

            
off() public 方法

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

從此組件中分離一個現有的事件處理程序。

此方法與 on() 相反。

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

另請參閱 on()

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

事件名稱

$handler callable|null

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

返回 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 可呼叫

事件處理器

$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()

渲染一個視圖 (view)。

要渲染的視圖可以使用以下其中一種格式指定

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

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

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

視圖名稱。

$params array

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

返回 string

渲染結果。

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

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

返回 string

渲染結果。

拋出 yii\base\InvalidArgumentException

如果視圖檔案不存在。

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

            
renderSortLinks() protected 方法

渲染排序連結。

protected string renderSortLinks ( )
返回 string

渲染結果

run() public 方法

執行小工具 (widget)。

此方法渲染排序連結。

public void run ( )

                public function run()
{
    echo $this->renderSortLinks();
}

            
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) 要使用的視圖 (view) 物件。

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

            
widget() public static 方法

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

創建一個小工具 (widget) 實例並執行它。

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

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

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

返回 string

小組件的渲染結果。

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