set-block

Written by Balazs Halasy, 02/06/2004 Updated 10/08/2008 by Graham Brookins Maintainers: Balazs Halasy, Svitlana Shatokhina

Summary

Redirects the output from a block of template code to a string.

Usage

{set-block variable=$variable [ name=name ] [ scope=scope ]}
...
{/set-block}

Parameters

Name	Type	Description	Required
variable	string	The name of the variable (with dollar sign).	Yes.
name	string	The name of the target namespace.	No.
scope	string	The scope ("global", "root" or "relative").	No.

Description

This mechanism will silently process all template code which is encapsulated by "{set-block ...}" and "{/set-block}". It will not produce any actual output. Instead, the generated output will be assigned to a variable specified by the "variable" parameter (as a string). If the variable does not exist, it will be automatically created. If the same target variable is used in several blocks, its contents will be overwritten every time a new block is processed.

Examples

Example 1

{set-block variable=$example}
    {def $test=array( 'x', 'y', 'z' )}
    Hello world - {$test[1]}
{/set-block}
...
{$example}

The code which is encapsulated by "set-block" will not produce any output. Instead, the output will be put into a string called $example. When this variable is accessed directly, the following output will be produced: "Hello world - y".

Example 2

{set-block scope=global variable=cache_ttl}0{/set-block}

This will put zero into the "cache_ttl" global variable and thus disable view caching for this page.

Contributors

Balazs Halasy Author 02/06/2004 Maintainer
Svitlana Shatokhina Maintainer
vytis Commenter 07/19/2006
Norman Leutner Commenter 11/17/2006
André Rømcke

Comments (3 historical)

Written by readers of the earlier documentation sites, kept as they were.

include doesn't work insade set-block

vytis · 07/19/2006 10:33 am

include doesn't work insade set-block
Using set block within in information collection templates

Norman Leutner · 11/17/2006 10:17 am

/content/collectedinfomail/form.tpl will acces the following variables:
{set-block scope=root variable=email_receiver}[email protected]{/set-block}
{set-block scope=root variable=subject}Subject{/set-block}
{set-block scope=root variable=email_sender}[email protected]{/set-block}
{set-block scope=root variable=redirect_to_node_id}2{/set-block}
Notice: The sender and receiver mailadress have to be different, otherwise receiver variable will not be set!
View cache example should use scope=global

André R. · 05/11/2008 01:19 pm
Since scope isn't that used anymore (since the template language changed in 3.6), the example should use scope=global to avoid people having troubles with it when the try to use it in a included template.
So:
```
{set-block scope=global variable=cache_ttl}0{/set-block}
```

Comments

Add a comment