TsDebugModule extends AbstractModule implements ShortInfoProviderInterface

Admin Panel TypoScript Debug Module

Attributes
#[Autoconfigure]
$public: true

Table of Contents

Interfaces

ShortInfoProviderInterface
Adminpanel shortinfo provider interface can be used to add the module to the short info bar of the adminpanel

Properties

$configurationService  : ConfigurationService
$mainConfiguration  : array<string|int, mixed>
Main Configuration (from UserTSConfig, admPanel)
$moduleData  : ModuleDataStorageCollection
$subModules  : array<string|int, ModuleInterface>

Methods

getIconIdentifier()  : string
Icon identifier - needs to be registered in iconRegistry
getIdentifier()  : string
Identifier for this module, for example "preview" or "cache"
getLabel()  : string
Module label
getShortInfo()  : string
Displayed directly in the bar
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
getTimeTracker()  : TimeTracker
isEnabledViaTsConfig()  : bool
Returns true if TSConfig "admPanel.enable" is set for this module (or all modules)

Properties

$mainConfiguration

Main Configuration (from UserTSConfig, admPanel)

protected array<string|int, mixed> $mainConfiguration

Methods

getIconIdentifier()

Icon identifier - needs to be registered in iconRegistry

public getIconIdentifier() : string
Return values
string

getIdentifier()

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

public getIdentifier() : string
Return values
string

getLabel()

Module label

public getLabel() : string
Return values
string

getShortInfo()

Displayed directly in the bar

public getShortInfo() : string
Return values
string

hasSubmoduleSettings()

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

public hasSubmoduleSettings() : bool
Return values
bool

injectConfigurationService()

public injectConfigurationService(ConfigurationService $configurationService) : void
Parameters
$configurationService : ConfigurationService
Tags
todo:

See comment in MainController why DI in adminpanel modules that implement DataProviderInterface is a bad idea.

isEnabled()

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

public isEnabled() : bool

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

Return values
bool

setSubModules()

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

public setSubModules(array<string|int, mixed> $subModules) : void
Parameters
$subModules : array<string|int, mixed>

isEnabledViaTsConfig()

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

protected isEnabledViaTsConfig() : bool
Return values
bool 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results