JTableNested
Table class supporting modified pre-order tree traversal behavior.
Located in /libraries/joomla/table/nested.php (line 20)
JObject | --JTable | --JTableNested
| Class | Description |
|---|---|
TagsTableTag
|
Tags table |
|
JTableAsset
|
Table class supporting modified pre-order tree traversal behavior. |
|
JTableCategory
|
Category table |
|
JTableMenu
|
Menu table |
integer
rebuild
([integer $parentId = null], [integer $leftId = 0], [integer $level = 0], [string $path = ''])
mixed
_getTreeRepositionData
(object $referenceNode, integer $nodeWidth, [string $position = 'before'])
string
$alias
(line 64)
Object property holding the alias of this node used to constuct the full text path, forward-slash delimited.
integer
$level
(line 37)
Object property holding the depth level of the node in the tree.
integer
$lft
(line 46)
Object property holding the left value of the node for managing its placement in the nested sets tree.
integer
$parent_id
(line 29)
Object property holding the primary key of the parent node. Provides adjacency list data for nodes.
integer
$rgt
(line 55)
Object property holding the right value of the node for managing its placement in the nested sets tree.
array
$_cache
= array() (line 91)
An array to cache values in recursive processes.
integer
$_debug
= 0 (line 99)
Debug level
string
$_location
(line 73)
Object property to hold the location type to use when storing the row.
Possible values are: ['before', 'after', 'first-child', 'last-child'].
integer
$_location_id
(line 83)
Object property to hold the primary key of the location reference node to use when storing the row. A combination of location type and reference node describes where to store the current node in the tree.
Inherited Variables
Inherited from JTable
Inherited from JObject
Checks that the object is valid and able to be stored.
This method checks that the parent_id is non-zero and exists in the database. Note that the root node (parent_id = 0) cannot be manipulated with this class.
- JTable::check()
- Method to perform sanity checks on the JTable instance properties to ensure they are safe to store in the database. Child classes should override this method to make sure the data they are storing in the database is safe and as expected before storage.
- TagsTableTag::check() : Overloaded check method to ensure data integrity.
- JTableAsset::check() : Assert that the nested set data is valid.
- JTableCategory::check() : Override check function
- JTableMenu::check() : Overloaded check function
Sets the debug level on or off
-
integer
$level:
- = off, 1 = on
Method to delete a node and, optionally, its child nodes from the table.
- integer $pk: The primary key of the node to delete.
- boolean $children: True to delete child nodes, false to move them up a level.
- JTable::delete()
- Method to delete a row from the database table by primary key value.
- TagsTableTag::delete() : Method to delete a node and, optionally, its child nodes from the table.
- CategoriesTableCategory::delete() : Method to delete a node and, optionally, its child nodes from the table.
- MenusTableMenu::delete() : Method to delete a node and, optionally, its child nodes from the table.
Method to get an array of nodes from a given node to its root.
- integer $pk: Primary key of the node for which to get the path.
- boolean $diagnostic: Only select diagnostic data for the nested sets.
Method to get a node and all its child nodes.
- integer $pk: Primary key of the node for which to get the tree.
- boolean $diagnostic: Only select diagnostic data for the nested sets.
Method to determine if a node is a leaf node in the tree (has no children).
- integer $pk: Primary key of the node to check.
Method to move a row in the ordering sequence of a group of rows defined by an SQL WHERE clause.
Negative numbers move the row up in the sequence and positive numbers move it down.
- integer $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.
- JTable::move()
- Method to move a row in the ordering sequence of a group of rows defined by an SQL WHERE clause.
Method to move a node and its children to a new location in the tree.
- integer $referenceId: The primary key of the node to reference new location by.
- string $position: Location type string. ['before', 'after', 'first-child', 'last-child']
- integer $pk: The primary key of the node to move.
Method to move a node one position to the right in the same level.
- integer $pk: Primary key of the node to move.
Method to move a node one position to the left in the same level.
- integer $pk: Primary key of the node to move.
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.
- integer $state: The publishing state. eg. [0 = unpublished, 1 = published]
- integer $userId: The user id of the user performing the operation.
- JTable::publish()
- Method to set the publishing state for a row or list of rows in the database table. The method respects checked out rows by other users and will attempt to checkin rows that it can after adjustments are made.
Method to recursively rebuild the whole nested set tree.
- integer $parentId: The root of the tree to rebuild.
- integer $leftId: The left id to start with in building the tree.
- integer $level: The level to assign to the current nodes.
- string $path: The path to the current nodes.
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.
- integer $pk: Primary key of the node for which to get the path.
Method to update order of table rows
- array $idArray: id numbers of rows to be reordered.
- array $lft_array: lft values of rows to be reordered.
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.
- integer $referenceId: The primary key of the node to reference new location by.
- string $position: Location type string. ['before', 'after', 'first-child', 'last-child']
Method to store a node in the database table.
- boolean $updateNulls: True to update null values as well.
- JTable::store()
- Method to store a row in the database from the JTable instance properties.
- TagsTableTag::store() : Overriden JTable::store to set modified data and user id.
- JTableCategory::store() : Overridden JTable::store to set created/modified and user id.
- JTableMenu::store() : Overloaded store function
Method to get nested set properties for a node in the tree.
- integer $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.
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.
- integer $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.
Method to create a log table in the buffer optionally showing the query and/or data.
- boolean $showData: True to show data
- boolean $showQuery: True to show query
Runs a query and unlocks the database on an error.
- mixed $query: A string or JDatabaseQuery object.
- string $errorMessage: Unused.
Inherited Methods
Inherited From JTable
JTable::__construct()
Inherited From JObject
Documentation generated on Tue, 19 Nov 2013 15:09:22 +0100 by phpDocumentor 1.4.3