‪TYPO3CMS  11.5
TYPO3\CMS\Dashboard\Widgets\ListWidget Class Reference
Inheritance diagram for TYPO3\CMS\Dashboard\Widgets\ListWidget:
TYPO3\CMS\Dashboard\Widgets\WidgetInterface

Public Member Functions

 __construct (WidgetConfigurationInterface $configuration, ListDataProviderInterface $dataProvider, StandaloneView $view, $buttonProvider=null, array $options=[])
 
 renderWidgetContent ()
 
array getOptions ()
 

Protected Member Functions

 getItems ()
 

Private Attributes

WidgetConfigurationInterface $configuration
 
StandaloneView $view
 
array $options
 
ButtonProviderInterface null $buttonProvider
 
ListDataProviderInterface $dataProvider
 

Detailed Description

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

See also
ListDataProviderInterface
ButtonProviderInterface

Definition at line 33 of file ListWidget.php.

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getItems()

TYPO3\CMS\Dashboard\Widgets\ListWidget::getItems ( )
protected

◆ getOptions()

array TYPO3\CMS\Dashboard\Widgets\ListWidget::getOptions ( )
Returns
‪array

Definition at line 88 of file ListWidget.php.

References TYPO3\CMS\Dashboard\Widgets\ListWidget\$options.

◆ renderWidgetContent()

TYPO3\CMS\Dashboard\Widgets\ListWidget::renderWidgetContent ( )

This method returns the content of a widget. The returned markup will be delivered by an AJAX call and will not be escaped. Be aware of XSS and ensure that the content is well encoded.

Returns
‪string

Implements TYPO3\CMS\Dashboard\Widgets\WidgetInterface.

Definition at line 68 of file ListWidget.php.

References TYPO3\CMS\Dashboard\Widgets\ListWidget\getItems().

Member Data Documentation

◆ $buttonProvider

ButtonProviderInterface null TYPO3\CMS\Dashboard\Widgets\ListWidget::$buttonProvider
private

Definition at line 48 of file ListWidget.php.

Referenced by TYPO3\CMS\Dashboard\Widgets\ListWidget\__construct().

◆ $configuration

WidgetConfigurationInterface TYPO3\CMS\Dashboard\Widgets\ListWidget::$configuration
private

Definition at line 37 of file ListWidget.php.

Referenced by TYPO3\CMS\Dashboard\Widgets\ListWidget\__construct().

◆ $dataProvider

ListDataProviderInterface TYPO3\CMS\Dashboard\Widgets\ListWidget::$dataProvider
private

Definition at line 52 of file ListWidget.php.

Referenced by TYPO3\CMS\Dashboard\Widgets\ListWidget\__construct().

◆ $options

array TYPO3\CMS\Dashboard\Widgets\ListWidget::$options
private

◆ $view

StandaloneView TYPO3\CMS\Dashboard\Widgets\ListWidget::$view
private

Definition at line 41 of file ListWidget.php.

Referenced by TYPO3\CMS\Dashboard\Widgets\ListWidget\__construct().