Abstract Class yii\widgets\BaseListView
| Inheritance | yii\widgets\BaseListView » yii\base\Widget » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable, yii\base\ViewContextInterface |
| Subclasses | yii\grid\GridView, yii\widgets\ListView |
| Available since version | 2.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
| Property | Type | Description | Defined 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. This property is read-only. | 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|null | ID of the widget. Note that the type of this property differs in getter and setter. See getId() and setId() for details. | 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. Note that the type of this property differs in getter and setter. See getView() and setView() for details. | yii\base\Widget |
| $viewPath | string | The directory containing the view files for this widget. This property is read-only. | yii\base\Widget |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\BaseObject |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\BaseObject |
| __get() | Returns the value of an object property. | yii\base\BaseObject |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
| __set() | Sets value of an object property. | yii\base\BaseObject |
| __unset() | Sets an object property to null. | yii\base\BaseObject |
| 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\BaseObject |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\BaseObject |
| className() | 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() | 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\BaseObject |
| hasProperty() | Returns a value indicating whether a property is defined. | yii\base\BaseObject |
| 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
| Event | Type | Description | Defined 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
The data provider for the view. This property is required.
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:
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.
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().
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.
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 and will overwrite this value.
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.
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 and will overwrite this value.
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
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.
Method Details
Initializes the view.
| public void init ( ) |
Renders the HTML content indicating that the list view has no data.
See also $emptyText.
| public string renderEmpty ( ) | ||
| return | string | The rendering result |
|---|---|---|
Renders the data models.
| public abstract string renderItems ( ) | ||
| return | string | The rendering result. |
|---|---|---|
Renders the pager.
| public string renderPager ( ) | ||
| return | string | The rendering result |
|---|---|---|
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., |
| return | string|boolean | The rendering result of the section, or false if the named section is not supported. |
|---|---|---|
Renders the sorter.
| public string renderSorter ( ) | ||
| return | string | The rendering result |
|---|---|---|
Renders the summary text.
| public void renderSummary ( ) |
Runs the widget.
| public void run ( ) |