API17:JTableNested

JTableNested

Description

JTableNested is a table class which supports modified pre-order tree traversal behaviour. This class is derived from the base JTable class and adds methods to support a binary tree structure in the database, with pre-order being the preferred method of traversal.

Methods

Visibility	Method name	Description
public	check	Asset that the nested set data is valid.
public	debug	Sets the debug level on or off.
public	delete	Method to delete a node, and optionally its child nodes, from the table.
public	getPath	Method to get an array of nodes from a given node to its root.
public	getRootId	Gets the ID of the root item in the tree.
public	getTree	Method to get a node and all its child nodes.
public	isLeaf	Method to determine if a node is a leaf node in the tree (has no children).
public	move	Method to move a row in the ordering sequence of a group of rows defined by an SQL WHERE clause.
public	moveByReference	Method to move a node and its children to a new location in the tree.
public	orderDown	Method to move a node one position to the right in the same level.
public	orderUp	Method to move a node one position to the left in the same level.
public	publish	Method to set the publishing state for a node or list of nodes in the database table.
public	rebuild	Method to recursively rebuild the whole nested set tree.
public	rebuildPath	Method to rebuild the node's path field from the alias values of the nodes from the current node to the root node of the tree.
public	saveorder	Method to update order of table rows.
public	setLocation	Method to set the location of a node in the tree object.
public	store	Method to store a node in the database table.
protected	_getNode	Method to get nested set properties for a node in the tree.
protected	_getTreeRepositionData	Method to get various data necessary to make room in the tree at a location for a node and its children.
protected	_logtable
protected	_runQuery

• Defined in libraries/joomla/database/tablenested.php
• Extends JTable
• Extended by
  • JTableAsset
  • JTableCategory
  • JTableMenu

Importing

jimport( 'joomla.database.tablenested' );

See also

• JTableNested source code on BitBucket
• Subpackage Database
• Other versions of JTableNested

{{subst:SeeAlso:JTableNested}}

User contributed notes

<CodeExamplesForm />