get() (Previous) (Next) getCurrentBlock()
View this page in Last updated: Mon, 02 Jul 2007
English | Dutch | French | German | Hungarian | Japanese | Polish | Russian | Spanish | Plain HTML

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]])

Opis

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.

Parametr

string $parent

parent block name

boolean $recursive

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

Zwracana wartość

return a list of child blocks

Zobacz

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

Wyjątki

Tabela 43-1. Możliwe wartości PEAR_Error

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

Uwagi

Ta funkcja nie może być wywołana statycznie.

get() (Previous) (Next) getCurrentBlock()
Download Documentation Last updated: Mon, 02 Jul 2007
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.