Liste de tous les membres
Fonctions membres publiques |
| | debug ($level) |
| | getPath ($pk=null, $diagnostic=false) |
| | getTree ($pk=null, $diagnostic=false) |
| | isLeaf ($pk=null) |
| | setLocation ($referenceId, $position= 'after') |
| | move ($delta, $where= '') |
| | moveByReference ($referenceId, $position= 'after', $pk=null) |
| | delete ($pk=null, $children=true) |
| | check () |
| | store ($updateNulls=false) |
| | publish ($pks=null, $state=1, $userId=0) |
| | orderUp ($pk) |
| | orderDown ($pk) |
| | getRootId () |
| | rebuild ($parentId=null, $leftId=0, $level=0, $path= '') |
| | rebuildPath ($pk=null) |
| | saveorder ($idArray=null, $lft_array=null) |
| | __construct ($table, $key, &$db) |
| | getFields () |
| | getTableName () |
| | getKeyName () |
| | getDbo () |
| | setDBO (&$db) |
| | setRules ($input) |
| | getRules () |
| | reset () |
| | bind ($src, $ignore=array()) |
| | load ($keys=null, $reset=true) |
| | save ($src, $orderingFilter= '', $ignore= '') |
| | delete ($pk=null) |
| | checkOut ($userId, $pk=null) |
| | checkIn ($pk=null) |
| | hit ($pk=null) |
| | isCheckedOut ($with=0, $against=null) |
| | getNextOrder ($where= '') |
| | reorder ($where= '') |
| | canDelete ($pk=null, $joins=null) |
| | toXML ($mapKeysToText=false) |
| | __construct ($properties=null) |
| | __toString () |
| | def ($property, $default=null) |
| | get ($property, $default=null) |
| | getProperties ($public=true) |
| | getError ($i=null, $toString=true) |
| | getErrors () |
| | set ($property, $value=null) |
| | setProperties ($properties) |
| | setError ($error) |
| | toString () |
Documentation des fonctions membres
| JTableNested::_getNode |
( |
|
$id, |
|
|
|
$key = null |
|
) |
| |
|
protected |
Method to get nested set properties for a node in the tree.
- Paramètres:
-
| integer | $id | Value to look up the node by. |
| string | $key | Key to look up the node by. |
- Renvoie:
- mixed Boolean false on failure or node object on success.
- Depuis:
- 11.1
Références $id, $key, $query, $row, et JText\sprintf().
| JTableNested::_getTreeRepositionData |
( |
|
$referenceNode, |
|
|
|
$nodeWidth, |
|
|
|
$position = 'before' |
|
) |
| |
|
protected |
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.
- Paramètres:
-
| 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. |
- Renvoie:
- mixed Boolean false on failure or data object on success.
- Depuis:
- 11.1
Références $data.
| JTableNested::_logtable |
( |
|
$showData = true, |
|
|
|
$showQuery = true |
|
) |
| |
|
protected |
Method to create a log table in the buffer optionally showing the query and/or data.
- Paramètres:
-
| boolean | $showData | True to show data |
| boolean | $showQuery | True to show query |
- Renvoie:
- void
- Depuis:
- 11.1
Références $query, et $row.
| JTableNested::_runQuery |
( |
|
$query, |
|
|
|
$errorMessage |
|
) |
| |
|
protected |
Method to run an update query and check for a database error
- Paramètres:
-
| string | $query | The query. |
| string | $errorMessage | Unused. |
- Renvoie:
- boolean False on exception
- Depuis:
- 11.1
Références $query, et JText\sprintf().
| JTableNested::debug |
( |
|
$level | ) |
|
Sets the debug level on or off
- Paramètres:
-
| integer | $level | 0 = off, 1 = on |
- Renvoie:
- void
- Depuis:
- 11.1
| JTableNested::delete |
( |
|
$pk = null, |
|
|
|
$children = true |
|
) |
| |
| JTableNested::getPath |
( |
|
$pk = null, |
|
|
|
$diagnostic = false |
|
) |
| |
Method to get an array of nodes from a given node to its root.
- Paramètres:
-
| integer | $pk | Primary key of the node for which to get the path. |
| boolean | $diagnostic | Only select diagnostic data for the nested sets. |
- Renvoie:
- mixed Boolean false on failure or array of node objects on success.
11.1
Références $path, $query, et JText\sprintf().
| JTableNested::getRootId |
( |
| ) |
|
Gets the ID of the root item in the tree
- Renvoie:
- mixed The ID of the root row, or false and the internal error is set.
- Depuis:
- 11.1
Références $query, JText\_(), elseif, et JText\sprintf().
| JTableNested::getTree |
( |
|
$pk = null, |
|
|
|
$diagnostic = false |
|
) |
| |
Method to get a node and all its child nodes.
- Paramètres:
-
| integer | $pk | Primary key of the node for which to get the tree. |
| boolean | $diagnostic | Only select diagnostic data for the nested sets. |
- Renvoie:
- mixed Boolean false on failure or array of node objects on success.
11.1
Références $query, et JText\sprintf().
| JTableNested::isLeaf |
( |
|
$pk = null | ) |
|
Method to determine if a node is a leaf node in the tree (has no children).
- Paramètres:
-
| integer | $pk | Primary key of the node to check. |
- Renvoie:
- boolean True if a leaf node.
11.1
| JTableNested::move |
( |
|
$delta, |
|
|
|
$where = '' |
|
) |
| |
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.
- Paramètres:
-
| 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. |
- Renvoie:
- mixed Boolean true on success.
11.1
Réimplémentée à partir de JTable.
Références $query.
| JTableNested::moveByReference |
( |
|
$referenceId, |
|
|
|
$position = 'after', |
|
|
|
$pk = null |
|
) |
| |
Method to move a node and its children to a new location in the tree.
- Paramètres:
-
| 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. |
- Renvoie:
- boolean True on success.
11.1
Références $query, null, JText\sprintf(), et title.
| JTableNested::orderDown |
( |
|
$pk | ) |
|
Method to move a node one position to the right in the same level.
- Paramètres:
-
| integer | $pk | Primary key of the node to move. |
- Renvoie:
- boolean True on success.
11.1
Références $query, et JText\sprintf().
| JTableNested::orderUp |
( |
|
$pk | ) |
|
Method to move a node one position to the left in the same level.
- Paramètres:
-
| integer | $pk | Primary key of the node to move. |
- Renvoie:
- boolean True on success.
11.1
Références $query, et JText\sprintf().
| JTableNested::publish |
( |
|
$pks = null, |
|
|
|
$state = 1, |
|
|
|
$userId = 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.
- Paramètres:
-
| 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. |
- Renvoie:
- boolean True on success.
11.1
Réimplémentée à partir de JTable.
Références $query, $state, $userId, JText\_(), JText\sprintf(), et JArrayHelper\toInteger().
| JTableNested::rebuild |
( |
|
$parentId = null, |
|
|
|
$leftId = 0, |
|
|
|
$level = 0, |
|
|
|
$path = '' |
|
) |
| |
Method to recursively rebuild the whole nested set tree.
- Paramètres:
-
| 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. |
- Renvoie:
- integer 1 + value of root rgt on success, false on failure
11.1
Références $path, $query, et null.
| JTableNested::rebuildPath |
( |
|
$pk = null | ) |
|
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.
- Paramètres:
-
| integer | $pk | Primary key of the node for which to get the path. |
- Renvoie:
- boolean True on success.
11.1
Références $path, $query, et JText\sprintf().
| JTableNested::saveorder |
( |
|
$idArray = null, |
|
|
|
$lft_array = null |
|
) |
| |
Method to update order of table rows
- Paramètres:
-
| array | $idArray | id numbers of rows to be reordered. |
| array | $lft_array | lft values of rows to be reordered. |
- Renvoie:
- integer 1 + value of root rgt on success, false on failure.
- Depuis:
- 11.1
Références $count, $i, $query, et JText\sprintf().
| JTableNested::setLocation |
( |
|
$referenceId, |
|
|
|
$position = 'after' |
|
) |
| |
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.
- Paramètres:
-
| integer | $referenceId | The primary key of the node to reference new location by. |
| string | $position | Location type string. ['before', 'after', 'first-child', 'last-child'] |
- Renvoie:
- boolean True on success.
11.1
Références JText\sprintf().
| JTableNested::store |
( |
|
$updateNulls = false | ) |
|
Documentation des données membres
| JTableNested::$_cache = array() |
|
protected |
| JTableNested::$_debug = 0 |
|
protected |
| JTableNested::$_location_id |
|
protected |
La documentation de cette classe a été générée à partir du fichier suivant :
Graphe d'héritage de JTableNested:
