getPlaceholderList()

getPlaceholderList() – Returns a list of placeholders within a block.

Synopsis

require_once 'HTML/Template/Sigma.php';

array HTML_Template_Sigma::getPlaceholderList ( string $block = '__global__' )

Description

Returns a list of placeholders within a block.

Only 'normal' placeholders are in the list, not ones automatically created for blocks and template functions.

Parameter

string $block

block name

Return value

return a list of placeholders

Throws

Possible PEAR_Error values
Error code Error message Reason Solution
SIGMA_BLOCK_NOT_FOUND Cannot find block '$block' There is no block $block in the template Check the block name spelling, check whether you added all the necessary blocks to the template

Note

This function can not be called statically.

Returns the current block name (Previous) Hides the block even if it is not "empty". (Next)
Last updated: Thu, 31 Jul 2014 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

There are no user contributed notes for this page.