eZ Publish  [trunk]
Public Member Functions | Public Attributes
eZTemplateDebugFunction Class Reference
Template functions

Advanced debug handling. More...

List of all members.

Public Member Functions

 attributeList ()
 eZTemplateDebugFunction ($timingPoint= 'debug-timing-point', $accumulator= 'debug-accumulator', $log= 'debug-log', $trace= 'debug-trace')
 functionList ()
 functionTemplateHints ()
 hasChildren ()
 process ($tpl, &$textElements, $functionName, $functionChildren, $functionParameters, $functionPlacement, $rootNamespace, $currentNamespace)
 templateNodeTransformation ($functionName, &$node, $tpl, $parameters, $privateData)

Public Attributes

 $AppendDebugName
 $DebugName
 Name of the function.
 $OnceName

Detailed Description

Advanced debug handling.

debug-timing-point Starts a timing point, executes body and ends the timing point. This is useful if you want to figure out how fast a piece of template code goes or to see all debug entries that occur between these two points.

  {debug-timing-point id=""}
  {$item} - {$item2}
  {/debug-timing-point}

debug-accumulator Executes the body and performs statistics. The number of calls, total time and average time will be shown in debug.

  {debug-accumulator}
  {section var=error loop=$errors}{$error}{/section}
  {/debug-accumulator}

debug-log Does exactly the same as eZDebug::writeDebug() method. Has two parameters:

  • var: variable to dump
  • msg: text message
  {debug-log var=$object msg='object contents'}
  {debug-log msg='hello world'}
  {debug-log var=array(1,2,3)}

debug-trace Executes the body while tracing the result using XDebug. The result will a trace file made by XDebug which can be analyzed. Note: This will not do anything when XDebug is not available

  {debug-trace id="loop"}
  {section var=error loop=$errors}{$error}{/section}
  {/debug-trace}

Definition at line 62 of file eztemplatedebugfunction.php.

Member Function Documentation

eZTemplateDebugFunction::attributeList ( )

Returns the attribute list. key: parameter name value: can have children

Definition at line 91 of file eztemplatedebugfunction.php.

Referenced by hasChildren().

eZTemplateDebugFunction::eZTemplateDebugFunction ( $  timingPoint = 'debug-timing-point',
$  accumulator = 'debug-accumulator',
$  log = 'debug-log',
$  trace = 'debug-trace' 
)

Initializes the object with names.

Definition at line 67 of file eztemplatedebugfunction.php.

eZTemplateDebugFunction::functionList ( )

Return the list of available functions.

Definition at line 81 of file eztemplatedebugfunction.php.

eZTemplateDebugFunction::functionTemplateHints ( )

Definition at line 101 of file eztemplatedebugfunction.php.

eZTemplateDebugFunction::hasChildren ( )

Returns true.

Definition at line 409 of file eztemplatedebugfunction.php.

eZTemplateDebugFunction::process ( $  tpl,
&$  textElements,
$  functionName,
$  functionChildren,
$  functionParameters,
$  functionPlacement,
$  rootNamespace,
$  currentNamespace 
)

Processes the function with all it's children.

Definition at line 270 of file eztemplatedebugfunction.php.

eZTemplateDebugFunction::templateNodeTransformation ( $  functionName,
&$  node,
$  tpl,
$  parameters,
$  privateData 
)

Definition at line 125 of file eztemplatedebugfunction.php.

Member Data Documentation

eZTemplateDebugFunction::$AppendDebugName

Definition at line 417 of file eztemplatedebugfunction.php.

eZTemplateDebugFunction::$DebugName

Name of the function.

Definition at line 416 of file eztemplatedebugfunction.php.

eZTemplateDebugFunction::$OnceName

Definition at line 418 of file eztemplatedebugfunction.php.

The documentation for this class was generated from the following file: