TYPO3\CMS\Dashboard\Widgets\NumberWithIconWidget Class Reference

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

Public Member Functions
	__construct (WidgetConfigurationInterface $configuration, NumberWithIconDataProviderInterface $dataProvider, StandaloneView $view, array $options=[])
	renderWidgetContent ()
array	getOptions ()

Private Attributes
WidgetConfigurationInterface	$configuration
StandaloneView	$view
array	$options
NumberWithIconDataProviderInterface	$dataProvider

Detailed Description

Concrete Number with Icon implementation

The widget will show widget with an icon, a number, a title and a subtitle. The number is provided by a data provider.

The following options are available during registration:

• ‪icon string The icon-identifier of the icon that should be shown in the widget. You should register your icon with the Icon API
• ‪title string The main title that will be shown in the widget as an explanation of the shown number. You can either enter a normal string or a translation string (eg. LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.failedLogins.title)
• ‪subtitle string The subtitle that will give some additional information about the number and title. You can either enter a normal string or a translation string (eg. LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.failedLogins.subtitle)

See also

‪NumberWithIconDataProviderInterface

Definition at line 40 of file NumberWithIconWidget.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Dashboard\Widgets\NumberWithIconWidget::__construct	(	WidgetConfigurationInterface	$configuration,
		NumberWithIconDataProviderInterface	$dataProvider,
		StandaloneView	$view,
		array	$options = []
	)

Definition at line 55 of file NumberWithIconWidget.php.

References TYPO3\CMS\Dashboard\Widgets\NumberWithIconWidget\$configuration, TYPO3\CMS\Dashboard\Widgets\NumberWithIconWidget\$dataProvider, TYPO3\CMS\Dashboard\Widgets\NumberWithIconWidget\$options, and TYPO3\CMS\Dashboard\Widgets\NumberWithIconWidget\$view.

Member Function Documentation

getOptions()

array TYPO3\CMS\Dashboard\Widgets\NumberWithIconWidget::getOptions

(

)

Returns

‪array

Definition at line 87 of file NumberWithIconWidget.php.

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

renderWidgetContent()

TYPO3\CMS\Dashboard\Widgets\NumberWithIconWidget::renderWidgetContent

(

)

@inheritDoc

Implements TYPO3\CMS\Dashboard\Widgets\WidgetInterface.

Definition at line 70 of file NumberWithIconWidget.php.

Member Data Documentation

$configuration

WidgetConfigurationInterface TYPO3\CMS\Dashboard\Widgets\NumberWithIconWidget::$configuration

private

Definition at line 44 of file NumberWithIconWidget.php.

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

$dataProvider

NumberWithIconDataProviderInterface TYPO3\CMS\Dashboard\Widgets\NumberWithIconWidget::$dataProvider

private

Definition at line 53 of file NumberWithIconWidget.php.

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

$options

array TYPO3\CMS\Dashboard\Widgets\NumberWithIconWidget::$options

private

Definition at line 50 of file NumberWithIconWidget.php.

Referenced by TYPO3\CMS\Dashboard\Widgets\NumberWithIconWidget\__construct(), and TYPO3\CMS\Dashboard\Widgets\NumberWithIconWidget\getOptions().

$view

StandaloneView TYPO3\CMS\Dashboard\Widgets\NumberWithIconWidget::$view

private

Definition at line 47 of file NumberWithIconWidget.php.

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