ListWidget implements WidgetInterface
Concrete List Widget implementation
The widget will show a simple list with items provided by a data provider. You can add a button to the widget by defining a button provider.
There are no options available for this widget
Tags
Table of Contents
Interfaces
- WidgetInterface
- The WidgetInterface is the base interface for all kind of widgets.
Methods
- __construct() : mixed
- getOptions() : array<string|int, mixed>
- renderWidgetContent() : string
- This method returns the content of a widget. The returned markup will be delivered by an AJAX call and will not be escaped.
- getItems() : array<string|int, mixed>
Methods
__construct()
public
__construct(WidgetConfigurationInterface $configuration, ListDataProviderInterface $dataProvider, StandaloneView $view[, mixed $buttonProvider = null ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $configuration : WidgetConfigurationInterface
- $dataProvider : ListDataProviderInterface
- $view : StandaloneView
- $buttonProvider : mixed = null
- $options : array<string|int, mixed> = []
getOptions()
public
getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>renderWidgetContent()
This method returns the content of a widget. The returned markup will be delivered by an AJAX call and will not be escaped.
public
renderWidgetContent() : string
Be aware of XSS and ensure that the content is well encoded.
Return values
stringgetItems()
protected
getItems() : array<string|int, mixed>