PEAR Manual
PrevNext

DB_NestedSet::getSiblings()

DB_NestedSet::getSiblings()  --  Fetch all siblings of the node given by id Important: The node given by ID will also be returned Do a unset($array[$id]) on the result if you don't want that

Synopsis

require_once 'DB/NestedSet.php';

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

Description

This package is not documented yet.

Parameter

integer $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 the parent node

See

see _addSQL

Throws

throws no exceptions thrown

Note

This function can not be called statically.

Example

Example 36-1. Get Siblings

require_once 'DB/NestedSet.php';
    $nestedSet =& DB_NestedSet::factory('DB', $dsn, $params);
    $parent = $nestedSet->createRootNode(array('name' => 'root-node'), false, true);
    $node = $nestedSet->createSubNode($parent, array('name' => 'sub1'));
    $nestedSet->createSubNode($parent, array('name' => 'sub2'));
    $nestedSet->createSubNode($parent, array('name' => 'sub3'));
    $data = $nestedSet->getSiblings($node);
PrevHomeNext
DB_NestedSet::getRootNodes()UpDB_NestedSet::getSubBranch()