DB_NestedSet::getSubBranch
Synopsis
mixed
DB_NestedSet::getSubBranch
(
string
$id
,
bool
$keepAsArray
= false
,
bool
$aliasFields
= true
,
array
$addSQL = array()
)
Description
getChildren only queries the immediate children getSubBranch returns all nodes below the given node
Parameter
-
string
$id -
The node ID
-
boolean
$keepAsArray -
(optional) Keep the result as an array or transform it into a set of DB_NestedSet_Node objects?
-
boolean
$aliasFields -
(optional) Should we alias the fields so they are the names of the parameter keys, or leave them as is?
-
array
$addSQL -
(optional) Array of additional params to pass to the query.
Return value
returns False on error, or an array of nodes
See
see _addSQL
Throws
throws no exceptions thrown
Note
This function can not be called statically.
Example
Get SubBranch
<?php
require_once('DB/NestedSet.php');
$nestedSet =& DB_NestedSet::factory('DB', $dsn, $params);
$parent = $nestedSet->createRootNode(array('name' => 'root-node'), false, true);
$parent2 = $nestedSet->createSubNode($parent, array('name' => 'sub-node));
$parent3 = $nestedSet->createSubNode($parent2, array('name' => 'sub-node));
$nestedSet->createSubNode($parent3, array('name' => 'sub1'));
$nestedSet->createSubNode($parent3, array('name' => 'sub2'));
$data = $nestedSet->getSubBranch($parent2);
?>