TYPO3\CMS\Adminpanel\ModuleApi\ShortInfoProviderInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Adminpanel\ModuleApi\ShortInfoProviderInterface:

Public Member Functions
	getShortInfo ()
	getIconIdentifier ()
	setModuleData (ModuleDataStorageCollection $moduleData)

Detailed Description

Adminpanel shortinfo provider interface can be used to add the module to the short info bar of the adminpanel

Modules providing shortinfo will be displayed in the bottom bar of the adminpanel and may provide "at a glance" info about the current state (for example the log module provides the number of warnings and errors directly).

Be aware that modules with submodules at the moment can only render one short info (the one of the "parent" module). This will likely change in TYPO3 v10.0.

Definition at line 29 of file ShortInfoProviderInterface.php.

Member Function Documentation

getIconIdentifier()

TYPO3\CMS\Adminpanel\ModuleApi\ShortInfoProviderInterface::getIconIdentifier

(

)

Icon identifier - needs to be registered in iconRegistry

Implemented in TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture, TYPO3\CMS\Adminpanel\Modules\DebugModule, TYPO3\CMS\Adminpanel\Modules\TsDebugModule, and TYPO3\CMS\Adminpanel\Modules\InfoModule.

getShortInfo()

TYPO3\CMS\Adminpanel\ModuleApi\ShortInfoProviderInterface::getShortInfo

(

)

Displayed directly in the bar

Implemented in TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture, TYPO3\CMS\Adminpanel\Modules\DebugModule, TYPO3\CMS\Adminpanel\Modules\InfoModule, and TYPO3\CMS\Adminpanel\Modules\TsDebugModule.

setModuleData()

TYPO3\CMS\Adminpanel\ModuleApi\ShortInfoProviderInterface::setModuleData

(

ModuleDataStorageCollection

$moduleData

)

Allow using collected data in short info

Implemented in TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture.