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

Public Member Functions
	injectConfigurationService (ConfigurationService $configurationService)

	isEnabled ()

	setSubModules (array $subModules)

	getSubModules ()

	hasSubmoduleSettings ()

	setModuleData (ModuleDataStorageCollection $moduleData)

‪Public Member Functions inherited from ‪TYPO3\CMS\Adminpanel\ModuleApi\ModuleInterface
	getIdentifier ()

	getLabel ()

Protected Member Functions
	getBackendUser ()

	getLanguageService ()

	isEnabledViaTsConfig ()

Protected Attributes
array	$subModules = []

array	$mainConfiguration

ConfigurationService	$configurationService

ModuleDataStorageCollection	$moduleData

Detailed Description

Abstract base class for Admin Panel Modules containing helper methods and default interface implementations Extend this class when writing own admin panel modules (or implement the Interface directly)

Definition at line 28 of file AbstractModule.php.

Member Function Documentation

◆ getBackendUser()

TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule::getBackendUser ( )

protected

Definition at line 90 of file AbstractModule.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Adminpanel\Modules\CacheModule\getPageSettings().

◆ getLanguageService()

TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule::getLanguageService ( )

protected

Definition at line 95 of file AbstractModule.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Adminpanel\Modules\InfoModule\getLabel(), TYPO3\CMS\Adminpanel\Modules\TsDebugModule\getLabel(), TYPO3\CMS\Adminpanel\Modules\DebugModule\getLabel(), TYPO3\CMS\Adminpanel\Modules\PreviewModule\getLabel(), TYPO3\CMS\Adminpanel\Modules\CacheModule\getLabel(), TYPO3\CMS\Adminpanel\Modules\TsDebugModule\getShortInfo(), TYPO3\CMS\Adminpanel\Modules\InfoModule\getShortInfo(), and TYPO3\CMS\Adminpanel\Modules\DebugModule\getShortInfo().

◆ getSubModules()

TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule::getSubModules ( )

Returns an array of module instances

Returns: ‪ModuleInterface[]

Implements TYPO3\CMS\Adminpanel\ModuleApi\SubmoduleProviderInterface.

Definition at line 65 of file AbstractModule.php.

References TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule\$subModules.

◆ hasSubmoduleSettings()

TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule::hasSubmoduleSettings ( )

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

Implements TYPO3\CMS\Adminpanel\ModuleApi\SubmoduleProviderInterface.

Definition at line 70 of file AbstractModule.php.

◆ injectConfigurationService()

TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule::injectConfigurationService ( ConfigurationService $configurationService )

Definition at line 37 of file AbstractModule.php.

References TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule\$configurationService, and TYPO3\CMS\Adminpanel\Service\ConfigurationService\getMainConfiguration().

◆ isEnabled()

TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule::isEnabled ( )

Returns true if the module is -> either enabled via TSConfig "admPanel.enable" -> or any setting is overridden. Override is a way to use functionality of the admin panel without displaying the admin panel to users for example: hidden records or pages can be displayed by default

Implements TYPO3\CMS\Adminpanel\ModuleApi\ConfigurableInterface.

Definition at line 50 of file AbstractModule.php.

References TYPO3\CMS\Webhooks\Message\$identifier, TYPO3\CMS\Adminpanel\ModuleApi\ModuleInterface\getIdentifier(), and TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule\isEnabledViaTsConfig().