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

Pick Node

<?php
require_once('DB/NestedSet.php');
    
$nestedSet =& DB_NestedSet::factory('DB'$dsn$params);
    
$parent $nestedSet->createRootNode(array('name' => 'root-node'), falsetrue);
    
$nestedSet->createSubNode($parent, array('name' => 'sub1'));
    
$data $nestedSet->getBranch($id);
?>
Wrapper for node moving and copying (Previous) Removes an event listener (Next)
Last updated: Thu, 02 Oct 2014 — 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:

There are no user contributed notes for this page.