Class Nested - list of methods

Sets the debug level on or off

• int $level 0 = off, 1 = on

• void

• 1.7.0

Method to get an array of nodes from a given node to its root.

• int $pk Primary key of the node for which to get the path.
• bool $diagnostic Only select diagnostic data for the nested sets.

• mixed An array of node objects including the start node.

• 1.7.0

• \RuntimeException on database error

Method to get a node and all its child nodes.

• int $pk Primary key of the node for which to get the tree.
• bool $diagnostic Only select diagnostic data for the nested sets.

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

• 1.7.0

• \RuntimeException on database error.

Method to determine if a node is a leaf node in the tree (has no children).

• int $pk Primary key of the node to check.

• bool True if a leaf node, false if not or null if the node does not exist.

• 1.7.0

• Since 3.0.0 this method returns null if the node does not exist.
• \RuntimeException on database error.

Method to set the location of a node in the tree object. This method does not save the new location to the database, but will set it in the object so that when the node is stored it will be stored in the new location.

• int $referenceId The primary key of the node to reference new location by.
• string $position Location type string.

• void

• 1.7.0

• Since 3.0.0 this method returns void and throws an \InvalidArgumentException when an invalid position is passed.
• \Joomla\CMS\Table\Nested::$_validLocations
• \InvalidArgumentException

Method to move a row in the ordering sequence of a group of rows defined by an SQL WHERE clause.

• int $delta The direction and magnitude to move the row in the ordering sequence.
• string $where WHERE clause to use for limiting the selection of rows to compact the ordering values.

• mixed Boolean true on success.

• 1.7.0

Method to move a node and its children to a new location in the tree.

• int $referenceId The primary key of the node to reference new location by.
• string $position Location type string. ['before', 'after', 'first-child', 'last-child']
• int $pk The primary key of the node to move.
• bool $recursiveUpdate Flag indicate that method recursiveUpdatePublishedColumn should be call.

• bool True on success.

• 1.7.0

• \RuntimeException on database error.

Method to delete a node and, optionally, its child nodes from the table.

• int $pk The primary key of the node to delete.
• bool $children True to delete child nodes, false to move them up a level.

• bool True on success.

• 1.7.0

Checks that the object is valid and able to be stored.

• bool True if all checks pass.

• 1.7.0

Method to store a node in the database table.

• bool $updateNulls True to update null values as well.

• bool True on success.

• 1.7.0

Method to set the publishing state for a node or list of nodes in the database table. The method respects rows checked out by other users and will attempt to checkin rows that it can after adjustments are made. The method will not allow you to set a publishing state higher than any ancestor node and will not allow you to set a publishing state on a node with a checked out child.

• mixed $pks An optional array of primary key values to update. If not set the instance property value is used.
• int $state The publishing state. eg. [0 = unpublished, 1 = published]
• int $userId The user id of the user performing the operation.

• bool True on success.

• 1.7.0

• \UnexpectedValueException

Method to move a node one position to the left in the same level.

• int $pk Primary key of the node to move.

• bool True on success.

• 1.7.0

• \RuntimeException on database error.

Method to move a node one position to the right in the same level.

• int $pk Primary key of the node to move.

• bool True on success.

• 1.7.0

• \RuntimeException on database error.

Gets the ID of the root item in the tree

• mixed The primary id of the root row, or false if not found and the internal error is set.

• 1.7.0

Method to recursively rebuild the whole nested set tree.

• int $parentId The root of the tree to rebuild.
• int $leftId The left id to start with in building the tree.
• int $level The level to assign to the current nodes.
• string $path The path to the current nodes.

• int 1 + value of root rgt on success, false on failure

• 1.7.0

• \RuntimeException on database error.

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.

• int $pk Primary key of the node for which to get the path.

• bool True on success.

• 1.7.0

Method to reset class properties to the defaults set in the class definition. It will ignore the primary key as well as any private class properties (except $_errors).

• void

• 3.2.1

Method to update order of table rows

• array $idArray id numbers of rows to be reordered.
• array $lftArray lft values of rows to be reordered.

• int|bool 1 + value of root rgt on success, false on failure.

• 1.7.0

• \Exception on database error.

Method to recursive update published column for children rows.

• int $pk Id number of row which published column was changed.
• int $newState An optional value for published column of row identified by $pk .

• bool True on success.

• 3.7.0

• \RuntimeException on database error.

Method to get nested set properties for a node in the tree.

• int $id Value to look up the node by.
• string $key An optional key to look up the node by (parent | left | right). If omitted, the primary key of the table is used.

• mixed Boolean false on failure or node object on success.

• 1.7.0

• \RuntimeException on database error.

Method to get various data necessary to make room in the tree at a location for a node and its children. The returned data object includes conditions for SQL WHERE clauses for updating left and right id values to make room for the node as well as the new left and right ids for the node.

• object $referenceNode A node object with at least a 'lft' and 'rgt' with which to make room in the tree around for a new node.
• int $nodeWidth The width of the node for which to make room in the tree.
• string $position The position relative to the reference node where the room should be made.

• mixed Boolean false on failure or data object on success.

• 1.7.0

Method to create a log table in the buffer optionally showing the query and/or data.

• bool $showData True to show data
• bool $showQuery True to show query

• void

• 1.7.0

Runs a query and unlocks the database on an error.

• mixed $query A string or DatabaseQuery object.
• string $errorMessage Unused.

• void

• 1.7.0

• Since 3.0.0 this method returns void and will rethrow the database exception.
• \Exception on database error.