Template Debug

Author Message

Jean-Marc Cogniard

Monday 19 July 2010 4:22:36 am

Hi,

I'm new to eZ and would like to know how to debug template : trace, breakpoint ...

(My site is running under 4.1.3)

Thanks for your help.

Yannick Komotir

Monday 19 July 2010 4:49:26 am

Hi,

You can look at http://ez.no/doc/ez_publish/technical_manual/4_x/reference/template_functions/debugging

<|- Software Engineer @ eZ Publish developpers -|>
@ http://twitter.com/yannixk

Kévin S.

Tuesday 20 July 2010 12:39:47 am

Bonjour Jean-Marc.

You can show template debug very easily : in the site.ini.append.php of your siteaccess (located in eZPublishRoot/settings/siteaccess/[your siteaccess]/) you just have to add :

[DebugSettings]
DebugOutput=enabled

[TemplateSettings]
Debug=enabled
ShowUsedTemplates=enabled

You can also do it from the front-office editing interface, which you can access using the "login" page, without checking the checkbox "go in administration interface". Then you can choose which debug you want to display or to hide.

Brandon Chambers

Wednesday 21 July 2010 10:30:29 am

If you're having trouble with an object or node you can examine the structure of the node or object by using template code:

{$node|attribute('show',1)}

or

{$node.data_map|attribute('show',1)}

The second parameter in the attribute operator will allow you to control the depth of the debug output. I have them set as a level of 1. You can try 2 or 3 (keep in mind the page will look huge and is less readable) but I suggest no more than 2 levels if necessary.

Brandon Chambers
brandon@granitehorizon.com
blog: http://blog.divdesigns.com
Granite Horizon / http://granitehorizon.com

Nicolas Pastorino

Wednesday 21 July 2010 1:53:11 pm

Another useful, undocumented one is :

{debug-log var=$myVar msg='var dumping $myVar'}

It will show in the debug output (which needs to be enabled, see Kévin's post above about this) your template variable, like a var_dump() in PHP, under a section called 'var dumping $myVar'.

Hope this helps !
Cheers,

--
Nicolas Pastorino
Director Community - eZ
Member of the Community Project Board

eZ Publish Community on twitter: http://twitter.com/ezcommunity

t : http://twitter.com/jeanvoye
G+ : http://plus.tl/jeanvoye

Gaetano Giunta

Thursday 22 July 2010 3:17:12 am

You can also use the ezdebug extension (http://projects.ez.no/ezdebug_template_operator) to get a few useful debugging operators

Principal Consultant International Business
Member of the Community Project Board

Powered by eZ Publish™ CMS Open Source Web Content Management. Copyright © 1999-2014 eZ Systems AS (except where otherwise noted). All rights reserved.

eZ debug

Timing: Jan 18 2025 10:29:33
Script start
Timing: Jan 18 2025 10:29:33
Module start 'layout'
Timing: Jan 18 2025 10:29:33
Module start 'content'
Timing: Jan 18 2025 10:29:33
Module end 'content'
Timing: Jan 18 2025 10:29:33
Script end

Main resources:

Total runtime0.0170 sec
Peak memory usage2,048.0000 KB
Database Queries3

Timing points:

CheckpointStart (sec)Duration (sec)Memory at start (KB)Memory used (KB)
Script start 0.00000.0058 587.7891152.6094
Module start 'layout' 0.00580.0036 740.398439.4063
Module start 'content' 0.00940.0053 779.804793.4063
Module end 'content' 0.01470.0023 873.210938.3047
Script end 0.0170  911.5156 

Time accumulators:

 Accumulator Duration (sec) Duration (%) Count Average (sec)
Ini load
Load cache0.002715.8941140.0002
Check MTime0.00137.3416140.0001
Mysql Total
Database connection0.00095.061010.0009
Mysqli_queries0.003017.586730.0010
Looping result0.00000.152610.0000
Template Total0.001911.410.0019
Template load0.00116.512810.0011
Template processing0.00084.856610.0008
Override
Cache load0.00074.281210.0007
General
dbfile0.00105.754080.0001
String conversion0.00000.065840.0000
Note: percentages do not add up to 100% because some accumulators overlap

Templates used to render the page:

UsageRequested templateTemplateTemplate loadedEditOverride
1print_pagelayout.tpl<No override>extension/community/design/community/templates/print_pagelayout.tplEdit templateOverride template
 Number of times templates used: 1
 Number of unique templates used: 1

Time used to render debug report: 0.0001 secs