BaseListView

API reference › yii › widgets › BaseListView

abstract class	`yii\widgets\BaseListView`
Extends	`yii\base\Widget` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\ViewContextInterface`, `yii\base\Configurable`
Since	2.0
Source	`framework/widgets/BaseListView.php`

2 subclasses

BaseListView is a base class for widgets displaying data from data provider such as ListView and GridView.

It provides features like sorting, paging and also filtering the data.

For more details and usage information on BaseListView, see the guide article on data widgets.

Properties

Property	Type	Description	Defined by
`$autoIdPrefix` static	`string`	The prefix to the automatically generated widget IDs. Default: `'w'`.	`yii\base\Widget`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$dataProvider`	`yii\data\DataProviderInterface`	The data provider for the view. Default: `null`.	`BaseListView`
`$emptyText`	`string\|false\|null`	The HTML content to be displayed when `$dataProvider` does not have any data. Default: `null`.	`BaseListView`
`$emptyTextOptions`	`array`	The HTML attributes for the emptyText of the list view. Default: `['class' => 'empty']`.	`BaseListView`
`$id`	`string`	Id of the widget.	`yii\base\Widget`
`$layout`	`string`	The layout that determines how different sections of the list view should be organized. Default: `"{summary}\n{items}\n{pager}"`.	`BaseListView`
`$options`	`array`	The HTML attributes for the container tag of the list view. Default: `[]`.	`BaseListView`
`$pager`	`array`	The configuration for the pager widget. Default: `[]`.	`BaseListView`
`$showOnEmpty`	`bool`	Whether to show an empty list view if `$dataProvider` returns no data. Default: `false`.	`BaseListView`
`$sorter`	`array`	The configuration for the sorter widget. Default: `[]`.	`BaseListView`
`$summary`	`string\|null`	The HTML content to be displayed as the summary of the list view. Default: `null`.	`BaseListView`
`$summaryOptions`	`array`	The HTML attributes for the summary of the list view. Default: `['class' => 'summary']`.	`BaseListView`
`$view`	`yii\web\View`	The view object that can be used to render views or view files.	`yii\base\Widget`
`$viewPath` read-only	`string`	The directory containing the view files for this widget.	`yii\base\Widget`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\Component`
`__clone()`	This method is called after the object is created by cloning an existing one.	`yii\base\Component`
`__get()`	Returns the value of a component property.	`yii\base\Component`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\Component`
`__set()`	Sets the value of a component property.	`yii\base\Component`
`__unset()`	Sets a component property to be null.	`yii\base\Component`
`afterRun()`	This method is invoked right after a widget is executed.	`yii\base\Widget`
`attachBehavior()`	Attaches a behavior to this component.	`yii\base\Component`
`attachBehaviors()`	Attaches a list of behaviors to the component.	`yii\base\Component`
`beforeRun()`	This method is invoked right before the widget is executed.	`yii\base\Widget`
`begin()` static	Begins a widget.	`yii\base\Widget`
`behaviors()`	Returns a list of behaviors that this component should behave as.	`yii\base\Component`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\Component`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\Component`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`detachBehavior()`	Detaches a behavior from the component.	`yii\base\Component`
`detachBehaviors()`	Detaches all behaviors from the component.	`yii\base\Component`
`end()` static	Ends a widget.	`yii\base\Widget`
`ensureBehaviors()`	Makes sure that the behaviors declared in `behaviors()` are attached to this component.	`yii\base\Component`
`getBehavior()`	Returns the named behavior object.	`yii\base\Component`
`getBehaviors()`	Returns all behaviors attached to this component.	`yii\base\Component`
`getId()`	Returns the ID of the widget.	`yii\base\Widget`
`getView()`	Returns the view object that can be used to render views or view files.	`yii\base\Widget`
`getViewPath()`	Returns the directory containing the view files for this widget.	`yii\base\Widget`
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	`yii\base\Component`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\Component`
`hasProperty()`	Returns a value indicating whether a property is defined for this component.	`yii\base\Component`
`init()`	Initializes the view.	`BaseListView`
`off()`	Detaches an existing event handler from this component.	`yii\base\Component`
`on()`	Attaches an event handler to an event.	`yii\base\Component`
`render()`	Renders a view.	`yii\base\Widget`
`renderEmpty()`	Renders the HTML content indicating that the list view has no data.	`BaseListView`
`renderFile()`	Renders a view file.	`yii\base\Widget`
`renderItems()` abstract	Renders the data models.	`BaseListView`
`renderPager()`	Renders the pager.	`BaseListView`
`renderSection()`	Renders a section of the specified name.	`BaseListView`
`renderSorter()`	Renders the sorter.	`BaseListView`
`renderSummary()`	Renders the summary text.	`BaseListView`
`run()`	Runs the widget.	`BaseListView`
`setId()`	Sets the ID of the widget.	`yii\base\Widget`
`setView()`	Sets the view object to be used by this widget.	`yii\base\Widget`
`trigger()`	Triggers an event.	`yii\base\Component`
`widget()` static	Creates a widget instance and runs it.	`yii\base\Widget`

Events

Event	Type	Description	Defined by
`EVENT_INIT`	`yii\base\Event`	An event that is triggered when the widget is initialized via `init()`. Event name: `'init'`. Available since 2.0.11.	`yii\base\Widget`
`EVENT_BEFORE_RUN`	`yii\base\WidgetEvent`	An event raised right before executing a widget. Event name: `'beforeRun'`. Available since 2.0.11.	`yii\base\Widget`
`EVENT_AFTER_RUN`	`yii\base\WidgetEvent`	An event raised right after executing a widget. Event name: `'afterRun'`. Available since 2.0.11.	`yii\base\Widget`

Property details

$dataProvider

public yii\data\DataProviderInterface $dataProvider = null

The data provider for the view.

This property is required.

$emptyText

public string|false|null $emptyText = null

The HTML content to be displayed when $dataProvider does not have any data.

When this is set to false no extra HTML content will be generated. The default value is the text “No results found.” which will be translated to the current application language.

$emptyTextOptions

public array $emptyTextOptions = ['class' => 'empty']

The HTML attributes for the emptyText of the list view.

The “tag” element specifies the tag name of the emptyText element and defaults to “div”.

$layout

public string $layout = "{summary}\n{items}\n{pager}"

The layout that determines how different sections of the list view should be organized.

The following tokens will be replaced with the corresponding section contents:

{summary}: the summary section. See renderSummary().
{items}: the list items. See renderItems().
{sorter}: the sorter. See renderSorter().
{pager}: the pager. See renderPager().

$options

public array $options = []

The HTML attributes for the container tag of the list view.

The “tag” element specifies the tag name of the container element and defaults to “div”.

public array $pager = []

The configuration for the pager widget.

By default, LinkPager will be used to render the pager. You can use a different widget class by configuring the “class” element. Note that the widget must support the pagination property which will be populated with the pagination value of the $dataProvider and will overwrite this value.

$showOnEmpty

public bool $showOnEmpty = false

Whether to show an empty list view if $dataProvider returns no data.

The default value is false which displays an element according to the $emptyText and $emptyTextOptions properties.

$sorter

public array $sorter = []

The configuration for the sorter widget.

By default, LinkSorter will be used to render the sorter. You can use a different widget class by configuring the “class” element. Note that the widget must support the sort property which will be populated with the sort value of the $dataProvider and will overwrite this value.

$summary

public string|null $summary = null

The HTML content to be displayed as the summary of the list view.

If you do not want to show the summary, you may set it with an empty string.

The following tokens will be replaced with the corresponding values:

{begin}: the starting row number (1-based) currently being displayed
{end}: the ending row number (1-based) currently being displayed
{count}: the number of rows currently being displayed
{totalCount}: the total number of rows available
{page}: the page number (1-based) current being displayed
{pageCount}: the number of pages available

$summaryOptions

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

The HTML attributes for the summary of the list view.

The “tag” element specifies the tag name of the summary element and defaults to “div”.

Method details

init()

public function init(): mixed

Initializes the view.

Returns

mixed

renderEmpty()

public function renderEmpty(): string

Renders the HTML content indicating that the list view has no data.

Returns

string: The rendering result

See also

$emptyText

renderItems()

abstract public function renderItems(): string

Renders the data models.

Returns

string: The rendering result.

renderPager()

public function renderPager(): string

Renders the pager.

Returns

string: The rendering result

renderSection()

public function renderSection(string $name): string|bool

Renders a section of the specified name.

If the named section is not supported, false will be returned.

Parameters

Parameter	Type	Description
`$name`	`string`	The section name, e.g., `{summary}`, `{items}`.

Returns

string|bool: The rendering result of the section, or false if the named section is not supported.

renderSorter()

public function renderSorter(): string

Renders the sorter.

Returns

string: The rendering result

renderSummary()

public function renderSummary(): mixed

Renders the summary text.

Returns

mixed

run()

public function run(): mixed

Runs the widget.

Returns

mixed