SUIT Framework - Docs

Docs - loop

06/06/2010: SUIT 2.0.0 and Rulebox 1.0.0 released.

Available Since: Rulebox (1.0.0)

Loop a string with different variables.

Syntax [loop ( key="str" value="str" iterable="str" join="str" )]string[/loop]

string

The string to be walked through multiple times with a different key and value combination.

key

The name of the variable to store the key for each iteration. (Default: null. Will not be stored.)

value

The name of the variable to store the value for each iteration. (Default: null. Will not be stored.)

iterable

The name of the variable containing the iterable to use. (Default: null. The string will collapse.)

join

The string to join the results with. (Default: '')

delimiter

The string that separates the levels of the iterable variable. (Default: ".")

owner

The object to grab the iterable variable from. (Default: templating.var)

Output

The combined results.