Helping ordinary people create extraordinary websites!


PEAR Manual
PrevNext

DB_NestedSet::pickNode()

DB_NestedSet::pickNode()  -- Fetch the data of a node with the given id

Synopsis

require_once 'DB/NestedSet.php';

mixed DB_NestedSet::pickNode (int $id, bool [$keepAsArray = FALSE], bool [$aliasFields = TRUE], string [$idfield = 'id'], array [$addSQL = array()])

Description

This package is not documented yet.

Parameter

integer $id

The node id of the node to fetch

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?

string $idfield

(optional) Which field has to be compared with $id? This is can be used to pick a node by other values (e.g. its name).

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 39-1. Pick Node

require_once('DB/NestedSet.php');
    $nestedSet =& DB_NestedSet::factory('DB', $dsn, $params);
    $parent = $nestedSet->createRootNode(array('name' => 'root-node'), false, true);
    $nestedSet->createSubNode($parent, array('name' => 'sub1'));
    $data = $nestedSet->getBranch($id);
PrevHomeNext
DB_NestedSet::moveTree()UpDB_NestedSet::removeListener()