PEAR マニュアル
前のページ次のページ

getBlockList()

getBlockList() -- テンプレート内のブロックの一覧を返す

概要

require_once 'HTML/Template/Sigma.php';

array HTML_Template_Sigma::getBlockList ([string $parent = '__global__' [, bool $recursive = FALSE]])

説明

テンプレート内のブロックの一覧を返します。

$recursive が FALSE の場合は、 $parent の直下のサブブロックのみを 'フラットな' 配列で返します。 $recursive が TRUE の場合は、 $parent をルートとするテンプレートブロックのツリーを作成します。 ツリーの構造は、PEAR::Tree の Memory_Array ドライバと同じものになります。

パラメータ

string $parent

親ブロック名。

boolean $recursive

子ブロックのツリーを返す (TRUE) か 'フラット' な配列を返す (FALSE) か。

返り値

子ブロックの一覧を返します。

参照

HTML_Template_Sigma::blockExists()、 HTML_Template_Sigma::getPlaceholderList() も参照ください。

例外・エラー

表 47-1PEAR_Error の値

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

注意

この関数は、スタティックにコールする ことはできません。

前のページホーム次のページ
get()上に戻るgetCurrentBlock()