getBlockList()

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

Synopsis

require_once 'HTML/Template/Sigma.php';

array HTML_Template_Sigma::getBlockList ( string $parent = '__global__' , bool $recursive = = false )

Description

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

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

Parameter

string $parent

親ブロック名。

boolean $recursive

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

Return value

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

Throws

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

Note

This function can not be called statically.

すべての置換を済ませたブロックを返す (Previous) 現在のブロック名を返す (Next)
Last updated: Tue, 02 Sep 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.