PEAR Manual
PrevNext

placeholderExists()

placeholderExists() -- Checks whether the placeholder exists

Synopsis

require_once 'HTML/Template/Sigma.php';

string HTML_Template_Sigma::placeholderExists (string $placeholder [, string $block = ''])

Description

Checks whether the placeholder exists in the template, returns the name of the (first) block that contains the specified placeholder.

Parameter

string $placeholder

Name of the placeholder you're searching

string $block

Name of the block to scan. If left out (default) all blocks are scanned.

Return value

return Name of the (first) block that contains the specified placeholder. If the placeholder was not found an empty string is returned.

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.

PrevHomeNext
parseCurrentBlock()UpreplaceBlock()