PEAR Manual
PrevNext

getBlockList()

getBlockList() -- Returns a list of blocks within a template.

Synopsis

require_once 'HTML/Template/Sigma.php';

array HTML_Template_Sigma::getBlockList ([string $parent = '__global__' [, bool $recursive = FALSE]])

Description

Returns a list of blocks within a template.

If $recursive is FALSE, it returns just a 'flat' array of $parent's direct subblocks. If $recursive is TRUE, it builds a tree of template blocks using $parent as root. Tree structure is compatible with PEAR::Tree's Memory_Array driver.

Parameter

string $parent

parent block name

boolean $recursive

whether to return a tree of child blocks (TRUE) or a 'flat' array (FALSE)

Return value

return a list of child blocks

See

see HTML_Template_Sigma::blockExists(), HTML_Template_Sigma::getPlaceholderList()

Throws

Table 31-1. Possible PEAR_Error values

Error codeError messageReasonSolution
SIGMA_BLOCK_NOT_FOUNDCannot find block '$parent'There is no block $parent 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.

PrevHomeNext
get()UpgetCurrentBlock()