get()

get() -- Returns a block with all replacements done.

Synopsis

require_once 'HTML/Template/Sigma.php';

string HTML_Template_Sigma::get ([string $block = '__global__' [, bool $clear = FALSE]])

Description

Returns a parsed block: block with all replacements done.

This method will automatically call parse(), only if called with $block='__global__' when '__global__' was not parse()'d before. In all other cases you should call parse() before calling get()

Parameter

string $block

block name

boolean $clear

whether to clear parsed block contents

Return value

return block with all replacements done

See

see HTML_Template_Sigma::show()

Throws

Table 31-1. Possible PEAR_Error values

Error codeError messageReasonSolution
SIGMA_BLOCK_NOT_FOUNDCannot find block '$block'There is no block $block in the templateCheck the block name spelling, check whether you added all the necessary blocks to the template

Note

This function can not be called statically.