Abstract Class yii\widgets\BaseListView

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.

Public Properties

Public Methods

Events

Property Details

$dataProvider public property

The data provider for the view. This property is required.

public yii\data\DataProviderInterface $dataProvider = null

$emptyText public property

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.

See also:

• $showOnEmpty
• $emptyTextOptions

public string|false $emptyText = null

$emptyTextOptions public property

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".

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

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

$layout public property

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

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

$options public property

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".

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $options = []

$pager public property

The configuration for the pager widget. By default, yii\widgets\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.

public array $pager = []

$showOnEmpty public property

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.

public boolean $showOnEmpty = false

$sorter public property

The configuration for the sorter widget. By default, yii\widgets\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.

public array $sorter = []

$summary public property

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

public string $summary = null

$summaryOptions public property

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".

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

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

Method Details