Custom Template Operators

Next topic

Author	Message
Jough Dempsey	Tuesday 04 December 2007 1:24:34 pm I used the RAD tool in the admin to generate a stub for a custom template operator, but now I'm unsure as to what needs to change, or how this class is used by eZ publish to return a value(s). I imagine that the methods included in the stub file are required, but they're also (as far as I can tell) completely undocumented. The namedParameterList() seems the most obvious, but are there any other parameters of the modify() method that I need to worry about? Can anyone point me to custom template operator documentation (on ez.no or elsewhere). I found this wiki page: http://ezpedia.org/wiki/en/ez/template_operators but it also doesn't say where to place the template operator file, where or how to include it (unless you're using the autoload), or how it all works. Jough Dempsey Senior Developer D U O : C O N S U L T I N G Web Content Management Experts http://www.duoconsulting.com
Paul Leclercq	Tuesday 04 December 2007 3:05:34 pm Hiya Jough, Try this page: http://ez.no/fr/ezpublish/documentation/development/extensions/template_operator It is a good simple exemple for hello world. Basically, an operator is a function which can be used in your template: You will find a list of the pre-built operators here: http://ez.no/doc/ez_publish/technical_manual/3_10/reference/template_operators To use your operator in the template once created you simply need to do something like: {def $my_variable = my_operator('my_parameter1', 'my_parameter2')} You can then display you result like this: {$my_variable} or {$my_variable\|attribute(show)} if you are returning an array As explained in the above hello world exemple: you will need to create your operator in the /extension folder you will need to tell the system that you have an operator in the extension/myextension/settings/site.ini.append And place your extension in the folder: extension/myextension/autoloads Once you have created your extension don't forget to activate it by going to the administration interface -> setup -> extensions -> tick and activate -> clear cache Let us know how you get on!
Jough Dempsey	Monday 10 December 2007 1:38:48 pm Thank you for your reply, Paul. It helped a lot, although I found that I could do the simple search that I needed to with the built-in fetch template functions (after a fashion). Jough Dempsey Senior Developer D U O : C O N S U L T I N G Web Content Management Experts http://www.duoconsulting.com

Author

Message

Tuesday 04 December 2007 1:24:34 pm

I used the RAD tool in the admin to generate a stub for a custom template operator, but now I'm unsure as to what needs to change, or how this class is used by eZ publish to return a value(s).

I imagine that the methods included in the stub file are required, but they're also (as far as I can tell) completely undocumented. The namedParameterList() seems the most obvious, but are there any other parameters of the modify() method that I need to worry about?

Can anyone point me to custom template operator documentation (on ez.no or elsewhere).

I found this wiki page: http://ezpedia.org/wiki/en/ez/template_operators

but it also doesn't say where to place the template operator file, where or how to include it (unless you're using the autoload), or how it all works.

Jough Dempsey
Senior Developer
D U O : C O N S U L T I N G
Web Content Management Experts
http://www.duoconsulting.com

Paul Leclercq

Tuesday 04 December 2007 3:05:34 pm

Hiya Jough,

Try this page:
http://ez.no/fr/ezpublish/documentation/development/extensions/template_operator

It is a good simple exemple for hello world.

Basically, an operator is a function which can be used in your template:

You will find a list of the pre-built operators here:
http://ez.no/doc/ez_publish/technical_manual/3_10/reference/template_operators

To use your operator in the template once created you simply need to do something like:
{def $my_variable = my_operator('my_parameter1', 'my_parameter2')}

You can then display you result
like this:
{$my_variable} or {$my_variable|attribute(show)} if you are returning an array

As explained in the above hello world exemple: you will need to create your operator in the
/extension folder
you will need to tell the system that you have an operator in the
extension/myextension/settings/site.ini.append

And place your extension in the folder:
extension/myextension/autoloads

Once you have created your extension don't forget to activate it by going to the administration interface -> setup -> extensions -> tick and activate -> clear cache

Let us know how you get on!

Jough Dempsey

Monday 10 December 2007 1:38:48 pm

Thank you for your reply, Paul. It helped a lot, although I found that I could do the simple search that I needed to with the built-in fetch template functions (after a fashion).

Jough Dempsey
Senior Developer
D U O : C O N S U L T I N G
Web Content Management Experts
http://www.duoconsulting.com

eZ debug

Timing:	Jan 18 2025 19:09:33
Script start
Timing:	Jan 18 2025 19:09:33
Module start 'layout'
Timing:	Jan 18 2025 19:09:33
Module start 'content'
Timing:	Jan 18 2025 19:09:34
Module end 'content'
Timing:	Jan 18 2025 19:09:34
Script end

Main resources:

Total runtime	1.1199 sec
Peak memory usage	4,096.0000 KB
Database Queries	57

Timing points:

Checkpoint	Start (sec)	Duration (sec)	Memory at start (KB)	Memory used (KB)
Script start	0.0000	0.0043	587.9141	152.6250
Module start 'layout'	0.0043	0.0021	740.5391	39.4453
Module start 'content'	0.0063	1.1119	779.9844	537.9609
Module end 'content'	1.1183	0.0016	1,317.9453	12.1641
Script end	1.1199		1,330.1094

Time accumulators:

Accumulator	Duration (sec)	Duration (%)	Count	Average (sec)
Ini load
Load cache	0.0036	0.3208	16	0.0002
Check MTime	0.0014	0.1292	16	0.0001
Mysql Total
Database connection	0.0005	0.0428	1	0.0005
Mysqli_queries	1.0657	95.1565	57	0.0187
Looping result	0.0006	0.0575	55	0.0000
Template Total	1.0890	97.2	2	0.5445
Template load	0.0018	0.1614	2	0.0009
Template processing	1.0872	97.0735	2	0.5436
Template load and register function	0.0002	0.0170	1	0.0002
states
state_id_array	0.0014	0.1256	1	0.0014
state_identifier_array	0.0024	0.2176	2	0.0012
Override
Cache load	0.0015	0.1326	32	0.0000
Sytem overhead
Fetch class attribute can translate value	0.0008	0.0737	2	0.0004
Fetch class attribute name	0.0013	0.1143	4	0.0003
XML
Image XML parsing	0.0022	0.1972	2	0.0011
class_abstraction
Instantiating content class attribute	0.0000	0.0007	4	0.0000
General
dbfile	0.0023	0.2019	15	0.0002
String conversion	0.0000	0.0006	4	0.0000
Note: percentages do not add up to 100% because some accumulators overlap

Templates used to render the page:

Usage	Requested template	Template	Template loaded
1	node/view/full.tpl	full/forum_topic.tpl	extension/sevenx/design/simple/override/templates/full/forum_topic.tpl
3	content/datatype/view/ezxmltext.tpl	<No override>	extension/community_design/design/suncana/templates/content/datatype/view/ezxmltext.tpl
9	content/datatype/view/ezxmltags/paragraph.tpl	<No override>	extension/ezwebin/design/ezwebin/templates/content/datatype/view/ezxmltags/paragraph.tpl
1	content/datatype/view/ezimage.tpl	<No override>	extension/sevenx/design/simple/templates/content/datatype/view/ezimage.tpl
6	content/datatype/view/ezxmltags/line.tpl	<No override>	design/standard/templates/content/datatype/view/ezxmltags/line.tpl
1	print_pagelayout.tpl	<No override>	extension/community/design/community/templates/print_pagelayout.tpl
Number of times templates used: 21 Number of unique templates used: 6

Time used to render debug report: 0.0002 secs