hideBlock()

hideBlock() – たとえそれが "空" でなくてもブロックを隠す

Synopsis

require_once 'HTML/Template/Sigma.php';

mixed HTML_Template_Sigma::hideBlock ( string $block )

Description

たとえそれが "空" でなくてもブロックを隠します。

ちょうど touchBlock() と逆の働きをします。

登録した/"特別な" ユーザにしか見せないブロック (たとえば '編集' リンク) で、見せるか見せないかは 'id' フィールドが含まれる大きな配列を setVariable() に渡して設定するといった場合を考えてみましょう。 注意深く変数を設定してブロックを見せないようにする (間違えやすい方法です) か、あるいは単に hideBlock() をコールします。

Parameter

string $block

ブロック名。

Return value

成功した場合に SIGMA_OK、 失敗した場合にエラーオブジェクトを返します。

Throws

Possible PEAR_Error values
エラーコード エラーメッセージ 原因 対応
SIGMA_BLOCK_NOT_FOUND Cannot find block '$block' ブロック $block がテンプレート内に存在しません ブロックの名前を調べ、必要なブロックをすべてテンプレートに追加したかどうかを調べます

Note

This function can not be called statically.