This document is an explaination of some of the variables that can be
used in templates.

Both these variable are safe to use when view caching is on.

1 Pagelayout (or overrides)

The following can be used in pagelayout templates to display the values of these variables:

module_result <br />{$module_result|attribute(show,5)}

designkeys <br />{$DesignKeys:used|attribute(show,5)}

view_parameters <br />{$view_parameters|attribute(show)}

uri_string {$uri_string} <br />

requested_uri_string {$requested_uri_string} <br />

site <br />{$site|attribute(show)}

ezinfo <br /> {$ezinfo|attribute(show)}

1.1 $module_result

The attributes that are available may differ depending on view caching is on. Below the most safe ones to use.

view_parameters (array=Array)

   offset (integer=0)

path (array=Array)

   0 (array=Array)

       text (string=Root folder)

       url (string=/content/view/full/2)

       url_alias (string=)

       node_id (string=2)

   1 (array=Array)

       text (string=Products)

       url (boolean=)

       url_alias (boolean=)

       node_id (string=556)

title_path (array=Array)

   0 (array=Array)

       text (string=Products)

       url (boolean=)

       url_alias (boolean=)

section_id (string=1)

node_id (string=556)

navigation_part (string=ezcontentnavigationpart)

uri (string=/products)

1.1.1 $module_result.content

This attribute holds the content that the module called in the URL generated.

For instance when you run the module content/view/full/2 the module will fetch a template and set the result in module_result under the attribute content.

The template variable {$module_result.content} is usually found in pagelayout.tpl templates and holds the main page content.

1.1.2 $module_result.view_parameters

>offset integer
The view_parameters attribute is an array. I have only seen this
contain the "offset" element. This element is used for paged content.

1.1.3 $module_result.path

>0 array
>>text string 'Root folder'
>>url boolean false
>>url_alias boolean false
>>node_id string 2
This attribute is an array and provides information about the current location within the node tree. It has many uses, such as:

• Generation of Breadcrumbs (see
  http://ez.no/developer/ez_publish_3/documentation/customization/custom_design/examples/creating_a_navigation_path)
• Determining what branch of the node tree you are in ( useful if you have different display logic for different branches )

Element '0' should always be the root node, and the last element will be
the current node.

The attributes of each element are:

• text - Name of the node
• url - URL of the node or false if current node
• url_alias - Nice URL of the node or false if current node
• node_id - The node_id of the node

1.1.4 $module_result.title_path

Like the path array this attribute is also an array. I am not sure the purpose of this attribute and how it differs from the path attribute.

1.1.5 $module_result.section_id

What section does the current node belong to. Not set for some modules, such as search or login.

1.1.6 $module_result.node_id

The node_id of the current node. Not set for some modules.

1.1.7 $module_result.navigation_part

The navigation part assigned to the current node. Associated with the section the current node is assigned to.

1.1.8 $module_result.uri

The URI used to access this node.

1.2 $DesignKeys:used

This variable is set in all(?) modules, however the attributes that are available may differ.

section (string=1)

object (string=564)

node (string=556)

parent_node (string=2)

class (string=1)

view_offset (integer=0)

viewmode (string=full)

depth (string=2)

1.2.1 section

The section ID assigned to the current node.

1.2.2 object

The object ID of the object associated with the current node.

1.2.3 node

The Node ID of the current node

1.2.4 parent_node

The Node Id of the current node's parent.

1.2.5 class

The Class ID of the current node

1.2.6 view_offset

Same as $module_result.view_parameters['offset']

1.2.7 viewmode

The view mode used to display the current node.

1.2.8 depth

The depth of the current node with in the node tree. Should be equal to the number of elements in $module_result.path.

1.3 Get the current user $current_user

First you will need to fetch it

{let current_user=fetch('user','current_user') }

1.3.1 Which is the main group of the current logged in user

....

{let current_user=fetch('user','current_user') }

...

<p> I belong to the group with ID {$current_user.contentobject.main_parent_node_id}</p>

 

{/let}

2 Inside view templates for classes/objects

2.1 The base variable of "everything": $node

Here you basically have one variable to do it all

$node

Don't worry about view caching or not: when cached, the template isn't used anyway.

2.2 Object attributes

Now for fun, put {$node|attribute(show,3)} inside a template for an existing object (and not a production site of course). You will see plenty of nice stuff contained inside $node.

For example

Of particular importance is the data_map array, since the attributes contain the content that you want to display. How to to this is mostly simple, but some special data types have their own stuff:

2.3 More fun stuff

2.3.1 Can the current user edit the current object?

You don't need to fetch the current user into an object for this

<form name="fullview" method="post" action={"content/action"|ezurl}>

{switch match=$node.object.can_edit}

{case match=1}

<input type="hidden" name="ContentObjectID" 

value="{$node.object.id}" />

<input class="button" type="submit" name="EditButton" 

value="{'Edit'|i18n('design/standard/node/view')}" />

{/case}

{case match=0}

{/case}

{/switch}

{/form}

2.3.2 Who is the one that modified the current version?

Use the contentobject_version_object!

{$node.contentobject_version_object.creator.name}

2.3.3 And when did he do that??

last modified: {$node.contentobject_version_object.modified|l10n(shortdatetime)}

2.3.4 Can I email the one that modified it?

Don't be afraid to dig a few levels deeper into $node :-)

<a 

href="mailto:{$node.contentobject_version_object.creator.<remove linebreak>

contentobject_attributes.2.content.email}">

Send Email</a>