0 追蹤者

類別 yii\widgets\Menu

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

Menu 使用巢狀 HTML 列表顯示多層選單。

Menu 的主要屬性是 $items,它指定了選單中可能的項目。一個選單項目可以包含子項目,這些子項目指定了該選單項目下的子選單。

Menu 檢查當前路由和請求參數,以切換某些選單項目的活動狀態。

請注意,Menu 僅呈現關於選單的 HTML 標籤。它不做任何樣式設定。您有責任提供 CSS 樣式使其看起來像一個真正的選單。

以下範例展示如何使用 Menu

echo Menu::widget([
    'items' => [
        // Important: you need to specify url as 'controller/action',
        // not just as 'controller' even if default action is used.
        ['label' => 'Home', 'url' => ['site/index']],
        // 'Products' menu item will be selected as long as the route is 'product/index'
        ['label' => 'Products', 'url' => ['product/index'], 'items' => [
            ['label' => 'New Arrivals', 'url' => ['product/index', 'tag' => 'new']],
            ['label' => 'Most Popular', 'url' => ['product/index', 'tag' => 'popular']],
        ]],
        ['label' => 'Login', 'url' => ['site/login'], 'visible' => Yii::$app->user->isGuest],
    ],
]);

公共屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$activateItems boolean 是否根據其路由設定是否與當前請求的路由匹配來自動啟用項目。 yii\widgets\Menu
$activateParents boolean 當相應的子選單項目之一處於活動狀態時,是否啟用父選單項目。 yii\widgets\Menu
$activeCssClass string 要附加到活動選單項目的 CSS 類別。 yii\widgets\Menu
$autoIdPrefix string 自動產生的 Widget ID 的前綴。 yii\base\Widget
$behaviors yii\base\Behavior[] 附加到此組件的行為列表。 yii\base\Component
$encodeLabels boolean 選單項目的標籤是否應進行 HTML 編碼。 yii\widgets\Menu
$firstItemCssClass string|null 將分配給主選單或每個子選單中第一個項目的 CSS 類別。 yii\widgets\Menu
$hideEmptyItems boolean 是否隱藏空的選單項目。 yii\widgets\Menu
$id string|null Widget 的 ID。 yii\base\Widget
$itemOptions array 所有選單 $items 共用的 HTML 屬性列表。 yii\widgets\Menu
$items array 選單項目列表。 yii\widgets\Menu
$labelTemplate string 用於呈現 *不是* 連結的選單主體的模板。 yii\widgets\Menu
$lastItemCssClass string|null 將分配給主選單或每個子選單中最後一個項目的 CSS 類別。 yii\widgets\Menu
$linkTemplate string 用於呈現 *是* 連結的選單主體的模板。 yii\widgets\Menu
$options array 選單容器標籤的 HTML 屬性。 yii\widgets\Menu
$params array|null 用於確定選單項目是否處於活動狀態的參數。 yii\widgets\Menu
$route string|null 用於確定選單項目是否處於活動狀態的路由。 yii\widgets\Menu
$submenuTemplate string 用於呈現子選單列表的模板。 yii\widgets\Menu
$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() 將行為附加到此組件。 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() 傳回檢視 (view) 物件,可用於渲染檢視或檢視檔案。 yii\base\Widget
getViewPath() 傳回包含此小工具之檢視檔案的目錄。 yii\base\Widget
hasEventHandlers() 傳回一個值,指示是否有名稱事件附加任何處理器 (handler)。 yii\base\Component
hasMethod() 傳回一個值,指示是否已定義方法。 yii\base\Component
hasProperty() 傳回一個值,指示是否已為此組件定義屬性。 yii\base\Component
init() 初始化物件。 yii\base\Widget
off() 從此組件卸離現有的事件處理器。 yii\base\Component
on() 將事件處理器附加到事件。 yii\base\Component
render() 渲染檢視。 yii\base\Widget
renderFile() 渲染檢視檔案。 yii\base\Widget
run() 渲染選單。 yii\widgets\Menu
setId() 設定小工具的 ID。 yii\base\Widget
setView() 設定此小工具要使用的檢視物件。 yii\base\Widget
trigger() 觸發事件。 yii\base\Component
widget() 建立小工具實例並執行它。 yii\base\Widget

受保護的方法

隱藏繼承的方法

方法 描述 定義於
isItemActive() 檢查選單項目是否為活動狀態。 yii\widgets\Menu
normalizeItems() 正規化 $items 屬性,以移除不可見的項目並啟用特定項目。 yii\widgets\Menu
renderItem() 渲染選單項目的內容。 yii\widgets\Menu
renderItems() 遞迴地渲染選單項目 (不包含容器標籤)。 yii\widgets\Menu

事件

隱藏繼承的事件

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

屬性詳細資訊

隱藏繼承的屬性

$activateItems 公開屬性

是否根據其路由設定是否與當前請求的路由匹配來自動啟用項目。

另請參閱 isItemActive()

public boolean $activateItems true
$activateParents 公開屬性

是否在相應的子選單項目處於活動狀態時,啟用父選單項目。 啟用的父選單項目也會將其 CSS 類別附加 $activeCssClass

public boolean $activateParents false
$activeCssClass 公開屬性

要附加到活動選單項目的 CSS 類別。

public string $activeCssClass 'active'
$encodeLabels 公開屬性

選單項目的標籤是否應進行 HTML 編碼。

public boolean $encodeLabels true
$firstItemCssClass 公開屬性

將指派給主選單或每個子選單中第一個項目的 CSS 類別。預設為 null,表示不會指派此類 CSS 類別。

$hideEmptyItems 公開屬性

是否隱藏空的選單項目。 空的選單項目是指未設定 url 選項且沒有可見子選單項目的項目。

public boolean $hideEmptyItems true
$itemOptions 公開屬性

所有選單 $items 共用的 HTML 屬性列表。 如果任何個別選單項目指定其 options,它將與此屬性合併,然後用於產生選單項目標籤的 HTML 屬性。 以下特殊選項被辨識

  • tag: string,預設為 "li",項目容器標籤的標籤名稱。 設定為 false 以停用容器標籤。 另請參閱 yii\helpers\Html::tag()

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

public array $itemOptions = []
$items 公開屬性

選單項目列表。 每個選單項目都應該是一個具有以下結構的陣列

  • label: string,選填,指定選單項目標籤。 當 $encodeLabels 為 true 時,標籤將會進行 HTML 編碼。 如果未指定標籤,將使用空字串。
  • encode: boolean,選填,此項目的標籤是否應進行 HTML 編碼。 此參數將覆寫全域 $encodeLabels 參數。
  • url: string 或 array,選填,指定選單項目的 URL。 它將由 yii\helpers\Url::to() 處理。 當設定此項時,將使用 $linkTemplate 產生實際的選單項目內容;否則,將使用 $labelTemplate
  • visible: boolean,選填,此選單項目是否可見。 預設為 true。
  • items: array,選填,指定子選單項目。 其格式與父項目相同。
  • active: boolean 或 Closure,選填,此選單項目是否處於活動狀態(目前已選取)。 當使用 Closure 時,其簽章應為 function ($item, $hasActiveChild, $isItemActive, $widget)。 如果項目應標記為 active,Closure 必須傳回 true,否則傳回 false。 如果選單項目處於活動狀態,其 CSS 類別將附加 $activeCssClass。 如果未設定此選項,當目前請求由 url 觸發時,選單項目將自動設定為活動狀態。 如需更多詳細資訊,請參閱 isItemActive()
  • template: string,選填,用於渲染此選單項目內容的範本。 符記 {url} 將被與此選單項目關聯的 URL 取代,而符記 {label} 將被選單項目的標籤取代。 如果未設定此選項,則將改為使用 $linkTemplate$labelTemplate
  • submenuTemplate: string,選填,用於渲染子選單列表的範本。 符記 {items} 將被渲染的子選單項目取代。 如果未設定此選項,則將改為使用 $submenuTemplate
  • options: array,選填,選單容器標籤的 HTML 屬性。
public array $items = []
$labelTemplate 公開屬性

用於渲染 *不是* 連結的選單主體的範本。 在此範本中,符記 {label} 將被選單項目的標籤取代。 此屬性將被透過 $items 在個別選單項目中設定的 template 選項覆寫。

public string $labelTemplate '{label}'
$lastItemCssClass 公開屬性

將指派給主選單或每個子選單中最後一個項目的 CSS 類別。預設為 null,表示不會指派此類 CSS 類別。

$linkTemplate 公開屬性

用於渲染 *是* 連結的選單主體的範本。 在此範本中,符記 {url} 將被對應的連結 URL 取代;而 {label} 將被連結文字取代。 此屬性將被透過 $items 在個別選單項目中設定的 template 選項覆寫。

public string $linkTemplate '<a href="{url}">{label}</a>'
$options 公開屬性

選單容器標籤的 HTML 屬性。 以下特殊選項被辨識

  • tag: string,預設為 "ul",項目容器標籤的標籤名稱。 設定為 false 以停用容器標籤。 另請參閱 yii\helpers\Html::tag()

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

public array $options = []
$params 公開屬性

用於判斷選單項目是否為活動狀態的參數。 如果未設定,將使用 $_GET

另請參閱

public array|null $params null
$route 公開屬性

用於判斷選單項目是否為活動狀態的路由。 如果未設定,將使用目前請求的路由。

另請參閱

public string|null $route null
$submenuTemplate 公開屬性

用於渲染子選單列表的範本。 在此範本中,符記 {items} 將被渲染的子選單項目取代。

public string $submenuTemplate "\n<ul>\n{items}\n</ul>\n"

方法詳細資訊

隱藏繼承的方法

__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

屬性名稱或事件名稱

屬性值 mixed

yii\base\InvalidCallException

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

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

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

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

public function afterRun($result)
{
    $result = parent::afterRun($result);
    // your custom code here
    return $result;
}
public mixed afterRun ( $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

行為的名稱。

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

將行為列表附加到組件。

每個 behavior 都以其名稱索引,且應為 yii\base\Behavior 物件、指定 behavior 類別的字串,或用於建立 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() 公共方法 (自版本 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 ( )
return boolean

widget 是否應繼續執行。

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

            
begin() 公共靜態方法

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

開始一個 Widget。

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

另請參閱 end()

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

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

return 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() 公共方法

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

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

子類別可能會覆寫此方法,以指定它們想要表現為哪些 behavior。

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

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

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

在此方法中宣告的 Behavior 將自動(依需求)附加到元件。

public array behaviors ( )
return array

Behavior 組態。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公共方法

定義於: 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 的屬性視為此元件的屬性

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() 公共方法

定義於: 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 的屬性視為此元件的屬性

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() 公共靜態方法
自 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() 公共方法

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

從組件中分離一個行為。

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

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

behavior 的名稱。

return yii\base\Behavior|null

已分離的 behavior。如果 behavior 不存在,則為 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() 公共方法

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

從組件中分離所有行為。

public void detachBehaviors ( )

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

            
end() 公共靜態方法

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

結束一個 Widget。

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

另請參閱 begin()

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

已結束的 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() 公共方法

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

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

傳回指定名稱的行為物件。

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

behavior 名稱

return yii\base\Behavior|null

behavior 物件,如果 behavior 不存在,則為 null

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

            
getBehaviors() 公共方法

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

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

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

附加到此元件的 behavior 列表

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

            
getId() 公共方法

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

傳回小工具 (widget) 的 ID。

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

如果先前未設定 ID,是否自動產生 ID

return string|null

Widget 的 ID。

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

            
getView() 公共方法

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

傳回檢視 (view) 物件,可用於渲染檢視或檢視檔案。

render()renderFile() 方法將使用此視圖物件來實作實際的視圖渲染。如果未設定,則預設為 "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() 公共方法

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

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

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

public string getViewPath ( )
return string

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

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

            
hasEventHandlers() 公共方法

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

傳回一個值,指示是否有名稱事件附加任何處理器 (handler)。

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() 公共方法

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

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

在下列情況下,方法被定義:

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

屬性名稱

$checkBehaviors boolean

是否將 behavior 的方法視為此元件的方法

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() 公共方法

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

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

在下列情況下,屬性被定義:

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

另請參閱

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

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

return boolean

屬性是否已定義

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

            
init() 公共方法

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

初始化物件。

此方法在建構函式的末尾呼叫。預設實作將觸發 EVENT_INIT 事件。

public void init ( )

                public function init()
{
    parent::init();
    $this->trigger(self::EVENT_INIT);
}

            
isItemActive() protected method

檢查選單項目是否為活動狀態。

這是透過檢查 $route$params 是否與選單項目的 url 選項中指定的內容相符來完成的。當選單項目的 url 選項以陣列的形式指定時,其第一個元素被視為項目的路由,其餘元素是關聯的參數。只有當其路由和參數分別與 $route$params 相符時,選單項目才被視為活動狀態。

protected boolean isItemActive ( $item )
$item array

要檢查的選單項目

return boolean

選單項目是否為活動狀態

                protected function isItemActive($item)
{
    if (isset($item['url']) && is_array($item['url']) && isset($item['url'][0])) {
        $route = Yii::getAlias($item['url'][0]);
        if (strncmp($route, '/', 1) !== 0 && Yii::$app->controller) {
            $route = Yii::$app->controller->module->getUniqueId() . '/' . $route;
        }
        if (ltrim($route, '/') !== $this->route) {
            return false;
        }
        unset($item['url']['#']);
        if (count($item['url']) > 1) {
            $params = $item['url'];
            unset($params[0]);
            foreach ($params as $name => $value) {
                if ($value !== null && (!isset($this->params[$name]) || $this->params[$name] != $value)) {
                    return false;
                }
            }
        }
        return true;
    }
    return false;
}

            
normalizeItems() protected method

正規化 $items 屬性,以移除不可見的項目並啟用特定項目。

protected array normalizeItems ( $items, &$active )
$items array

要正規化的項目。

$active boolean

是否有活動的子選單項目。

return array

正規化的選單項目

                protected function normalizeItems($items, &$active)
{
    foreach ($items as $i => $item) {
        if (isset($item['visible']) && !$item['visible']) {
            unset($items[$i]);
            continue;
        }
        if (!isset($item['label'])) {
            $item['label'] = '';
        }
        $encodeLabel = isset($item['encode']) ? $item['encode'] : $this->encodeLabels;
        $items[$i]['label'] = $encodeLabel ? Html::encode($item['label']) : $item['label'];
        $hasActiveChild = false;
        if (isset($item['items'])) {
            $items[$i]['items'] = $this->normalizeItems($item['items'], $hasActiveChild);
            if (empty($items[$i]['items']) && $this->hideEmptyItems) {
                unset($items[$i]['items']);
                if (!isset($item['url'])) {
                    unset($items[$i]);
                    continue;
                }
            }
        }
        if (!isset($item['active'])) {
            if ($this->activateParents && $hasActiveChild || $this->activateItems && $this->isItemActive($item)) {
                $active = $items[$i]['active'] = true;
            } else {
                $items[$i]['active'] = false;
            }
        } elseif ($item['active'] instanceof Closure) {
            if (call_user_func($item['active'], $item, $hasActiveChild, $this->isItemActive($item), $this)) {
                $active = $items[$i]['active'] = true;
            } else {
                $items[$i]['active'] = false;
            }
        } elseif ($item['active']) {
            $active = true;
        }
    }
    return array_values($items);
}

            
off() 公共方法

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

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

將事件處理器附加到事件。

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

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

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

function ($event)

其中 $eventyii\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() 公共方法

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

渲染檢視。

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

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

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

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

視圖名稱。

$params array

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

return string

渲染結果。

throws yii\base\InvalidArgumentException

如果視圖檔案不存在。

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

            
renderFile() public method

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

渲染檢視檔案。

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

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

$params array

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

return string

渲染結果。

throws yii\base\InvalidArgumentException

如果視圖檔案不存在。

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

            
renderItem() protected method

渲染選單項目的內容。

請注意,容器和子選單在此處不被渲染。

protected string renderItem ( $item )
$item array

要渲染的選單項目。請參考 $items 以查看項目中可能包含哪些資料。

return string

渲染結果

                protected function renderItem($item)
{
    if (isset($item['url'])) {
        $template = ArrayHelper::getValue($item, 'template', $this->linkTemplate);
        return strtr($template, [
            '{url}' => Html::encode(Url::to($item['url'])),
            '{label}' => $item['label'],
        ]);
    }
    $template = ArrayHelper::getValue($item, 'template', $this->labelTemplate);
    return strtr($template, [
        '{label}' => $item['label'],
    ]);
}

            
renderItems() protected method

遞迴地渲染選單項目 (不包含容器標籤)。

protected string renderItems ( $items )
$items array

要遞迴渲染的選單項目

return string

渲染結果

                protected function renderItems($items)
{
    $n = count($items);
    $lines = [];
    foreach ($items as $i => $item) {
        $options = array_merge($this->itemOptions, ArrayHelper::getValue($item, 'options', []));
        $tag = ArrayHelper::remove($options, 'tag', 'li');
        $class = [];
        if ($item['active']) {
            $class[] = $this->activeCssClass;
        }
        if ($i === 0 && $this->firstItemCssClass !== null) {
            $class[] = $this->firstItemCssClass;
        }
        if ($i === $n - 1 && $this->lastItemCssClass !== null) {
            $class[] = $this->lastItemCssClass;
        }
        Html::addCssClass($options, $class);
        $menu = $this->renderItem($item);
        if (!empty($item['items'])) {
            $submenuTemplate = ArrayHelper::getValue($item, 'submenuTemplate', $this->submenuTemplate);
            $menu .= strtr($submenuTemplate, [
                '{items}' => $this->renderItems($item['items']),
            ]);
        }
        $lines[] = Html::tag($tag, $menu, $options);
    }
    return implode("\n", $lines);
}

            
run() public method

渲染選單。

public void run ( )

                public function run()
{
    if ($this->route === null && Yii::$app->controller !== null) {
        $this->route = Yii::$app->controller->getRoute();
    }
    if ($this->params === null) {
        $this->params = Yii::$app->request->getQueryParams();
    }
    $items = $this->normalizeItems($this->items, $hasActiveChild);
    if (!empty($items)) {
        $options = $this->options;
        $tag = ArrayHelper::remove($options, 'tag', 'ul');
        echo Html::tag($tag, $this->renderItems($items), $options);
    }
}

            
setId() public method

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

設定小工具的 ID。

public void setId ( $value )
屬性值 string

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

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