TYPO3 CMS  TYPO3_7-6
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
TYPO3\CMS\Core\TimeTracker\TimeTracker Class Reference

Public Member Functions

 start ()
 
 push ($tslabel, $value='')
 
 pull ($content='')
 
 setTSlogMessage ($content, $num=0)
 
 setTSselectQuery (array $data, $msg='')
 
 incStackPointer ()
 
 decStackPointer ()
 
 getMilliseconds ($microtime=null)
 
 getDifferenceToStarttime ($microtime=null)
 
 printTSlog ()
 

Public Attributes

 $starttime = 0
 
 $LR = 1
 
 $printConf
 
 $wrapError = []
 
 $wrapIcon = []
 
 $uniqueCounter = 0
 
 $tsStack = [[]]
 
 $tsStackLevel = 0
 
 $tsStackLevelMax = []
 
 $tsStackLog = []
 
 $tsStackPointer = 0
 
 $currentHashPointer = []
 
 $highlightLongerThan = 0
 

Protected Member Functions

 fixContent (&$arr, $content, $depthData='', $first=0, $vKey='')
 
 fixCLen ($c, $v)
 
 fw ($str)
 
 createHierarchyArray (&$arr, $pointer, $uniqueId)
 

Detailed Description

Frontend Timetracking functions

Is used to register how much time is used with operations in TypoScript

Definition at line 25 of file TimeTracker.php.

Member Function Documentation

◆ createHierarchyArray()

TYPO3\CMS\Core\TimeTracker\TimeTracker::createHierarchyArray ( &  $arr,
  $pointer,
  $uniqueId 
)
protected

Helper function for internal data manipulation

Parameters
array$arrArray (passed by reference) and modified
int$pointerPointer value
string$uniqueIdUnique ID string
Returns
void private
See also
printTSlog()

Definition at line 508 of file TimeTracker.php.

Referenced by TYPO3\CMS\Core\TimeTracker\TimeTracker\printTSlog().

◆ decStackPointer()

TYPO3\CMS\Core\TimeTracker\TimeTracker::decStackPointer ( )

Decreases the stack pointer

Returns
void
See also
incStackPointer(), ::renderContent(), ::cObjGetSingle()

Definition at line 236 of file TimeTracker.php.

◆ fixCLen()

TYPO3\CMS\Core\TimeTracker\TimeTracker::fixCLen (   $c,
  $v 
)
protected

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

Parameters
string$cThe content string
string$vCommand: If "FILE" then $this->printConf['contentLength_FILE'] is used for content length comparison, otherwise $this->printConf['contentLength']
Returns
string

Definition at line 476 of file TimeTracker.php.

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

Referenced by TYPO3\CMS\Core\TimeTracker\TimeTracker\fixContent().

◆ fixContent()

TYPO3\CMS\Core\TimeTracker\TimeTracker::fixContent ( &  $arr,
  $content,
  $depthData = '',
  $first = 0,
  $vKey = '' 
)
protected

Recursively generates the content to display

Parameters
array$arrArray which is modified with content. Reference
string$contentCurrent content string for the level
string$depthDataPrefixed icons for new PM icons
bool$firstSet this for the first call from outside.
string$vKeySeems to be the previous tsStackLog key
Returns
string Returns the $content string generated/modified. Also the $arr array is modified!

Definition at line 416 of file TimeTracker.php.

References TYPO3\CMS\Core\TimeTracker\TimeTracker\fixCLen().

Referenced by TYPO3\CMS\Core\TimeTracker\TimeTracker\printTSlog().

◆ fw()

TYPO3\CMS\Core\TimeTracker\TimeTracker::fw (   $str)
protected

Wraps input string in a tag

Parameters
string$strThe string to be wrapped
Returns
string

Definition at line 493 of file TimeTracker.php.

Referenced by TYPO3\CMS\Core\TimeTracker\TimeTracker\printTSlog().

◆ getDifferenceToStarttime()

TYPO3\CMS\Core\TimeTracker\TimeTracker::getDifferenceToStarttime (   $microtime = null)

Gets the difference between a given microtime value and the starting time as milliseconds.

Parameters
float$microtimeThe microtime value - if not set the current time is used
Returns
int The difference between a given microtime value and starting time as milliseconds

Definition at line 262 of file TimeTracker.php.

References TYPO3\CMS\Core\TimeTracker\TimeTracker\$starttime, and TYPO3\CMS\Core\TimeTracker\TimeTracker\getMilliseconds().

Referenced by TYPO3\CMS\Core\TimeTracker\TimeTracker\printTSlog().

◆ getMilliseconds()

TYPO3\CMS\Core\TimeTracker\TimeTracker::getMilliseconds (   $microtime = null)

Gets a microtime value as milliseconds value.

Parameters
float$microtimeThe microtime value - if not set the current time is used
Returns
int The microtime value as milliseconds value

Definition at line 248 of file TimeTracker.php.

Referenced by TYPO3\CMS\Core\TimeTracker\TimeTracker\getDifferenceToStarttime(), and TYPO3\CMS\Core\TimeTracker\TimeTracker\start().

◆ incStackPointer()

TYPO3\CMS\Core\TimeTracker\TimeTracker::incStackPointer ( )

Increases the stack pointer

Returns
void
See also
decStackPointer(), ::renderContent(), ::cObjGetSingle()

Definition at line 224 of file TimeTracker.php.

References TYPO3\CMS\Core\TimeTracker\TimeTracker\$tsStackPointer.

◆ printTSlog()

TYPO3\CMS\Core\TimeTracker\TimeTracker::printTSlog ( )

Print TypoScript parsing log

Returns
string HTML table with the information about parsing times.

Definition at line 277 of file TimeTracker.php.

References TYPO3\CMS\Core\TimeTracker\TimeTracker\createHierarchyArray(), TYPO3\CMS\Core\TimeTracker\TimeTracker\fixContent(), TYPO3\CMS\Core\Utility\GeneralUtility\fixed_lgd_cs(), TYPO3\CMS\Core\TimeTracker\TimeTracker\fw(), TYPO3\CMS\Core\TimeTracker\TimeTracker\getDifferenceToStarttime(), TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), and TYPO3\CMS\Core\Utility\DebugUtility\viewArray().

◆ pull()

TYPO3\CMS\Core\TimeTracker\TimeTracker::pull (   $content = '')

Pulls an element from the TypoScript tracking array

Parameters
string$contentThe content string generated within the push/pull part.
Returns
void
See also
::cObjGetSingle(), push()

Definition at line 171 of file TimeTracker.php.

◆ push()

TYPO3\CMS\Core\TimeTracker\TimeTracker::push (   $tslabel,
  $value = '' 
)

Pushes an element to the TypoScript tracking array

Parameters
string$tslabelLabel string for the entry, eg. TypoScript property name
string$valueAdditional value(?)
Returns
void
See also
::cObjGetSingle(), pull()

Definition at line 147 of file TimeTracker.php.

References TYPO3\CMS\Core\TimeTracker\TimeTracker\$tsStack, TYPO3\CMS\Core\TimeTracker\TimeTracker\$tsStackLevel, and TYPO3\CMS\Core\TimeTracker\TimeTracker\$tsStackPointer.

◆ setTSlogMessage()

TYPO3\CMS\Core\TimeTracker\TimeTracker::setTSlogMessage (   $content,
  $num = 0 
)

Logs the TypoScript entry

Parameters
string$contentThe message string
int$numMessage type: 0: information, 1: message, 2: warning, 3: error
Returns
void
See also
::CONTENT()

Definition at line 189 of file TimeTracker.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

◆ setTSselectQuery()

TYPO3\CMS\Core\TimeTracker\TimeTracker::setTSselectQuery ( array  $data,
  $msg = '' 
)

Set TSselectQuery - for messages in TypoScript debugger.

Parameters
array$dataQuery array
string$msgMessage/Label to attach
Returns
void

Definition at line 208 of file TimeTracker.php.

◆ start()

TYPO3\CMS\Core\TimeTracker\TimeTracker::start ( )

Constructor Sets the starting time

Returns
void

Definition at line 122 of file TimeTracker.php.

References TYPO3\CMS\Core\TimeTracker\TimeTracker\getMilliseconds().

Member Data Documentation

◆ $currentHashPointer

TYPO3\CMS\Core\TimeTracker\TimeTracker::$currentHashPointer = []

Definition at line 102 of file TimeTracker.php.

◆ $highlightLongerThan

TYPO3\CMS\Core\TimeTracker\TimeTracker::$highlightLongerThan = 0

Definition at line 109 of file TimeTracker.php.

◆ $LR

TYPO3\CMS\Core\TimeTracker\TimeTracker::$LR = 1

Definition at line 40 of file TimeTracker.php.

◆ $printConf

TYPO3\CMS\Core\TimeTracker\TimeTracker::$printConf
Initial value:
= [
'showParentKeys' => 1

Definition at line 45 of file TimeTracker.php.

◆ $starttime

TYPO3\CMS\Core\TimeTracker\TimeTracker::$starttime = 0

Definition at line 32 of file TimeTracker.php.

Referenced by TYPO3\CMS\Core\TimeTracker\TimeTracker\getDifferenceToStarttime().

◆ $tsStack

TYPO3\CMS\Core\TimeTracker\TimeTracker::$tsStack = [[]]

Definition at line 77 of file TimeTracker.php.

Referenced by TYPO3\CMS\Core\TimeTracker\TimeTracker\push().

◆ $tsStackLevel

TYPO3\CMS\Core\TimeTracker\TimeTracker::$tsStackLevel = 0

Definition at line 82 of file TimeTracker.php.

Referenced by TYPO3\CMS\Core\TimeTracker\TimeTracker\push().

◆ $tsStackLevelMax

TYPO3\CMS\Core\TimeTracker\TimeTracker::$tsStackLevelMax = []

Definition at line 87 of file TimeTracker.php.

◆ $tsStackLog

TYPO3\CMS\Core\TimeTracker\TimeTracker::$tsStackLog = []

Definition at line 92 of file TimeTracker.php.

◆ $tsStackPointer

TYPO3\CMS\Core\TimeTracker\TimeTracker::$tsStackPointer = 0

Definition at line 97 of file TimeTracker.php.

Referenced by TYPO3\CMS\Core\TimeTracker\TimeTracker\incStackPointer(), and TYPO3\CMS\Core\TimeTracker\TimeTracker\push().

◆ $uniqueCounter

TYPO3\CMS\Core\TimeTracker\TimeTracker::$uniqueCounter = 0

Definition at line 72 of file TimeTracker.php.

◆ $wrapError

TYPO3\CMS\Core\TimeTracker\TimeTracker::$wrapError = []

Definition at line 62 of file TimeTracker.php.

◆ $wrapIcon

TYPO3\CMS\Core\TimeTracker\TimeTracker::$wrapIcon = []

Definition at line 67 of file TimeTracker.php.