JTableNested/getTree

The "API16" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description[edit]

Method to get a node and all its child nodes.

Syntax[edit]

getTree($pk=null, $diagnostic=false)

Parameter Name	Default Value	Description
$pk	null	Primary key of the node for which to get the tree.
$diagnostic	false	Only select diagnostic data for the nested sets.

Returns[edit]

mixed Boolean false on failure or array of node objects on success.

Defined in[edit]

libraries/joomla/database/tablenested.php

Importing[edit]

jimport( 'joomla.database.tablenested' );

Source Body[edit]

public function getTree($pk = null, $diagnostic = false)
{
        // Initialise variables.
        $k = $this->_tbl_key;
        $pk = (is_null($pk)) ? $this->$k : $pk;

        // Get the node and children as a tree.
        $select = ($diagnostic) ? 'SELECT n.'.$k.', n.parent_id, n.level, n.lft, n.rgt' : 'SELECT n.*';
        $this->_db->setQuery(
                $select .
                ' FROM `'.$this->_tbl.'` AS n, `'.$this->_tbl.'` AS p' .
                ' WHERE n.lft BETWEEN p.lft AND p.rgt' .
                ' AND p.'.$k.' = '.(int) $pk .
                ' ORDER BY n.lft'
        );
        $tree = $this->_db->loadObjectList();

        // Check for a database error.
        if ($this->_db->getErrorNum()) {
                $this->setError($this->_db->getErrorMsg());
                return false;
        }

        return $tree;
}

Examples[edit]

Code Examples[edit]

API16