PEAR Manual
PrevNext

DB_NestedSet::getSubBranch()

DB_NestedSet::getSubBranch()  -- Fetch all the children of a node given by id

Synopsis

require_once 'DB/NestedSet.php';

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

Example 36-1. Get SubBranch

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);
PrevHomeNext
DB_NestedSet::getSiblings()UpDB_NestedSet::isParent()