DB_NestedSet::getChildren

DB_NestedSet::getChildren() – Fetch the children _one level_ after of a node given by id

Synopsis

require_once 'DB/NestedSet.php';

mixed DB_NestedSet::getChildren ( int $id , bool $keepAsArray = false , bool $aliasFields = true , bool $forceNorder = false , 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?

boolean $forceNorder

(optional) Force the result to be ordered by the norder param (as opposed to the value of secondary sort). Used by the move and add methods.

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 Children

<?php
require_once('DB/NestedSet.php');
    
$nestedSet =& DB_NestedSet::factory('DB'$dsn$params);
    
$parent $nestedSet->createRootNode(array('name' => 'root-node'), falsetrue);
    
$parent2 $nestedSet->createSubNode($parent, array('name' => 'sub-node));
    $nestedSet->createSubNode($parent2, array('
name' => 'sub1'));
    $nestedSet->createSubNode($parent2, array('
name' => 'sub2));
    
$data $nestedSet->getChildren($parent2);
?>
DB_NestedSet::getBranch (Previous) DB_NestedSet::getParent (Next)
Last updated: Tue, 02 Jun 2009 — 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:

Note by: Burrito Grande
If the node has no children, this function appears to return false.

(I was expecting an empty array from what was written above)