API17

JTableNested: Difference between revisions

From Joomla! Documentation

← Older edit
Doxiki2 (talk | contribs)
Bots
18,905 edits
Updated to r1448:247ba8d88526
m preparing for archive only
 
(5 intermediate revisions by the same user not shown)
Line 2: Line 2:
=={{JVer|11.1}} JTableNested==
=={{JVer|11.1}} JTableNested==
===Description===
===Description===
{{Description:JTableNested}}
JTableNested is a table class which supports modified pre-order [[wikipedia:tree traversal|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.
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[Description:JTableNested|Edit Descripton]]<nowiki>]</nowiki>
</span>
===Methods===
===Methods===
{| class="wikitable sortable"
{| class="wikitable sortable"
Line 14: Line 12:
|-
|-
|public  
|public  
|[[JTableNested::check/11.1|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/11.1|debug]]
|[[API17:JTableNested::debug|debug]]
|Sets the debug level on or off.  
|Sets the debug level on or off.  
|-
|-
|public  
|public  
|[[JTableNested::delete/11.1|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/11.1|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/11.1|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/11.1|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/11.1|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/11.1|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/11.1|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/11.1|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/11.1|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/11.1|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/11.1|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/11.1|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/11.1|saveorder]]
|[[API17:JTableNested::saveorder|saveorder]]
|Method to update order of table rows.  
|Method to update order of table rows.  
|-
|-
|public  
|public  
|[[JTableNested::setLocation/11.1|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/11.1|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/11.1|_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/11.1|_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/11.1|_logtable]]
|[[API17:JTableNested::_logtable|_logtable]]
|
|
|-
|-
|protected  
|protected  
|[[JTableNested::_runQuery/11.1|_runQuery]]
|[[API17:JTableNested::_runQuery|_runQuery]]
|
|
|-
|-
|}
|}
* '''Defined in''' libraries/joomla/database/tablenested.php
* '''Defined in''' libraries/joomla/database/tablenested.php
* '''Extends''' [[JTable/11.1|JTable]]
* '''Extends''' [[API17:JTable|JTable]]
* '''Extended by'''
* '''Extended by'''
** [[JTableAsset/11.1|JTableAsset]]
** [[API17:JTableAsset|JTableAsset]]
** [[JTableCategory/11.1|JTableCategory]]
** [[API17:JTableCategory|JTableCategory]]
** [[JTableMenu/11.1|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/11.1|Database]]
* {{JVer|11.1}} Subpackage [[API17:Subpackage Database|Database]]
* [[JTableNested|Other versions of JTableNested]]
* [[API17:JTableNested|Other versions of JTableNested]]
{{SeeAlso:JTableNested}}
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JTableNested|Edit See Also]]<nowiki>]</nowiki>
</span>
===User contributed notes===
===User contributed notes===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
noresultsheader=\n
noresultsheader=\n
category=JTableNested
category=JTableNested
category=CodeExample
namespace=CodeExample
category=ClassExample
category=ClassExample
include=*
include=*
Line 125: Line 121:
format= ,,,
format= ,,,
</dpl>
</dpl>
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JTableNested]]</noinclude>
<noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude>

Latest revision as of 03:49, 25 March 2017

Joomla 11.1 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

Importing

jimport( 'joomla.database.tablenested' );

See also


User contributed notes

Code Examples


Retrieved from "https://docs.sandbox.joomla.org/index.php?title=API17:JTableNested&oldid=386256"