setGlobalVariable() (Previous) (Next) setRoot()
View this page in Last updated: Sun, 28 Sep 2008
English | Dutch | French | German | Hungarian | Japanese | Polish | Russian | Spanish | Plain HTML

setOption()

setOption() -- Sets the option for the template class

Synopsis

require_once 'HTML/Template/Sigma.php';

mixed HTML_Template_Sigma::setOption (string $option, mixed $value)

Description

Sets the option for the template class. Currently it understands the following options:

preserve_data

If set to TRUE, then do not substitute variables and remove unused placeholders in data added through setVariable() and setGlobalVariable(). See also bugs #20199 and #21951. Default is FALSE, for performance reasons.

trim_on_save

Whether to trim extra whitespace from template on cache save. Generally safe to have this on, unless you have <pre></pre> in templates or want to preserve HTML indentantion. Default is TRUE

charset

Character set to use by builtin 'h' and 'e' callbacks. Default is 'iso-8859-1'. Available since release 1.2.0

Parameter

string $option

option name

mixed $value

option value

Return value

return SIGMA_OK on success, error object on failure

Throws

Table 47-1. Possible PEAR_Error values

Error codeError messageReasonSolution
SIGMA_UNKNOWN_OPTIONUnknown option '$option'$option is not known to SigmaCheck the option name spelling

Note

This function can not be called statically.

setGlobalVariable() (Previous) (Next) setRoot()
Download Documentation Last updated: Sun, 28 Sep 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.