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() 返回可用于呈现视图或视图文件的视图对象。 yii\base\Widget
getViewPath() 返回包含此 widget 的视图文件的目录。 yii\base\Widget
hasEventHandlers() 返回一个值,指示是否有任何处理程序附加到指定的事件。 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() 设置 widget 的 ID。 yii\base\Widget
setView() 设置此 widget 要使用的视图对象。 yii\base\Widget
trigger() 触发事件。 yii\base\Component
widget() 创建 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 在执行 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 通过 init() 初始化 widget 时触发的事件。(自版本 2.0.11 起可用) yii\base\Widget

属性详情

隐藏继承的属性

$activateItems 公共属性

是否根据其路由设置是否与当前请求的路由匹配来自动激活项目。

另请参阅 isItemActive()

public 布尔型 $activateItems true
$activateParents 公共属性

当对应子菜单项之一处于活动状态时,是否激活父菜单项。激活的父菜单项也将附加其 CSS 类 $activeCssClass

public 布尔型 $activateParents false
$activeCssClass 公共属性

要附加到活动菜单项的 CSS 类。

public 字符串 $activeCssClass 'active'
$encodeLabels 公共属性

菜单项的标签是否应进行 HTML 编码。

public 布尔型 $encodeLabels true
$firstItemCssClass 公共属性

将分配给主菜单或每个子菜单中的第一个项目的 CSS 类。默认为 null,这意味着不会分配此类 CSS 类。

$hideEmptyItems 公共属性

是否隐藏空菜单项。空菜单项是指其 url 选项未设置且没有可见子菜单项的菜单项。

public 布尔型 $hideEmptyItems true
$itemOptions 公共属性

所有菜单 $items 共享的 HTML 属性列表。如果任何单个菜单项指定其 options,则在用于生成菜单项标签的 HTML 属性之前,它将与此属性合并。以下特殊选项被识别

  • tag: 字符串,默认为“li”,项目容器标签的标签名称。设置为 false 以禁用容器标签。另请参阅 yii\helpers\Html::tag()

另请参阅 yii\helpers\Html::renderTagAttributes(),了解有关如何呈现属性的详细信息。

public 数组 $itemOptions = []
$items 公共属性

菜单项列表。每个菜单项都应为以下结构的数组

  • label: 字符串,可选,指定菜单项标签。当 $encodeLabels 为 true 时,标签将进行 HTML 编码。如果未指定标签,则将使用空字符串。
  • encode: 布尔型,可选,是否应 HTML 编码此项目的标签。此参数将覆盖全局 $encodeLabels 参数。
  • url: 字符串或数组,可选,指定菜单项的 URL。它将由 yii\helpers\Url::to() 处理。当设置此值时,实际的菜单项内容将使用 $linkTemplate 生成;否则,将使用 $labelTemplate
  • visible: 布尔型,可选,此菜单项是否可见。默认为 true。
  • items: 数组,可选,指定子菜单项。其格式与父项相同。
  • active: 布尔型或闭包,可选,此菜单项是否处于活动状态(当前选中)。使用闭包时,其签名应为 function ($item, $hasActiveChild, $isItemActive, $widget)。如果应将项目标记为 active,则闭包必须返回 true,否则返回 false。如果菜单项处于活动状态,则其 CSS 类将附加 $activeCssClass。如果未设置此选项,则当当前请求由 url 触发时,菜单项将自动设置为活动状态。有关更多详细信息,请参阅 isItemActive()
  • template: 字符串,可选,用于呈现此菜单项内容的模板。标记 {url} 将替换为此菜单项关联的 URL,标记 {label} 将替换为此菜单项的标签。如果未设置此选项,则将改为使用 $linkTemplate$labelTemplate
  • submenuTemplate: 字符串,可选,用于呈现子菜单列表的模板。标记 {items} 将替换为渲染的子菜单项。如果未设置此选项,则将改为使用 $submenuTemplate
  • options: 数组,可选,菜单容器标签的 HTML 属性。
public 数组 $items = []
$labelTemplate 公共属性

用于呈现非链接菜单体的模板。在此模板中,标记 {label} 将替换为菜单项的标签。此属性将被通过 $items 在各个菜单项中设置的 template 选项覆盖。

public 字符串 $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

方法参数

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

属性名称

返回值 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.ac.cn/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() 公共方法

定义于: yii\base\Component::__set()

设置组件属性的值。

此方法将按以下顺序检查并相应地执行

  • 由 setter 定义的属性:设置属性值
  • "on xyz" 格式的事件:将处理程序附加到事件 "xyz"
  • "as xyz" 格式的行为:附加名为 "xyz" 的行为
  • 行为的属性:设置行为属性值

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $component->property = $value; 时会隐式调用。

另请参见 __get()

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

属性名称或事件名称

$value mixed

属性值

抛出 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.ac.cn/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() 公有方法 (自版本 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() 公有方法

定义于: yii\base\Component::attachBehavior()

将行为附加到此组件。

此方法将根据给定的配置创建行为对象。之后,行为对象将通过调用 yii\base\Behavior::attach() 方法附加到此组件。

另请参阅 detachBehavior()

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

行为的名称。

$behavior 字符串|数组|yii\base\Behavior

行为配置。可以是以下之一:

返回值 yii\base\Behavior

行为对象

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

            
attachBehaviors() 公有方法

定义于: yii\base\Component::attachBehaviors()

将行为列表附加到组件。

每个行为都由其名称索引,并且应该是一个 yii\base\Behavior 对象、指定行为类的字符串或用于创建行为的配置数组。

另请参阅 attachBehavior()

public void attachBehaviors ( $behaviors )
$behaviors array

要附加到组件的行为列表

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

            
beforeRun() 公有方法 (自版本 2.0.11 起可用)

定义于: yii\base\Widget::beforeRun()

此方法在 widget 执行前立即调用。

此方法将触发 EVENT_BEFORE_RUN 事件。该方法的返回值将决定小部件是否应该继续运行。

重写此方法时,请确保像下面这样调用父实现

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

    // your custom code here

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

小部件是否应该继续执行。

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

            
begin() 公有静态方法

定义于: yii\base\Widget::begin()

开始一个 widget。

此方法创建调用类的实例。它将把配置应用到创建的实例。稍后应该调用匹配的 end() 调用。由于某些小部件可能使用输出缓冲,因此应在同一视图中进行 end() 调用,以避免破坏输出缓冲的嵌套。

另请参阅 end()

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

将用于初始化对象属性的名称-值对

返回值 yii\base\Widget

新创建的小部件实例

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

            
behaviors() 公有方法

定义于: yii\base\Component::behaviors()

返回此组件应表现为的行为列表。

子类可以重写此方法来指定它们想要表现出的行为。

此方法的返回值应该是一个行为对象或配置数组,由行为名称索引。行为配置可以是指定行为类的字符串,也可以是以下结构的数组

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

请注意,行为类必须扩展自 yii\base\Behavior。可以使用名称或匿名方式附加行为。当使用名称作为数组键时,使用此名称,可以使用 getBehavior() 检索行为,或使用 detachBehavior() 分离行为。匿名行为无法检索或分离。

在此方法中声明的行为将自动附加到组件(按需)。

public 数组 behaviors ( )
返回值 array

行为配置。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公有方法

定义于: yii\base\Component::canGetProperty()

返回一个值,指示属性是否可读。

如果满足以下条件,则可以读取属性:

  • 类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可读属性(当 $checkBehaviors 为 true 时)。

另请参阅 canSetProperty()

public 布尔值 canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 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 时);
  • 附加的行为具有给定名称的可写属性(当 $checkBehaviors 为 true 时)。

另请参阅 canGetProperty()

public 布尔值 canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

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

此类的完全限定名称。

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

            
detachBehavior() 公共方法

定义于: yii\base\Component::detachBehavior()

从组件分离行为。

将调用行为的 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() 公共方法

定义于: 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。

请注意,小部件的渲染结果将直接输出。

另请参阅 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() 公共方法

定义于: 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

行为名称

返回值 yii\base\Behavior|null

行为对象,如果行为不存在则为 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 ( )
返回值 yii\base\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

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

返回可用于呈现视图或视图文件的视图对象。

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

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

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

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

定义于: yii\base\Component::hasProperty()

返回一个值,指示此组件是否定义了属性。

如果定义了属性,则

  • 类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的属性(当 $checkBehaviors 为 true 时)。

另请参见

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

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 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() 受保护的方法

检查菜单项是否处于活动状态。

这是通过检查 $route$params 是否与菜单项的 url 选项中指定的匹配来完成的。当菜单项的 url 选项以数组的形式指定时,其第一个元素将被视为该项的路由,其余元素则是关联的参数。只有当它的路由和参数分别与 $route$params 匹配时,菜单项才会被认为是活动的。

protected boolean isItemActive ( $item )
$item array

要检查的菜单项

返回值 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() 受保护的方法

规范化 $items 属性以删除不可见的项目并激活某些项目。

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

要规范化的项目。

$active boolean

是否存在活动的子菜单项。

返回值 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,则将移除附加到命名事件的所有处理程序。

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

其中 $event 是一个 yii\base\Event 对象,其中包含与事件关联的参数。

从 2.0.14 开始,您可以将事件名称指定为通配符模式

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

另请参阅 off()

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

事件名称

$handler callable

事件处理程序

$data mixed

触发事件时要传递给事件处理程序的数据。当调用事件处理程序时,可以通过 yii\base\Event::$data 访问此数据。

$append boolean

是否将新的事件处理程序追加到现有处理程序列表的末尾。如果为 false,则新的处理程序将插入到现有处理程序列表的开头。

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

            
render() 公共方法

定义于: yii\base\Widget::render()

渲染视图。

要呈现的视图可以以下列格式之一指定

  • 路径别名(例如,“@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() 公共方法

定义于: 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);
}

            
renderItem() 受保护的方法

渲染菜单项的内容。

请注意,容器和子菜单不会在此处渲染。

protected string renderItem ( $item )
$item array

要渲染的菜单项。请参阅 $items 以查看项目中可能包含哪些数据。

返回值 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 string renderItems ( $items )
$items array

要递归渲染的菜单项

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

定义于: yii\base\Widget::setId()

设置 widget 的 ID。

public void setId ( $value )
$value string

小部件的 ID。

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

            
setView() 公共方法

定义于: yii\base\Widget::setView()

设置此 widget 要使用的视图对象。

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

可用于呈现视图或视图文件的视图对象。

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

            
trigger() 公共方法

定义于: yii\base\Component::trigger()

触发事件。

此方法表示事件的发生。它会调用事件的所有附加处理程序,包括类级处理程序。

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

事件名称

$event yii\base\Event|null

事件实例。如果未设置,则会创建一个默认的 yii\base\Event 对象。

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

            
widget() 公共静态方法

定义于: yii\base\Widget::widget()

创建 widget 实例并运行它。

小部件渲染结果由此方法返回。

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

将用于初始化对象属性的名称-值对

返回值 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;
}