setGlobalVariable() setRoot()

HTML_Template_Sigma

PEAR Manual


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

Parameter

string $option

option name

mixed $value

option value

Return value

return SIGMA_OK on success, error object on failure

Throws

Possible PEAR_Error values

Error code Error message Reason Solution
SIGMA_UNKNOWN_OPTION Unknown option '$option ' $option is not known to Sigma Check the option name spelling

Note

This function can not be called statically.



setGlobalVariable() setRoot()

HTML_Template_Sigma

PEAR Manual