Abstract Class yii\widgets\BaseListView

Inheritanceyii\widgets\BaseListView » yii\base\Widget » yii\base\Component » yii\base\Object
Implementsyii\base\Configurable, yii\base\ViewContextInterface
Subclassesyii\grid\GridView, yii\widgets\ListView
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/widgets/BaseListView.php

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

Hide inherited properties

PropertyTypeDescriptionDefined By
$autoIdPrefix string The prefix to the automatically generated widget IDs. yii\base\Widget
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$counter integer A counter used to generate $id for widgets. yii\base\Widget
$dataProvider yii\data\DataProviderInterface The data provider for the view. yii\widgets\BaseListView
$emptyText string|false The HTML content to be displayed when $dataProvider does not have any data. yii\widgets\BaseListView
$emptyTextOptions array The HTML attributes for the emptyText of the list view. yii\widgets\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. yii\widgets\BaseListView
$options array The HTML attributes for the container tag of the list view. yii\widgets\BaseListView
$pager array The configuration for the pager widget. yii\widgets\BaseListView
$showOnEmpty boolean Whether to show an empty list view if $dataProvider returns no data. yii\widgets\BaseListView
$sorter array The configuration for the sorter widget. yii\widgets\BaseListView
$stack yii\base\Widget[] The widgets that are currently being rendered (not ended). yii\base\Widget
$summary string The HTML content to be displayed as the summary of the list view. yii\widgets\BaseListView
$summaryOptions array The HTML attributes for the summary of the list view. yii\widgets\BaseListView
$view yii\web\View The view object that can be used to render views or view files. yii\base\Widget
$viewPath string The view path that may be prefixed to a relative view name. yii\base\ViewContextInterface

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Object
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\Object
__get() Returns the value of an object property. yii\base\Object
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Object
__set() Sets value of an object property. yii\base\Object
__unset() Sets an object property to null. yii\base\Object
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() 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\Object
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Object
className() Returns the fully qualified name of this class. yii\base\Object
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
end() 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() yii\base\ViewContextInterface
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\Object
hasProperty() Returns a value indicating whether a property is defined. yii\base\Object
init() Initializes the view. yii\widgets\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. yii\widgets\BaseListView
renderFile() Renders a view file. yii\base\Widget
renderItems() Renders the data models. yii\widgets\BaseListView
renderPager() Renders the pager. yii\widgets\BaseListView
renderSection() Renders a section of the specified name. yii\widgets\BaseListView
renderSorter() Renders the sorter. yii\widgets\BaseListView
renderSummary() Renders the summary text. yii\widgets\BaseListView
run() Runs the widget. yii\widgets\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() Creates a widget instance and runs it. yii\base\Widget

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_AFTER_RUN yii\base\WidgetEvent An event raised right after executing a widget. (available since version 2.0.11) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent An event raised right before executing a widget. (available since version 2.0.11) yii\base\Widget
EVENT_INIT yii\base\Event An event that is triggered when the widget is initialized via init(). (available since version 2.0.11) yii\base\Widget

Property Details

$dataProvider public property

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

$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:

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:

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

init() public method

Initializes the view.

public void init ( )
renderEmpty() public method

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

See also $emptyText.

public string renderEmpty ( )
return string

The rendering result

renderItems() public abstract method

Renders the data models.

public abstract string renderItems ( )
return string

The rendering result.

renderPager() public method

Renders the pager.

public string renderPager ( )
return string

The rendering result

renderSection() public method

Renders a section of the specified name.

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

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

The section name, e.g., {summary}, {items}.

return string|boolean

The rendering result of the section, or false if the named section is not supported.

renderSorter() public method

Renders the sorter.

public string renderSorter ( )
return string

The rendering result

renderSummary() public method

Renders the summary text.

public void renderSummary ( )
run() public method

Runs the widget.

public void run ( )