[FEATURE] Refactor AdminPanel API to use composition
[Packages/TYPO3.CMS.git] / typo3 / sysext / adminpanel / Classes / ModuleApi / ShortInfoProviderInterface.php
1 <?php
2 declare(strict_types = 1);
3
4 namespace TYPO3\CMS\Adminpanel\ModuleApi;
5
6 /*
7 * This file is part of the TYPO3 CMS project.
8 *
9 * It is free software; you can redistribute it and/or modify it under
10 * the terms of the GNU General Public License, either version 2
11 * of the License, or any later version.
12 *
13 * For the full copyright and license information, please read the
14 * LICENSE.txt file that was distributed with this source code.
15 *
16 * The TYPO3 project - inspiring people to share!
17 */
18
19 /**
20 * Adminpanel shortinfo provider interface can be used to add the module to the short info bar of the adminpanel
21 *
22 * Modules providing shortinfo will be displayed in the bottom bar of the adminpanel and may provide "at a glance" info
23 * about the current state (for example the log module provides the number of warnings and errors directly).
24 *
25 * Be aware that modules with submodules at the moment can only render one short info (the one of the "parent" module).
26 * This will likely change in v10.
27 */
28 interface ShortInfoProviderInterface
29 {
30 /**
31 * Displayed directly in the bar
32 *
33 * @return string
34 */
35 public function getShortInfo(): string;
36
37 /**
38 * Icon identifier - needs to be registered in iconRegistry
39 *
40 * @return string
41 */
42 public function getIconIdentifier(): string;
43 }