TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall Class Reference

Inheritance diagram for TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall:

Public Member Functions
	__construct (private readonly ConfigurationService $configurationService, private readonly TimeTracker $timeTracker,)
	getIdentifier ()
	getLabel ()
	enrich (ServerRequestInterface $request)
	getContent (ModuleData $data)
	getSettings ()

Protected Member Functions
	getConfigurationOption (string $option)
	renderTypoScriptLog ()
string	printTSlog ()
string	fixContent (array &$tsStackLog, array &$arr, string $content, string $depthData='', string $vKey='')
	fixCLen (string $c, string $v)
	fw (string $str)
	createHierarchyArray (array &$arr, int $pointer, string $uniqueId)
‪Protected Member Functions inherited from ‪TYPO3\CMS\Adminpanel\ModuleApi\AbstractSubModule
	getLanguageService ()
	getBackendUser ()

Protected Attributes
array	$printConf
int	$highlightLongerThan = 0

Detailed Description

Class TypoScriptWaterfall

Definition at line 37 of file TypoScriptWaterfall.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall::__construct	(	private readonly ConfigurationService	$configurationService,
		private readonly TimeTracker	$timeTracker
	)

Definition at line 58 of file TypoScriptWaterfall.php.

Member Function Documentation

createHierarchyArray()

TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall::createHierarchyArray ( array &  $arr, int  $pointer, string  $uniqueId  )

protected

Helper function for internal data manipulation

Parameters

array	$arr	‪Array (passed by reference) and modified
int	$pointer	‪Pointer value
string	$uniqueId	‪Unique ID string

See also

‪printTSlog()

Definition at line 395 of file TypoScriptWaterfall.php.

Referenced by TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\printTSlog().

enrich()

TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall::enrich

(

ServerRequestInterface

$request

)

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

Implements TYPO3\CMS\Adminpanel\ModuleApi\RequestEnricherInterface.

Definition at line 75 of file TypoScriptWaterfall.php.

References TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\getConfigurationOption().

fixCLen()

TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall::fixCLen ( string  $c, string  $v  )

protected

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"

Parameters

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

Definition at line 366 of file TypoScriptWaterfall.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\fixed_lgd_cs().

Referenced by TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\fixContent().

fixContent()

string TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall::fixContent ( array &  $tsStackLog, array &  $arr, string  $content, string  $depthData = '', string  $vKey = ''  )

protected

Recursively generates the content to display

Parameters

array	$arr	‪Array which is modified with content. Reference
string	$content	‪Current content string for the level
string	$depthData	‪Prefixed icons for new PM icons
string	$vKey	‪Seems to be the previous tsStackLog key

Returns

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

Definition at line 300 of file TypoScriptWaterfall.php.

References TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), and TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\fixCLen().

Referenced by TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\printTSlog().

fw()

TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall::fw ( string  $str )

protected

Wraps input string in a tag

Parameters

string

$str

‪The string to be wrapped

Definition at line 382 of file TypoScriptWaterfall.php.

Referenced by TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\printTSlog().

getConfigurationOption()

TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall::getConfigurationOption ( string  $option )

protected

Definition at line 138 of file TypoScriptWaterfall.php.

Referenced by TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\enrich(), TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\getContent(), TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\getSettings(), and TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\renderTypoScriptLog().

getContent()

TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall::getContent

(

ModuleData

$data

)

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

Implements TYPO3\CMS\Adminpanel\ModuleApi\ContentProviderInterface.

Definition at line 89 of file TypoScriptWaterfall.php.

References TYPO3\CMS\Adminpanel\ModuleApi\AbstractSubModule\getBackendUser(), TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\getConfigurationOption(), and TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\renderTypoScriptLog().

getIdentifier()

TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall::getIdentifier

(

)

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

Implements TYPO3\CMS\Adminpanel\ModuleApi\ModuleInterface.

Definition at line 63 of file TypoScriptWaterfall.php.

getLabel()

TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall::getLabel

(

)

Module label

Implements TYPO3\CMS\Adminpanel\ModuleApi\ModuleInterface.

Definition at line 68 of file TypoScriptWaterfall.php.

References TYPO3\CMS\Adminpanel\ModuleApi\AbstractSubModule\getLanguageService().

getSettings()

TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall::getSettings

(

)

Implements TYPO3\CMS\Adminpanel\ModuleApi\ModuleSettingsProviderInterface.

Definition at line 114 of file TypoScriptWaterfall.php.

References TYPO3\CMS\Adminpanel\ModuleApi\AbstractSubModule\getBackendUser(), and TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\getConfigurationOption().

printTSlog()

string TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall::printTSlog ( )

protected

Print TypoScript parsing log

Returns

‪string HTML table with the information about parsing times.

Definition at line 166 of file TypoScriptWaterfall.php.

References TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\$highlightLongerThan, TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\createHierarchyArray(), TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\fixContent(), TYPO3\CMS\Core\Utility\GeneralUtility\fixed_lgd_cs(), TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\fw(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\renderTypoScriptLog().

renderTypoScriptLog()

TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall::renderTypoScriptLog ( )

protected

Renders the TypoScript log as string

Definition at line 146 of file TypoScriptWaterfall.php.

References TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\getConfigurationOption(), and TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\printTSlog().

Referenced by TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\getContent().

Member Data Documentation

$highlightLongerThan

int TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall::$highlightLongerThan = 0

protected

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

Definition at line 56 of file TypoScriptWaterfall.php.

Referenced by TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall\printTSlog().

$printConf

array TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall::$printConf

protected

Initial value:

= [
        'showParentKeys' => true,
        'contentLength' => 10000,
        
        'contentLength_FILE' => 400,
        
        'flag_tree' => true,
        'flag_messages' => true,
        'flag_content' => false,
        'allTime' => false,
        'keyLgd' => 40,
    ]

Definition at line 39 of file TypoScriptWaterfall.php.