Search

Methods

⇦ Back to Nested class

Method getTree

public mixed
getTree
(mixed $pk = null, mixed $diagnostic = false)
Method to get a node and all its child nodes.
Parameters
  • int $pk Primary key of the node for which to get the tree.
  • bool $diagnostic Only select diagnostic data for the nested sets.
Returns
  • mixed Boolean false on failure or array of node objects on success.
Since
  • 1.7.0
-
  • \RuntimeException on database error.
Class: Nested
Project: Joomla

Method getTree - Source code

/**
 * Method to get a node and all its child nodes.
 *
 * @param   integer  $pk          Primary key of the node for which to get the tree.
 * @param   boolean  $diagnostic  Only select diagnostic data for the nested sets.
 *
 * @return  mixed    Boolean false on failure or array of node objects on success.
 *
 * @since   1.7.0
 * @throws  \RuntimeException on database error.
 */
public function getTree($pk = null, $diagnostic = false)
{
    $k = $this->_tbl_key;
    $pk = \is_null($pk) ? $this->{$k} : $pk;
    // Get the node and children as a tree.
    $select = $diagnostic ? 'n.' . $k . ', n.parent_id, n.level, n.lft, n.rgt' : 'n.*';
    $query = $this->_db->getQuery(true)->select($select)->from($this->_tbl . ' AS n, ' . $this->_tbl . ' AS p')->where('n.lft BETWEEN p.lft AND p.rgt')->where('p.' . $k . ' = ' . (int) $pk)->order('n.lft');
    return $this->_db->setQuery($query)->loadObjectList();
}