‪TYPO3CMS  10.4
Public Member Functions | Private Attributes | List of all members
TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration Class Reference
Inheritance diagram for TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration:
TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface

Public Member Functions

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

Private Attributes

string $identifier
 
string $serviceName
 
array $groupNames
 
string $title
 
string $description
 
string $iconIdentifier
 
string $height
 
string $width
 
array $additionalCssClasses
 

Detailed Description

Definition at line 20 of file WidgetConfiguration.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 61 of file WidgetConfiguration.php.

References TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\$additionalCssClasses, TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\$description, TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\$groupNames, TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\$height, TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\$iconIdentifier, TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\$identifier, TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\$serviceName, TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\$title, and TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\$width.

Member Function Documentation

◆ getAdditionalCssClasses()

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

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

Returns
‪string

Implements TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface.

Definition at line 131 of file WidgetConfiguration.php.

◆ getDescription()

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

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

Returns
‪string

Implements TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface.

Definition at line 111 of file WidgetConfiguration.php.

References TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\$description.

◆ getGroupNames()

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

Returns array of group names associated to this widget

Returns
‪array

Implements TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface.

Definition at line 101 of file WidgetConfiguration.php.

References TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\$groupNames.

◆ getHeight()

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

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

Returns
‪string

Implements TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface.

Definition at line 121 of file WidgetConfiguration.php.

References TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\$height.

◆ getIconIdentifier()

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

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

Returns
‪string

Implements TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface.

Definition at line 116 of file WidgetConfiguration.php.

References TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\$iconIdentifier.

◆ getIdentifier()

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

Returns the unique identifier of a widget

Returns
‪string

Implements TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface.

Definition at line 91 of file WidgetConfiguration.php.

References TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\$identifier.

◆ getServiceName()

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

Returns the service name providing the widget implementation

Returns
‪string

Implements TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface.

Definition at line 96 of file WidgetConfiguration.php.

References TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\$serviceName.

◆ getTitle()

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

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

Returns
‪string

Implements TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface.

Definition at line 106 of file WidgetConfiguration.php.

References TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\$title.

◆ getWidth()

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

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

Returns
‪string

Implements TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface.

Definition at line 126 of file WidgetConfiguration.php.

References TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\$width.

Member Data Documentation

◆ $additionalCssClasses

array TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration::$additionalCssClasses
private

Definition at line 56 of file WidgetConfiguration.php.

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

◆ $description

string TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration::$description
private

Definition at line 40 of file WidgetConfiguration.php.

Referenced by TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\__construct(), and TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\getDescription().

◆ $groupNames

array TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration::$groupNames
private

Definition at line 32 of file WidgetConfiguration.php.

Referenced by TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\__construct(), and TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\getGroupNames().

◆ $height

string TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration::$height
private

Definition at line 48 of file WidgetConfiguration.php.

Referenced by TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\__construct(), and TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\getHeight().

◆ $iconIdentifier

string TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration::$iconIdentifier
private

Definition at line 44 of file WidgetConfiguration.php.

Referenced by TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\__construct(), and TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\getIconIdentifier().

◆ $identifier

string TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration::$identifier
private

Definition at line 24 of file WidgetConfiguration.php.

Referenced by TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\__construct(), and TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\getIdentifier().

◆ $serviceName

string TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration::$serviceName
private

Definition at line 28 of file WidgetConfiguration.php.

Referenced by TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\__construct(), and TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\getServiceName().

◆ $title

string TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration::$title
private

Definition at line 36 of file WidgetConfiguration.php.

Referenced by TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\__construct(), and TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\getTitle().

◆ $width

string TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration::$width
private

Definition at line 52 of file WidgetConfiguration.php.

Referenced by TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\__construct(), and TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration\getWidth().