‪TYPO3CMS  9.5
TYPO3\CMS\Adminpanel\ModuleApi\SubmoduleProviderInterface Interface Reference
Inheritance diagram for TYPO3\CMS\Adminpanel\ModuleApi\SubmoduleProviderInterface:
TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture TYPO3\CMS\Adminpanel\Modules\CacheModule TYPO3\CMS\Adminpanel\Modules\DebugModule TYPO3\CMS\Adminpanel\Modules\EditModule TYPO3\CMS\Adminpanel\Modules\InfoModule TYPO3\CMS\Adminpanel\Modules\PreviewModule TYPO3\CMS\Adminpanel\Modules\TsDebugModule TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\DisabledMainModuleFixture

Public Member Functions

 setSubModules (array $subModules)
 
TYPO3 CMS Adminpanel ModuleApi ModuleInterface[] getSubModules ()
 
bool hasSubmoduleSettings ()
 

Detailed Description

Adminpanel interface providing hierarchical functionality for modules

A module implementing this interface may have submodules. Be aware that the current implementation of the adminpanel renders a maximum level of 2 for modules. If you need to render more levels, write your own module and implement multi-hierarchical rendering in the getContent method

See also
‪\TYPO3\CMS\Adminpanel\ModuleApi\ContentProviderInterface::getContent()

Definition at line 28 of file SubmoduleProviderInterface.php.

Member Function Documentation

◆ getSubModules()

TYPO3 CMS Adminpanel ModuleApi ModuleInterface [] TYPO3\CMS\Adminpanel\ModuleApi\SubmoduleProviderInterface::getSubModules ( )

Returns an array of module instances

Returns
‪\TYPO3\CMS\Adminpanel\ModuleApi\ModuleInterface[]

Implemented in TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture, and TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule.

◆ hasSubmoduleSettings()

bool TYPO3\CMS\Adminpanel\ModuleApi\SubmoduleProviderInterface::hasSubmoduleSettings ( )

Return true if any of the submodules has settings to be rendered (can be used to render settings in a central place)

Returns
‪bool

Implemented in TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture, and TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule.

◆ setSubModules()

TYPO3\CMS\Adminpanel\ModuleApi\SubmoduleProviderInterface::setSubModules ( array  $subModules)

Sets array of module instances (instances of ModuleInterface) as submodules

Parameters
\TYPO3\CMS\Adminpanel\ModuleApi\ModuleInterface[]$subModules

Implemented in TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture, and TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule.