debug-trace

Summary

Generates an XDebug dump which can be traced/analyzed.

Usage

{debug-trace [ id=id ]}
...
{/debug}

Parameters

Name	Type	Description	Required
id	string	The name of the debug file.	No.

Description

This mechanism makes it possible to trace a block of code using "XDebug". The result will be a trace file made by XDebug which can be analyzed. If XDebug is not installed and enabled, this mechanism will not do anything. The "id" parameter can be used to name the trace file. The file extension will be ".xt". The default ID/name is "template-debug". Please note that the trace file will be reset every time a debug-trace is encountered; it is a good idea to have one unique ID per entry.

Examples

Example 1

{debug-trace id='fetch-trace'}
 
{def $nodes=fetch( 'content', 'tree', hash( 'parent_node_id', 2 ) )}
 
{foreach( $nodes as $node )}
    {$node.name|wash()}
{/foreach}
 
{/debug-trace}

This will generate an XDebug trace file called "fetch-trace.xt".