DB_NestedSet::getSubBranch()

DB_NestedSet::getSubBranch()  -- 指定した ID のノードのすべての子を取得する

概要

require_once 'DB/NestedSet.php';

mixed DB_NestedSet::getSubBranch (string $id, bool [$keepAsArray = FALSE], bool [$aliasFields = TRUE], array [$addSQL = array()])

説明

getChildren は直下の子のみを取得します。 getSubBranch は指定したノード以下のすべてのノードを返します。

パラメータ

string $id

ノード ID。

boolean $keepAsArray

(オプション) 結果を配列で保持するか、 それを DB_NestedSet_Node オブジェクトのセットに変換するか?

boolean $aliasFields

(オプション) フィールドのエイリアスを作成してパラメータのキーの名前とするか、 そのままにしておくか?

array $addSQL

(オプション) クエリに渡す追加パラメータの配列。

返り値

ノードの配列、あるいはエラー時に false を返します。

参照

_addSQL も参照ください。

例外・エラー

例外はスローされません。

注意

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