TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration Class Reference

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

Public Member Functions
	__construct (private readonly string $identifier, private readonly string $serviceName, private readonly array $groupNames, private readonly string $title, private readonly string $description, private readonly string $iconIdentifier, private readonly string $height, private readonly string $width, private readonly array $additionalCssClasses)
	getIdentifier ()
	getServiceName ()
	getGroupNames ()
	getTitle ()
	getDescription ()
	getIconIdentifier ()
	getHeight ()
	getWidth ()
	getAdditionalCssClasses ()

Detailed Description

Definition at line 20 of file WidgetConfiguration.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration::__construct	(	private readonly string	$identifier,
		private readonly string	$serviceName,
		private readonly array	$groupNames,
		private readonly string	$title,
		private readonly string	$description,
		private readonly string	$iconIdentifier,
		private readonly string	$height,
		private readonly string	$width,
		private readonly array	$additionalCssClasses
	)

Exceptions

Definition at line 25 of file WidgetConfiguration.php.

Member Function Documentation

getAdditionalCssClasses()

TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration::getAdditionalCssClasses

(

)

This method returns additional CSS classes which should be added to the rendered widget

Implements TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface.

Definition at line 85 of file WidgetConfiguration.php.

getDescription()

TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration::getDescription

(

)

Returns the description of a widget, this is used for the widget selector

Implements TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface.

Definition at line 65 of file WidgetConfiguration.php.

getGroupNames()

TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration::getGroupNames

(

)

Returns array of group names associated to this widget

Implements TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface.

Definition at line 55 of file WidgetConfiguration.php.

getHeight()

TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration::getHeight

(

)

Returns the height of a widget (small, medium, large)

Implements TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface.

Definition at line 75 of file WidgetConfiguration.php.

getIconIdentifier()

TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration::getIconIdentifier

(

)

Returns the icon identifier of a widget, this is used for the widget selector

Implements TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface.

Definition at line 70 of file WidgetConfiguration.php.

getIdentifier()

TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration::getIdentifier

(

)

Returns the unique identifier of a widget

Implements TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface.

Definition at line 45 of file WidgetConfiguration.php.

References TYPO3\CMS\Webhooks\Message\$identifier.

getServiceName()

TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration::getServiceName

(

)

Returns the service name providing the widget implementation

Implements TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface.

Definition at line 50 of file WidgetConfiguration.php.

getTitle()

TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration::getTitle

(

)

Returns the title of a widget, this is used for the widget selector

Implements TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface.

Definition at line 60 of file WidgetConfiguration.php.

getWidth()

TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration::getWidth

(

)

Returns the width of a widget (small, medium, large)

Implements TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface.

Definition at line 80 of file WidgetConfiguration.php.