Skip to the content
Documentation
Version 6.x Supported

Template functions

Written by Balazs Halasy, Updated by Graham Brookins
No ratings yet

Exponential 6 in this section

The template functions are those of 4.x. The pages added here describe functions the kernel registers that the 4.x reference did not describe; they are older than Exponential 6.

Debugging

Function Summary
debug-accumulator Generates debug statistics for a block of template code.
debug-log Generates a debug log entry for the specified variables.
debug-timing-point Measures the time it takes to process a block of template code.
debug-trace Generates an XDebug dump which can be traced/analyzed.

Miscellaneous

Function Summary
cache-block Caches the contents of a template block to static content for fast retrieval. Useful to avoid fetching content over and over from database when it is possible to cache it within a set of parameters. Note: cache-blocks also introduces some overhead, so do not have too many of them on a page, let them span parts of your page like e.g. header, footer and left menu.
fetch_alias Executes a fetch based on configuration settings.
include Includes a file.
ldelim Outputs a left curly bracket, "{".
literal Instructs the parser to ignore a block of template code.
rdelim Outputs a right curly bracket, "}".
run-once Assures that a block of template code is run only once within a page view.

Variables

Function Summary
append-block Redirects the output from multiple blocks of template code to an array.
def Declares (and defines) a variable. Warns if the variable already exists.
default Deprecated.
let Deprecated.
sequence Creates a sequence that can be iterated.
set Sets the value of a variable.
set-block Redirects the output from a block of template code to a string.
undef Destroys previously defined variable(s).

Visualization

Function Summary
attribute_edit_gui Outputs the edit template for a content object attribute.
attribute_pdf_gui Outputs the PDF template for a content object attribute (DEPRECATED).
attribute_result_gui Outputs the result template for a content object attribute.
attribute_view_gui Outputs the view template for a content object attribute.
class_attribute_edit_gui Outputs the edit template for a content class attribute.
class_attribute_view_gui Outputs the view template for a content class attribute.
collaboration_icon Outputs the icon for a collaboration item.
collaboration_participation_view Outputs information about a collaboration participant.
collaboration_simple_message_view Outputs the view template for a collaboration message.
collaboration_view_gui Outputs the template for a collaboration item.
content_pdf_gui Outputs the PDF template for a content object (DEPRECATED).
content_version_view_gui Outputs a view template for a content object version.
content_view_gui Outputs a view template for a content object.
event_edit_gui Outputs the edit template for a workflow event.
node_view_gui Outputs the view template for a node.
related_view_gui Not documented yet.
shop_account_view_gui Outputs the view template for a specified order.
tool_bar Outputs the template for a toolbar.

Older than Exponential 6, first described here

These existed before Exponential 6 (or come from an extension, as the Since column says); the 4.x reference had no page for them.

Name Description Since
attribute_diff_gui A template function set up by eZObjectForwardInit in kernel/common/eztemplateautoload.php: it includes the template that matches the given object (as attribute_view_gui ... older than 6.0
event_view_gui A template function set up by eZObjectForwardInit in kernel/common/eztemplateautoload.php: it includes the template that matches the given object (as attribute_view_gui ... older than 6.0
menu A template function of the kernel. older than 6.0

Added for Exponential 6.0.15 and the earlier 6.0.x releases.

In this section

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.