TypoScriptWaterfall extends AbstractSubModule implements RequestEnricherInterface, ModuleSettingsProviderInterface

Abstract SubModule - Base class for submodules in the admin panel

Internal
Attributes
#[Autoconfigure]
$public: true

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
ModuleSettingsProviderInterface
Adminpanel module settings interface denotes that a module has own settings.

Properties

$highlightLongerThan  : int
Log entries that take than this number of milliseconds (own time) will be highlighted during log display. Set 0 to disable highlighting.
$printConf  : array<string|int, mixed>

Methods

__construct()  : mixed
enrich()  : ServerRequestInterface
Initialize the module - runs in the TYPO3 middleware stack at an early point may manipulate the current request
getContent()  : string
Creates the content for the "tsdebug" section ("module") of the Admin Panel
getIdentifier()  : string
Identifier for this module, for example "preview" or "cache"
getLabel()  : string
Module label
getSettings()  : string
createHierarchyArray()  : void
Helper function for internal data manipulation
fixCLen()  : string
Wraps the input content string in green colored span-tags IF the length of the input string exceeds $this->printConf['contentLength'] (or $this->printConf['contentLength_FILE'] if $v == "FILE"
fixContent()  : string
Recursively generates the content to display
fw()  : string
Wraps input string in a <span> tag
getBackendUser()  : BackendUserAuthentication
getConfigurationOption()  : bool
getLanguageService()  : LanguageService
printTSlog()  : string
Print TypoScript parsing log
renderTypoScriptLog()  : string
Renders the TypoScript log as string

Properties

$highlightLongerThan

Log entries that take than this number of milliseconds (own time) will be highlighted during log display. Set 0 to disable highlighting.

protected int $highlightLongerThan = 0

$printConf

protected array<string|int, mixed> $printConf = [ 'showParentKeys' => true, 'contentLength' => 10000, // Determines max length of displayed content before it gets cropped. 'contentLength_FILE' => 400, // Determines max length of displayed content FROM FILE cObjects before it gets cropped. Reason is that most FILE cObjects are huge and often used as template-code. 'flag_tree' => true, 'flag_messages' => true, 'flag_content' => false, 'allTime' => false, 'keyLgd' => 40, ]

Methods

enrich()

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

public enrich(ServerRequestInterface $request) : ServerRequestInterface
Parameters
$request : ServerRequestInterface
Return values
ServerRequestInterface

getContent()

Creates the content for the "tsdebug" section ("module") of the Admin Panel

public getContent(ModuleData $data) : string
Parameters
$data : ModuleData
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

getSettings()

public getSettings() : string
Return values
string

createHierarchyArray()

Helper function for internal data manipulation

protected createHierarchyArray(array<string|int, mixed> &$arr, int $pointer, string $uniqueId) : void
Parameters
$arr : array<string|int, mixed>

Array (passed by reference) and modified

$pointer : int

Pointer value

$uniqueId : string

Unique ID string

Tags
see
printTSlog()

fixCLen()

Wraps the input content string in green colored span-tags IF the length of the input string exceeds $this->printConf['contentLength'] (or $this->printConf['contentLength_FILE'] if $v == "FILE"

protected fixCLen(string $c, string $v) : string
Parameters
$c : string

The content string

$v : string

Command: If "FILE" then $this->printConf['contentLength_FILE'] is used for content length comparison, otherwise $this->printConf['contentLength']

Return values
string

fixContent()

Recursively generates the content to display

protected fixContent(array<string|int, mixed> &$tsStackLog, array<string|int, mixed> &$arr, string $content[, string $depthData = '' ][, string $vKey = '' ]) : string
Parameters
$tsStackLog : array<string|int, mixed>
$arr : array<string|int, mixed>

Array which is modified with content. Reference

$content : string

Current content string for the level

$depthData : string = ''

Prefixed icons for new PM icons

$vKey : string = ''

Seems to be the previous tsStackLog key

Return values
string —

Returns the $content string generated/modified. Also the $arr array is modified!

fw()

Wraps input string in a <span> tag

protected fw(string $str) : string
Parameters
$str : string

The string to be wrapped

Return values
string

getConfigurationOption()

protected getConfigurationOption(string $option) : bool
Parameters
$option : string
Return values
bool

printTSlog()

Print TypoScript parsing log

protected printTSlog() : string
Return values
string —

HTML table with the information about parsing times.

renderTypoScriptLog()

Renders the TypoScript log as string

protected renderTypoScriptLog() : string
Return values
string 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results