CacheModule extends AbstractModule implements PageSettingsProviderInterface, RequestEnricherInterface, ResourceProviderInterface

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)

Table of Contents

Interfaces

PageSettingsProviderInterface

Adminpanel page settings interface denotes that a module has settings regarding the page rendering.

RequestEnricherInterface

Adminpanel interface to denote that a module has tasks to perform on initialization of the request and may enrich said request

ResourceProviderInterface

Adminpanel interface to denote that a module has own resource files.

Properties

$configurationService  : ConfigurationService

$mainConfiguration  : array<string|int, mixed>

Main Configuration (from UserTSConfig, admPanel)

$moduleData  : ModuleDataStorageCollection

$subModules  : array<string|int, ModuleInterface>

Methods

enrich()  : ServerRequestInterface

Initialize the module - runs in the TYPO3 middleware stack at an early point may manipulate the current request

getCssFiles()  : array<string|int, mixed>

Returns a string array with css files that will be rendered after the module

getIconIdentifier()  : string

getIdentifier()  : string

Identifier for this module, for example "preview" or "cache"

getJavaScriptFiles()  : array<string|int, mixed>

Returns a string array with javascript files that will be rendered after the module

getLabel()  : string

Module label

getPageSettings()  : string

getSubModules()  : array<string|int, ModuleInterface>

Returns an array of module instances

hasSubmoduleSettings()  : bool

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

injectConfigurationService()  : void

isEnabled()  : bool

Returns true if the module is -> either enabled via TSConfig "admPanel.enable" -> or any setting is overridden.

setModuleData()  : void

setSubModules()  : void

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

getBackendUser()  : BackendUserAuthentication

getLanguageService()  : LanguageService

isEnabledViaTsConfig()  : bool

Returns true if TSConfig "admPanel.enable" is set for this module (or all modules)