TYPO3\CMS\Dashboard\Widgets\WidgetInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Dashboard\Widgets\WidgetInterface:

Public Member Functions
	renderWidgetContent ()
	getOptions ()

Detailed Description

The WidgetInterface is the base interface for all kind of widgets. All widgets must implement this interface. It contains the methods which are required for all widgets.

Definition at line 25 of file WidgetInterface.php.

Member Function Documentation

getOptions()

TYPO3\CMS\Dashboard\Widgets\WidgetInterface::getOptions

(

)

This method returns the options of the widget as set in the registration.

Implemented in TYPO3\CMS\Dashboard\Widgets\RssWidget, TYPO3\CMS\Dashboard\Widgets\BarChartWidget, TYPO3\CMS\Dashboard\Widgets\DoughnutChartWidget, TYPO3\CMS\Dashboard\Widgets\NumberWithIconWidget, TYPO3\CMS\Dashboard\Widgets\CtaWidget, TYPO3\CMS\Dashboard\Widgets\ListWidget, TYPO3\CMS\Dashboard\Widgets\T3GeneralInformationWidget, and TYPO3\CMS\Seo\Widgets\PagesWithoutDescriptionWidget.

renderWidgetContent()

TYPO3\CMS\Dashboard\Widgets\WidgetInterface::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.

Implemented in TYPO3\CMS\Dashboard\Widgets\RssWidget, TYPO3\CMS\Dashboard\Widgets\CtaWidget, TYPO3\CMS\Dashboard\Widgets\NumberWithIconWidget, TYPO3\CMS\Dashboard\Widgets\BarChartWidget, TYPO3\CMS\Dashboard\Widgets\DoughnutChartWidget, TYPO3\CMS\Dashboard\Widgets\ListWidget, TYPO3\CMS\Dashboard\Widgets\T3GeneralInformationWidget, and TYPO3\CMS\Seo\Widgets\PagesWithoutDescriptionWidget.