0 关注者

类 yii\widgets\ListView

继承yii\widgets\ListView » yii\widgets\BaseListView » yii\base\Widget » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable, yii\base\ViewContextInterface
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/widgets/ListView.php

ListView 小部件用于显示来自数据提供者的数据。每个数据模型使用指定的视图进行渲染。

有关 ListView 的更多详细信息和用法信息,请参阅 数据小部件指南文章

公共属性

隐藏继承的属性

属性 类型 描述 定义
$afterItem 闭包 一个在渲染每个数据模型之后被调用的匿名函数。 yii\widgets\ListView
$autoIdPrefix 字符串 自动生成的窗口小部件 ID 的前缀。 yii\base\Widget
$beforeItem 闭包 一个在渲染每个数据模型之前被调用的匿名函数。 yii\widgets\ListView
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$dataProvider yii\data\DataProviderInterface 视图的数据提供者。 yii\widgets\BaseListView
$emptyText 字符串|布尔值 $dataProvider 没有数据时要显示的 HTML 内容。 yii\widgets\BaseListView
$emptyTextOptions 数组 列表视图的 emptyText 的 HTML 属性。 yii\widgets\BaseListView
$id 字符串|空值 窗口小部件的 ID。 yii\base\Widget
$itemOptions 数组|闭包 每个数据模型渲染结果的容器的 HTML 属性。 yii\widgets\ListView
$itemView 字符串|可调用 用于渲染每个数据项的视图名称,或用于渲染每个数据项的回调函数(例如匿名函数)。 yii\widgets\ListView
$layout 字符串 确定列表视图的不同部分如何组织的布局。 yii\widgets\BaseListView
$options 数组 列表视图的容器标签的 HTML 属性。 yii\widgets\ListView
$pager 数组 分页器小部件的配置。 yii\widgets\BaseListView
$separator 字符串 任何两个连续项之间要显示的 HTML 代码。 yii\widgets\ListView
$showOnEmpty 布尔值 如果 $dataProvider 返回无数据,是否显示一个空列表视图。 yii\widgets\BaseListView
$sorter 数组 排序器小部件的配置。 yii\widgets\BaseListView
$summary 字符串 作为列表视图摘要要显示的 HTML 内容。 yii\widgets\BaseListView
$summaryOptions 数组 列表视图摘要的 HTML 属性。 yii\widgets\BaseListView
$view yii\web\View 可以用于渲染视图或视图文件的视图对象。 yii\base\Widget
$viewParams 数组 在渲染 $itemView 时要传递给它的附加参数。 yii\widgets\ListView
$viewPath 字符串 包含此窗口小部件的视图文件的目录。 yii\base\Widget

公共方法

隐藏继承的方法

方法 描述 定义
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 此方法是在通过克隆现有对象创建对象后调用的。 yii\base\Component
__construct() 构造函数。 yii\base\BaseObject
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查属性是否已设置,即定义且不为空。 yii\base\Component
__set() 设置组件属性的值。 yii\base\Component
__unset() 将组件属性设置为 null。 yii\base\Component
afterRun() 此方法在窗口小部件执行后立即调用。 yii\base\Widget
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
beforeRun() 此方法在窗口小部件执行之前立即调用。 yii\base\Widget
begin() 开始一个窗口小部件。 yii\base\Widget
behaviors() 返回此组件应该表现为的行为列表。 yii\base\Component
canGetProperty() 返回一个值,指示是否可以读取属性。 yii\base\Component
canSetProperty() 返回一个值,指示是否可以设置属性。 yii\base\Component
className() 返回此类的完全限定名称。 yii\base\BaseObject
detachBehavior() 从组件中分离行为。 yii\base\Component
detachBehaviors() 从组件中分离所有行为。 yii\base\Component
end() 结束一个窗口小部件。 yii\base\Widget
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件。 yii\base\Component
getBehavior() 返回命名的行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
getId() 返回窗口小部件的 ID。 yii\base\Widget
getView() 返回可以用于渲染视图或视图文件的视图对象。 yii\base\Widget
getViewPath() 返回包含此窗口小部件的视图文件的目录。 yii\base\Widget
hasEventHandlers() 返回一个值,指示是否有任何处理程序附加到命名的事件。 yii\base\Component
hasMethod() 返回一个值,指示方法是否已定义。 yii\base\Component
hasProperty() 返回一个值,指示此组件是否定义了属性。 yii\base\Component
init() 初始化视图。 yii\widgets\BaseListView
off() 从此组件中分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
render() 渲染视图。 yii\base\Widget
renderEmpty() 渲染指示列表视图没有数据的 HTML 内容。 yii\widgets\BaseListView
renderFile() 渲染视图文件。 yii\base\Widget
renderItem() 渲染单个数据模型。 yii\widgets\ListView
renderItems() 渲染所有数据模型。 yii\widgets\ListView
renderPager() 渲染分页器。 yii\widgets\BaseListView
renderSection() 渲染指定名称的部分。 yii\widgets\BaseListView
renderSorter() 渲染排序器。 yii\widgets\BaseListView
renderSummary() 渲染摘要文本。 yii\widgets\BaseListView
run() 运行窗口小部件。 yii\widgets\BaseListView
setId() 设置窗口小部件的 ID。 yii\base\Widget
setView() 设置此窗口小部件要使用的视图对象。 yii\base\Widget
trigger() 触发事件。 yii\base\Component
widget() 创建窗口小部件实例并运行它。 yii\base\Widget

受保护的方法

隐藏继承的方法

方法 描述 定义
renderAfterItem() 调用 $afterItem 闭包,返回执行结果。 yii\widgets\ListView
renderBeforeItem() 调用 $beforeItem 闭包,返回执行结果。 yii\widgets\ListView

事件

隐藏继承的事件

事件 类型 描述 定义
EVENT_AFTER_RUN yii\base\WidgetEvent 在执行小部件后立即触发的事件。(从版本 2.0.11 开始可用) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent 在执行小部件前立即触发的事件。(从版本 2.0.11 开始可用) yii\base\Widget
EVENT_INIT yii\base\Event 当小部件通过 init() 初始化时触发的事件。(从版本 2.0.11 开始可用) yii\base\Widget

属性详情

隐藏继承的属性

$afterItem 公共属性 (从版本 2.0.11 开始可用)

一个在渲染每个数据模型之后被调用的匿名函数。

它应该与 $beforeItem 具有相同的签名。

函数的返回值将直接渲染。注意:如果函数返回 null,则在项目后不会渲染任何内容。

另请参阅 renderAfterItem()

public Closure $afterItem null
$beforeItem 公共属性 (从版本 2.0.11 开始可用)

在渲染每个数据模型之前调用的匿名函数。它应该具有以下签名

function ($model, $key, $index, $widget)
  • $model: 当前正在渲染的数据模型
  • $key: 与当前数据模型关联的键值
  • $index: 数据模型在 $dataProvider 返回的模型数组中的零基索引
  • $widget: ListView 对象

函数的返回值将直接渲染。注意:如果函数返回 null,则在项目之前不会渲染任何内容。

另请参阅 renderBeforeItem()

public Closure $beforeItem null
$itemOptions 公共属性

每个数据模型渲染结果的容器的 HTML 属性。这可以是一个数组,指定渲染每个数据项目的通用 HTML 属性,也可以是一个匿名函数,返回 HTML 属性的数组。匿名函数将为 $dataProvider 返回的每个数据模型调用一次。 "tag" 元素指定容器元素的标签名称,默认为 "div"。如果 "tag" 为 false,则表示不会渲染容器元素。

如果此属性指定为匿名函数,它应该具有以下签名

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

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

$itemView 公共属性

用于渲染每个数据项目的视图的名称,或渲染每个数据项目的回调(例如匿名函数)。如果它指定一个视图名称,则以下变量将在视图中可用

  • $model: mixed,数据模型
  • $key: mixed,与数据项关联的键值
  • $index: integer,数据项在 $dataProvider 返回的项目数组中的零基索引。
  • $widget: ListView,此小部件实例

请注意,视图名称由 $view 对象的当前上下文解析为视图文件。

如果此属性指定为回调,它应该具有以下签名

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

列表视图的容器标签的 HTML 属性。 "tag" 元素指定容器元素的标签名称,默认为 "div"。

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

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

任何两个连续项之间要显示的 HTML 代码。

public string $separator "\n"
$viewParams 公共属性

渲染 $itemView 时要传递给它的其他参数。此属性仅在 $itemView 是表示视图名称的字符串时使用。

public array $viewParams = []

方法详情

隐藏继承的方法

__call() 公共方法

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

调用不是类方法的命名方法。

此方法将检查是否有任何附加的行为具有指定的方法,并在可用时执行它。

不要直接调用此方法,因为它是一个 PHP 魔术方法,当调用未知方法时会隐式调用。

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

方法名称

$params 数组

方法参数

返回值 mixed

方法返回值

抛出 yii\base\UnknownMethodException

调用未知方法时

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() 公共方法

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

此方法是在通过克隆现有对象创建对象后调用的。

它删除所有行为,因为它们附加到旧对象。

public void __clone ( )

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

            
__construct() 公共方法

定义于: yii\base\BaseObject::__construct()

构造函数。

默认实现执行两件事

  • 使用给定的配置 $config 初始化对象。
  • 调用 init()

如果此方法在子类中被覆盖,建议

  • 构造函数的最后一个参数是一个配置数组,如这里的 $config
  • 在构造函数的末尾调用父实现。
public void __construct ( $config = [] )
$config 数组

将用于初始化对象属性的键值对

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

            
__get() 公共方法

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

返回组件属性的值。

此方法将按以下顺序检查并采取相应措施

  • 由 getter 定义的属性:返回 getter 结果
  • 行为的属性:返回行为属性值

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

另见 __set().

public mixed __get ( $name )
$name 字符串

属性名称

返回值 mixed

属性值或行为属性的值

抛出 yii\base\UnknownPropertyException

如果属性未定义

抛出 yii\base\InvalidCallException

如果属性是只写。

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() 公共方法

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

检查属性是否已设置,即定义且不为空。

此方法将按以下顺序检查并采取相应措施

  • 由 setter 定义的属性:返回属性是否已设置
  • 行为的属性:返回属性是否已设置
  • 对于不存在的属性返回 false

不要直接调用此方法,因为它是一个 PHP 魔术方法,将在执行 isset($component->property) 时隐式调用。

另见 https://php.ac.cn/manual/en/function.isset.php.

public boolean __isset ( $name )
$name 字符串

属性名称或事件名称

返回值 布尔值

命名的属性是否已设置

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() 公共方法

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

设置组件属性的值。

此方法将按以下顺序检查并采取相应措施

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

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

另见 __get().

public void __set ( $name, $value )
$name 字符串

属性名称或事件名称

$value mixed

属性值

抛出 yii\base\UnknownPropertyException

如果属性未定义

抛出 yii\base\InvalidCallException

如果属性是只读。

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() 公共方法

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

将组件属性设置为 null。

此方法将按以下顺序检查并采取相应措施

  • 由 setter 定义的属性:将属性值设置为 null
  • 行为的属性:将属性值设置为 null

不要直接调用此方法,因为它是一个 PHP 魔术方法,将在执行 unset($component->property) 时隐式调用。

另见 https://php.ac.cn/manual/en/function.unset.php.

public void __unset ( $name )
$name 字符串

属性名称

抛出 yii\base\InvalidCallException

如果属性是只读。

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

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

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

此方法在窗口小部件执行后立即调用。

此方法将触发 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 字符串

行为的名称。

$behavior string|array|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 数组

要附加到组件的行为列表

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

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

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

此方法在窗口小部件执行之前立即调用。

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

覆盖此方法时,请确保您调用父实现,如下所示

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

    // your custom code here

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

窗口小部件是否应继续执行。

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

            
begin() 公共静态方法

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

开始一个窗口小部件。

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

另见 end().

public static static begin ( $config = [] )
$config 数组

将用于初始化对象属性的键值对

返回值 yii\base\Widget

新创建的小部件实例

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

            
behaviors() 公共方法

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

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

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

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

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

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

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

public array behaviors ( )
返回值 数组

行为配置。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公共方法

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

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

如果可以读取属性

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

另请参见 canSetProperty()

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

属性名称

$checkVars 布尔值

是否将成员变量视为属性

$checkBehaviors 布尔值

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

返回值 布尔值

属性是否可读

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() 公共方法

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

返回一个值,指示是否可以设置属性。

如果可以写入属性

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

另请参见 canGetProperty()

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

属性名称

$checkVars 布尔值

是否将成员变量视为属性

$checkBehaviors 布尔值

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

返回值 布尔值

属性是否可写

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() 公共静态方法
自 2.0.14 起已弃用。在 PHP >=5.5 上,请使用 ::class 代替。

定义于: yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
返回值 字符串

此类的完全限定名称。

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

行为的名称。

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

结束一个窗口小部件。

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

另请参见 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 字符串

行为名称

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

返回窗口小部件的 ID。

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

是否在之前未设置 ID 时生成 ID

返回值 字符串|空值

窗口小部件的 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()

返回包含此窗口小部件的视图文件的目录。

默认实现返回包含小部件类文件目录下的 'views' 子目录。

public string getViewPath ( )
返回值 字符串

包含此窗口小部件的视图文件的目录。

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

            
hasEventHandlers() 公共方法

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

返回一个值,指示是否有任何处理程序附加到命名的事件。

public boolean hasEventHandlers ( $name )
$name 字符串

事件名称

返回值 布尔值

是否为此事件附加了任何处理程序。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() 公共方法

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

返回一个值,指示方法是否已定义。

一个方法被定义为

  • 类具有指定名称的方法
  • 附加的行为具有给定名称的方法(当 $checkBehaviors 为 true 时)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name 字符串

属性名称

$checkBehaviors 布尔值

是否将行为的方法视为此组件的方法

返回值 布尔值

方法是否被定义

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() 公共方法

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

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

一个属性被定义为

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

另请参阅

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

属性名称

$checkVars 布尔值

是否将成员变量视为属性

$checkBehaviors 布尔值

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

返回值 布尔值

属性是否被定义

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

            
init() 公共方法

定义于: yii\widgets\BaseListView::init()

初始化视图。

public void init ( )

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

            
off() 公共方法

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

从此组件中分离现有的事件处理程序。

此方法与 on() 相反。

注意:如果为事件名称传递通配符模式,则只移除使用此通配符注册的处理程序,而使用与此通配符匹配的纯名称注册的处理程序将保留。

另请参阅 on()

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

事件名称

$handler callable|null

要移除的事件处理程序。如果为 null,则将移除附加到命名事件的所有处理程序。

返回值 布尔值

如果找到并分离了处理程序

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() 公共方法

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

将事件处理程序附加到事件。

事件处理程序必须是一个有效的 PHP 回调。以下是一些示例

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

事件处理程序必须使用以下签名定义,

function ($event)

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

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

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

另请参阅 off()

public void on ( $name, $handler, $data null, $append true )
$name 字符串

事件名称

$handler callable

事件处理程序

$data mixed

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

$append 布尔值

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

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

            
render() 公共方法

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

渲染视图。

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

  • 路径别名(例如 "@app/views/site/index");
  • 应用程序中的绝对路径(例如 "//site/index"):视图名称以双斜杠开头。实际的视图文件将在应用程序的 视图路径 下查找。
  • 模块中的绝对路径(例如 "/site/index"):视图名称以单个斜杠开头。实际的视图文件将在当前活动模块的 视图路径 下查找。
  • 相对路径(例如 "index"):实际的视图文件将在 $viewPath 下查找。

如果视图名称不包含文件扩展名,它将使用默认扩展名 .php

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

视图名称。

$params 数组

要在视图中提供参数(名称-值对)。

返回值 字符串

渲染结果。

抛出 yii\base\InvalidArgumentException

如果视图文件不存在。

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

            
renderAfterItem() 受保护方法 (自版本 2.0.11 起可用)

调用 $afterItem 闭包,返回执行结果。

如果 $afterItem 不是闭包,则将返回 null

另请参阅 $afterItem

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

要渲染的数据模型

$key mixed

与数据模型关联的键值

$index integer

$dataProvider 返回的模型数组中数据模型的从零开始的索引。

返回值 字符串|空值

$afterItem 的调用结果,如果 $afterItem 不是闭包,则返回 null

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

            
renderBeforeItem() 受保护方法 (自 2.0.11 版本起可用)

调用 $beforeItem 闭包,返回执行结果。

如果 $beforeItem 不是闭包,则返回 null

另请参阅 $beforeItem

受保护 string|null renderBeforeItem ( $model, $key, $index )
$model mixed

要渲染的数据模型

$key mixed

与数据模型关联的键值

$index integer

$dataProvider 返回的模型数组中数据模型的从零开始的索引。

返回值 字符串|空值

$beforeItem 的调用结果,如果 $beforeItem 不是闭包,则返回 null

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

            
renderEmpty() 公共方法

定义于: yii\widgets\BaseListView::renderEmpty()

渲染指示列表视图没有数据的 HTML 内容。

另请参阅 $emptyText

公共 string renderEmpty ( )
返回值 字符串

渲染结果

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

            
renderFile() 公共方法

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

渲染视图文件。

公共 string renderFile ( $file, $params = [] )
$file 字符串

要渲染的视图文件。这可以是文件路径或 路径别名

$params 数组

要在视图中提供参数(名称-值对)。

返回值 字符串

渲染结果。

抛出 yii\base\InvalidArgumentException

如果视图文件不存在。

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

            
renderItem() 公共方法

渲染单个数据模型。

公共 string renderItem ( $model, $key, $index )
$model mixed

要渲染的数据模型

$key mixed

与数据模型关联的键值

$index integer

$dataProvider 返回的模型数组中数据模型的从零开始的索引。

返回值 字符串

渲染结果

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

            
renderItems() 公共方法

渲染所有数据模型。

公共 string renderItems ( )
返回值 字符串

渲染结果

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

            
renderPager() 公共方法

定义于: yii\widgets\BaseListView::renderPager()

渲染分页器。

公共 string renderPager ( )
返回值 字符串

渲染结果

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

            
renderSection() 公共方法

定义于: yii\widgets\BaseListView::renderSection()

渲染指定名称的部分。

如果命名部分不受支持,将返回 false。

公共 string|boolean renderSection ( $name )
$name 字符串

部分名称,例如 {summary}{items}

返回值 string|boolean

部分的渲染结果,如果命名部分不受支持,则返回 false。

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

            
renderSorter() 公共方法

定义于: yii\widgets\BaseListView::renderSorter()

渲染排序器。

公共 string renderSorter ( )
返回值 字符串

渲染结果

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

            
renderSummary() 公共方法

定义于: yii\widgets\BaseListView::renderSummary()

渲染摘要文本。

公共 void renderSummary ( )

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

            
run() 公共方法

定义于: yii\widgets\BaseListView::run()

运行窗口小部件。

公共 void run ( )

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

            
setId() 公共方法

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

设置窗口小部件的 ID。

公共 void setId ( $value )
$value 字符串

小部件的 ID。

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

            
setView() 公共方法

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

设置此窗口小部件要使用的视图对象。

公共 void setView ( $view )
$view yii\base\View

可以用于渲染视图或视图文件的视图对象。

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

            
trigger() 公共方法

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

触发事件。

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

公共 void trigger ( $name, yii\base\Event $event null )
$name 字符串

事件名称

$event yii\base\Event|null

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

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

            
widget() 公共静态方法

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

创建窗口小部件实例并运行它。

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

公共静态 string widget ( $config = [] )
$config 数组

将用于初始化对象属性的键值对

返回值 字符串

小部件的渲染结果。

抛出 Throwable

                public static function widget($config = [])
{
    ob_start();
    ob_implicit_flush(false);
    try {
        /* @var $widget Widget */
        $config['class'] = get_called_class();
        $widget = Yii::createObject($config);
        $out = '';
        if ($widget->beforeRun()) {
            $result = $widget->run();
            $out = $widget->afterRun($result);
        }
    } catch (\Exception $e) {
        // close the output buffer opened above if it has not been closed already
        if (ob_get_level() > 0) {
            ob_end_clean();
        }
        throw $e;
    } catch (\Throwable $e) {
        // close the output buffer opened above if it has not been closed already
        if (ob_get_level() > 0) {
            ob_end_clean();
        }
        throw $e;
    }
    return ob_get_clean() . $out;
}