HTML_Template_IT::setRoot() (Previous)

(Next) HTML_Template_IT::setTemplate()

View this page in	Last updated: Sun, 31 Aug 2008
English \| Dutch \| French \| German \| Hungarian \| Japanese \| Polish \| Russian \| Spanish \| Plain HTML

HTML_Template_IT::setOption()

HTML_Template_IT::setOption() -- sets an option

Synopsis

require_once 'HTML/Template/IT.php';

int HTML_Template_IT::setOption (string $option, mixed $value)

Description

Sets an option. Please notice that changing some option might result in an unexpected behaviour of HTML_Template_IT.

Return value

int - Returns 1 on success, otherwise an IT_Error object.

Parameter

mixed $option - Option identifier
mixed $value - New value of the option

Options

Table 47-1. Possible options:

Option	Default value	Description
`removeUnknownVariables`	`TRUE`	If `TRUE` all template variables, which are not filled, are removed while parsing. This option is usually set by calling HTML_Template_IT::loadTemplatefile() or HTML_Template_IT::setTemplate().
`removeEmptyBlocks`	`TRUE`	If `TRUE` all blocks not containing any filled template variables are removed. This option is usually set by calling HTML_Template_IT::loadTemplatefile() or HTML_Template_IT::setTemplate().
`clearCache`	`FALSE`	If `TRUE` parsed blocks are not cached. If you don't know exactly what you do, just leave the default value.
`clearCacheOnParse`	`FALSE`	If `TRUE` the variable cache will be cleaned after parsing. If you don't know exactly what you do, just leave the default value.
`openingDelimiter`	`'{'`	Defines the character, every template variable has to start with. If you change this value, you have to call init() to reinitialise the template. If you don't know exactly what you do, just leave the default value.
`closingDelimiter`	`'}'`	Defines the character, every template variable has to end with. If you change this value, you have to call init() to reinitialise the template. If you don't know exactly what you do, just leave the default value.
`blocknameRegExp`	`'[\.0-9A-Za-z_-]+'`	The regular expression, thats used to parse block names. If you change this value, you have to call init() to reinitialise the template. If you don't know exactly what you do, just leave the default value.
`variablenameRegExp`	`'[\.0-9A-Za-z_-]+'`	The regular expression, thats used to parse template variable names. If you change this value, you have to call init() to reinitialise the template. If you don't know exactly what you do, just leave the default value.

Note

This function can not be called statically.

See

HTML_Template_IT::loadTemplatefile()

HTML_Template_IT::setTemplate()

HTML_Template_IT::setRoot() (Previous)

(Next) HTML_Template_IT::setTemplate()

Download Documentation	Last updated: Sun, 31 Aug 2008
Do you think that something on this page is wrong? Please file a bug report or add a note.
User Notes:
There are no user contributed notes for this page.