Abstract Class yii\widgets\BaseListView

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

BaseListView 是数据提供者显示数据的小部件(如 ListView 和 GridView )的基类.

它提供了排序, 分页和过滤数据等功能.

有关 BaseListView 的更多详细信息和使用信息, 请参阅 权威指南 - 显示数据 - 数据小部件(Data Widgets).

公共属性

隐藏继承的属性

属性类型描述定义在
$autoIdPrefix string 自动生成的小部件 ID 的前缀. yii\base\Widget
$behaviors yii\base\Behavior[] 附加到此组件的行为列表. 该属性是只读的. yii\base\Component
$counter integer 用于为小部件生成 $id 的计数器. yii\base\Widget
$dataProvider yii\data\DataProviderInterface 视图的数据提供者. yii\widgets\BaseListView
$emptyText string|false $dataProvider 没有任何数据时要显示的 HTML 内容. yii\widgets\BaseListView
$emptyTextOptions array 列表视图的 $emptyText 的 HTML 属性. yii\widgets\BaseListView
$id string|null 小部件的 ID. Note: 此属性的类型在 getter 和 setter 中不同. 有关详细信息, 请参阅 getId()setId(). yii\base\Widget
$layout string 决定如何组织列表视图的不同部分的布局. yii\widgets\BaseListView
$options array 列表视图的容器标签的 HTML 属性. yii\widgets\BaseListView
$pager array 分页小部件的配置. yii\widgets\BaseListView
$showOnEmpty boolean 如果 $dataProvider 不返回任何数据, 是否显示一个空的列表视图. yii\widgets\BaseListView
$sorter array 排序小部件的配置. yii\widgets\BaseListView
$stack yii\base\Widget[] 当前正在渲染的小部件(未结束). yii\base\Widget
$summary string 将 HTML 内容显示为列表视图的摘要. yii\widgets\BaseListView
$summaryOptions array 列表视图摘要的 HTML 属性. yii\widgets\BaseListView
$view yii\web\View 可用于渲染视图或视图文件的视图对象. Note: 此属性的类型在 getter 和 setter 中不同. 有关详细信息, 请参阅 getView()setView(). yii\base\Widget
$viewPath string 包含此小部件的视图文件的目录. 该属性是只读的. 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() 在执行小部件后立即调用该方法. 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\ViewContextInterface
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
renderItems() 渲染数据模型. yii\widgets\BaseListView
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

事件

隐藏继承的事件

事件类型描述定义在
EVENT_AFTER_RUN yii\base\WidgetEvent 在执行小部件之后立即触发的事件. (available since version 2.0.11) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent 在执行小部件之前触发的事件. (available since version 2.0.11) yii\base\Widget
EVENT_INIT yii\base\Event 当通过 init() 初始化小部件时触发的事件. (available since version 2.0.11) yii\base\Widget

属性详情

$dataProvider public 属性

视图的数据提供者. 此属性是必需的.

$emptyText public 属性

$dataProvider 没有任何数据时要显示的 HTML 内容.· 如果设置为false, 则不会生成额外的 HTML 内容. 默认值是文本"No results found."(未找到结果). 这将被翻译成当前的应用程序语言.

参见:

public string|false $emptyText null
$emptyTextOptions public 属性

列表视图的 $emptyText 的 HTML 属性. tag元素指定 element 元素的标签名称, 默认为div.

参见 yii\helpers\Html::renderTagAttributes() 有关如何渲染属性的详细信息.

public array $emptyTextOptions = ['class' => 'empty']
$layout public 属性

决定如何组织列表视图的不同部分的布局. 以下标记将替换为相应的部分内容::

public string $layout "{summary}\n{items}\n{pager}"
$options public 属性

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

参见 yii\helpers\Html::renderTagAttributes() 有关如何渲染属性的详细信息.

public array $options = []
$pager public 属性

分页小部件的配置.

默认情况下, 将使用 yii\widgets\LinkPager 来渲染分页. 你可以通过配置class元素来使用其它的 widget 类.

Note: 该小部件必须支持pagination属性, 该属性将使用 $dataProvidersort 值, 并将覆盖此值.

public array $pager = []
$showOnEmpty public 属性

如果 $dataProvider 不返回任何数据, 是否显示一个空的列表视图. 默认值为false, 它根据 $emptyText$emptyTextOptions 属性显示元素.

public boolean $showOnEmpty false
$sorter public 属性

排序小部件的配置.

默认情况下, 将使用 yii\widgets\LinkSorter 来渲染排序. 你可以通过配置class元素来使用其它的 widget 类.

Note: 该小部件必须支持sort属性, 该属性将使用 $dataProvidersort 值, 并将覆盖此值.

public array $sorter = []
$summary public 属性

将 HTML 内容显示为列表视图的摘要.

如果你不想显示摘要, 则可以将其设置为空字符串.

以下标记将被替换为相应的值:

  • {begin}: 当前正在显示的起始行号(从1开始);
  • {end}: 当前正在显示的结束行号(从1开始);
  • {count}: 当前正在显示的行数;
  • {totalCount}: 可用的总行数;
  • {page}: 当前正在显示的页码(从1开始);
  • {pageCount}: 可用的总页数.
public string $summary null
$summaryOptions public 属性

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

参见 yii\helpers\Html::renderTagAttributes() 有关如何渲染属性的详细信息.

public array $summaryOptions = ['class' => 'summary']

方法详情

init() public 方法

初始化视图.

public void init ( )
renderEmpty() public 方法

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

参见 $emptyText.

public string renderEmpty ( )
return string

渲染结果.

renderItems() public abstract 方法

渲染数据模型.

public abstract string renderItems ( )
return string

渲染结果.

renderPager() public 方法

渲染分页.

public string renderPager ( )
return string

渲染结果.

renderSection() public 方法

渲染指定名称的部分.

如果指定的部分不受支持, 则返回false.

public string|boolean renderSection ( $name )
$name string

部分名称, eg, {summary}, {items}.

return string|boolean

该部分的渲染结果; 如果指定的部分不受支持, 则为false.

renderSorter() public 方法

渲染排序.

public string renderSorter ( )
return string

渲染结果.

renderSummary() public 方法

渲染摘要文本.

public void renderSummary ( )
run() public 方法

运行小部件.

public void run ( )