PreviewModule extends AbstractModule implements RequestEnricherInterface, PageSettingsProviderInterface, ResourceProviderInterface, OnSubmitActorInterface, LoggerAwareInterface uses LoggerAwareTrait

Admin Panel Preview Module

Table of Contents

Interfaces

RequestEnricherInterface

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

PageSettingsProviderInterface

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

ResourceProviderInterface

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

OnSubmitActorInterface

Adminpanel interface for modules that need to react on changed configuration (for example if fluid debug settings change, the frontend cache should be cleared)

LoggerAwareInterface

Properties

$cacheManager  : CacheManager

$config  : array{showHiddenPages?: bool, simulateDate?: int, showHiddenRecords?: bool, showScheduledRecords?: bool, simulateUserGroup?: int, showFluidDebug?: bool}

module configuration, set on initialize

$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)

injectCacheManager()  : void

injectConfigurationService()  : void

isEnabled()  : bool

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

onSubmit()  : void

Executed on saving / submit of the configuration form Can be used to react to changed settings (for example: clearing a specific cache)

setModuleData()  : void

setSubModules()  : void

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

clearPreviewSettings()  : void

getBackendUser()  : BackendUserAuthentication

getConfigOptionForModule()  : string

getLanguageService()  : LanguageService

initializeFrontendPreview()  : void

Initialize frontend preview functionality incl.

isEnabledViaTsConfig()  : bool

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