hideBlock()

hideBlock() – Hides the block even if it is not "empty".

Synopsis

require_once 'HTML/Template/Sigma.php';

mixed HTML_Template_Sigma::hideBlock ( string $block )

Description

Hides the block even if it is not "empty".

Is somewhat an opposite to touchBlock().

Consider a block (a 'edit' link for example) that should be visible to registered/"special" users only, but its visibility is triggered by some little 'id' field passed in a large array into setVariable(). You can either carefully juggle your variables to prevent the block from appearing (a fragile solution) or simply call hideBlock()

Parameter

string $block

block name

Return value

return SIGMA_OK on success, error object on failure

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.

getPlaceholderList() (Previous) loadTemplateFile() (Next)
Last updated: Tue, 02 Jun 2009 — 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.