JTableNested: Difference between revisions
From Joomla! Documentation
m →User contributed notes: moving preparation |
m moving preparation |
||
| Line 14: | Line 14: | ||
|- | |- | ||
|public | |public | ||
|[[JTableNested::check | |[[API17:JTableNested::check|check]] | ||
|Asset that the nested set data is valid. | |Asset that the nested set data is valid. | ||
|- | |- | ||
|public | |public | ||
|[[JTableNested::debug | |[[API17:JTableNested::debug|debug]] | ||
|Sets the debug level on or off. | |Sets the debug level on or off. | ||
|- | |- | ||
|public | |public | ||
|[[JTableNested::delete | |[[API17:JTableNested::delete|delete]] | ||
|Method to delete a node, and optionally its child nodes, from the table. | |Method to delete a node, and optionally its child nodes, from the table. | ||
|- | |- | ||
|public | |public | ||
|[[JTableNested::getPath | |[[API17:JTableNested::getPath|getPath]] | ||
|Method to get an array of nodes from a given node to its root. | |Method to get an array of nodes from a given node to its root. | ||
|- | |- | ||
|public | |public | ||
|[[JTableNested::getRootId | |[[API17:JTableNested::getRootId|getRootId]] | ||
|Gets the ID of the root item in the tree. | |Gets the ID of the root item in the tree. | ||
|- | |- | ||
|public | |public | ||
|[[JTableNested::getTree | |[[API17:JTableNested::getTree|getTree]] | ||
|Method to get a node and all its child nodes. | |Method to get a node and all its child nodes. | ||
|- | |- | ||
|public | |public | ||
|[[JTableNested::isLeaf | |[[API17:JTableNested::isLeaf|isLeaf]] | ||
|Method to determine if a node is a leaf node in the tree (has no children). | |Method to determine if a node is a leaf node in the tree (has no children). | ||
|- | |- | ||
|public | |public | ||
|[[JTableNested::move | |[[API17:JTableNested::move|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 row in the ordering sequence of a group of rows defined by an SQL WHERE clause. | ||
|- | |- | ||
|public | |public | ||
|[[JTableNested::moveByReference | |[[API17:JTableNested::moveByReference|moveByReference]] | ||
|Method to move a node and its children to a new location in the tree. | |Method to move a node and its children to a new location in the tree. | ||
|- | |- | ||
|public | |public | ||
|[[JTableNested::orderDown | |[[API17:JTableNested::orderDown|orderDown]] | ||
|Method to move a node one position to the right in the same level. | |Method to move a node one position to the right in the same level. | ||
|- | |- | ||
|public | |public | ||
|[[JTableNested::orderUp | |[[API17:JTableNested::orderUp|orderUp]] | ||
|Method to move a node one position to the left in the same level. | |Method to move a node one position to the left in the same level. | ||
|- | |- | ||
|public | |public | ||
|[[JTableNested::publish | |[[API17:JTableNested::publish|publish]] | ||
|Method to set the publishing state for a node or list of nodes in the database table. | |Method to set the publishing state for a node or list of nodes in the database table. | ||
|- | |- | ||
|public | |public | ||
|[[JTableNested::rebuild | |[[API17:JTableNested::rebuild|rebuild]] | ||
|Method to recursively rebuild the whole nested set tree. | |Method to recursively rebuild the whole nested set tree. | ||
|- | |- | ||
|public | |public | ||
|[[JTableNested::rebuildPath | |[[API17:JTableNested::rebuildPath|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. | |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 | |public | ||
|[[JTableNested::saveorder | |[[API17:JTableNested::saveorder|saveorder]] | ||
|Method to update order of table rows. | |Method to update order of table rows. | ||
|- | |- | ||
|public | |public | ||
|[[JTableNested::setLocation | |[[API17:JTableNested::setLocation|setLocation]] | ||
|Method to set the location of a node in the tree object. | |Method to set the location of a node in the tree object. | ||
|- | |- | ||
|public | |public | ||
|[[JTableNested::store | |[[API17:JTableNested::store|store]] | ||
|Method to store a node in the database table. | |Method to store a node in the database table. | ||
|- | |- | ||
|protected | |protected | ||
|[[JTableNested::_getNode | |[[API17:JTableNested::_getNode|_getNode]] | ||
|Method to get nested set properties for a node in the tree. | |Method to get nested set properties for a node in the tree. | ||
|- | |- | ||
|protected | |protected | ||
|[[JTableNested::_getTreeRepositionData | |[[API17:JTableNested::_getTreeRepositionData|_getTreeRepositionData]] | ||
|Method to get various data necessary to make room in the tree at a location for a node and its children. | |Method to get various data necessary to make room in the tree at a location for a node and its children. | ||
|- | |- | ||
|protected | |protected | ||
|[[JTableNested::_logtable | |[[API17:JTableNested::_logtable|_logtable]] | ||
| | | | ||
|- | |- | ||
|protected | |protected | ||
|[[JTableNested::_runQuery | |[[API17:JTableNested::_runQuery|_runQuery]] | ||
| | | | ||
|- | |- | ||
|} | |} | ||
* '''Defined in''' libraries/joomla/database/tablenested.php | * '''Defined in''' libraries/joomla/database/tablenested.php | ||
* '''Extends''' [[JTable | * '''Extends''' [[API17:JTable|JTable]] | ||
* '''Extended by''' | * '''Extended by''' | ||
** [[JTableAsset | ** [[API17:JTableAsset|JTableAsset]] | ||
** [[JTableCategory | ** [[API17:JTableCategory|JTableCategory]] | ||
** [[JTableMenu | ** [[API17:JTableMenu|JTableMenu]] | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.database.tablenested' );</source> | <source lang="php">jimport( 'joomla.database.tablenested' );</source> | ||
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JTableNested source code''' on [[jplatform:database/tablenested.php|BitBucket]] | * {{JVer|11.1}} '''JTableNested source code''' on [[jplatform:database/tablenested.php|BitBucket]] | ||
* {{JVer|11.1}} Subpackage [[Subpackage Database | * {{JVer|11.1}} Subpackage [[API17:Subpackage Database|Database]] | ||
* [[JTableNested|Other versions of JTableNested]] | * [[API17:JTableNested|Other versions of JTableNested]] | ||
{{SeeAlso:JTableNested}} | {{SeeAlso:JTableNested}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
Revision as of 02:41, 12 May 2013
JTableNested
Description
Template:Description:JTableNested [Edit Descripton]
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
Importing
jimport( 'joomla.database.tablenested' );
See also
JTableNested source code on BitBucket
Subpackage Database- Other versions of JTableNested
Template:SeeAlso:JTableNested [Edit See Also]
User contributed notes
<CodeExamplesForm />