Class FOFTableNested

A class to manage tables holding nested sets (hierarchical data)

FOFTable implements JTableInterface

FOFTableNested

Package: FrameworkOnFramework\table
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Located at fof/table/nested.php

Methods summary

`public`	# `__construct( string $table, string $key, FOFDatabaseDriver & $db, array $config = array() )` Public constructor. Overrides the parent constructor, making sure there are lft/rgt columns which make it compatible with nested sets. Public constructor. Overrides the parent constructor, making sure there are lft/rgt columns which make it compatible with nested sets. Parameters `$table` `string` - $table Name of the database table to model. `$key` `string` - $key Name of the primary key field in the table. `$db` `FOFDatabaseDriver` - &$db Database driver `$config` `array` - $config The configuration parameters array Throws `RuntimeException` - When lft/rgt columns are not found Overrides `FOFTable::__construct`
`public boolean`	# `check( )` Overrides the automated table checks to handle the 'hash' column for faster searching Overrides the automated table checks to handle the 'hash' column for faster searching Returns `boolean` Overrides `FOFTable::check`
`public boolean`	# `delete( integer $oid = null )` Delete a node, either the currently loaded one or the one specified in $id. If an $id is specified that node is loaded before trying to delete it. In the end the data model is reset. If the node has any children nodes they will be removed before the node itself is deleted. Delete a node, either the currently loaded one or the one specified in $id. If an $id is specified that node is loaded before trying to delete it. In the end the data model is reset. If the node has any children nodes they will be removed before the node itself is deleted. Parameters `$oid` `integer` - $oid The primary key value of the item to delete Returns `boolean` - True on success Throws `UnexpectedValueException` Overrides `FOFTable::delete`
`protected boolean`	# `onAfterDelete( integer $oid )` The event which runs after deleting a record The event which runs after deleting a record Parameters `$oid` `integer` - $oid The PK value of the record which was deleted Returns `boolean` - True to allow the deletion without errors Overrides `FOFTable::onAfterDelete`
`public`	# `reorder( string $where = '' )` Not supported in nested sets Not supported in nested sets Parameters `$where` `string` - $where Ignored Throws `RuntimeException` Overrides `FOFTable::reorder`
`public`	# `move( integer $delta, string $where = '' )` Not supported in nested sets Not supported in nested sets Parameters `$delta` `integer` - $delta Ignored `$where` `string` - $where Ignored Throws `RuntimeException` Overrides `FOFTable::move`
`public static`	# `create( array $data )` Create a new record with the provided data. It is inserted as the last child of the current node's parent Create a new record with the provided data. It is inserted as the last child of the current node's parent Parameters `$data` `array` - $data The data to use in the new record Returns `static` - The new node
`public FOFTableNested\|FOFTableNested`	# `copy( integer\|array $cid = null )` Makes a copy of the record, inserting it as the last child of the given node's parent. Makes a copy of the record, inserting it as the last child of the given node's parent. Parameters `$cid` `integer\|array` - $cid The primary key value (or values) or the record(s) to copy. If null, the current record will be copied Returns `FOFTableNested\|FOFTableNested` - The last copied node Overrides `FOFTable::copy`
`public`	# `reset( )` 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. 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. Overrides `FOFTable::reset`
`public FOFTableNested`	# `insertAsRoot( )` Insert the current node as a tree root. It is a good idea to never use this method, instead providing a root node in your schema installation and then sticking to only one root. Insert the current node as a tree root. It is a good idea to never use this method, instead providing a root node in your schema installation and then sticking to only one root. Returns `FOFTableNested`
`public mixed`	# `insertAsFirstChildOf( FOFTableNested & $parentNode )` Insert the current node as the first (leftmost) child of a parent node. Insert the current node as the first (leftmost) child of a parent node. WARNING: If it's an existing node it will be COPIED, not moved. Parameters `$parentNode` `FOFTableNested` - $parentNode The node which will become our parent Returns `mixed` - $this for chaining Throws `Exception` `RuntimeException`
`public mixed`	# `insertAsLastChildOf( FOFTableNested & $parentNode )` Insert the current node as the last (rightmost) child of a parent node. Insert the current node as the last (rightmost) child of a parent node. WARNING: If it's an existing node it will be COPIED, not moved. Parameters `$parentNode` `FOFTableNested` - $parentNode The node which will become our parent Returns `mixed` - $this for chaining Throws `Exception` `RuntimeException`
`public mixed`	# `insertAsChildOf( FOFTableNested & $parentNode )` Alias for insertAsLastchildOf Alias for insertAsLastchildOf Parameters `$parentNode` `FOFTableNested` - $parentNode Returns `mixed` - $this for chaining Throws `Exception` CodeCoverageIgnore
`public mixed`	# `insertLeftOf( FOFTableNested & $siblingNode )` Insert the current node to the left of (before) a sibling node Insert the current node to the left of (before) a sibling node WARNING: If it's an existing node it will be COPIED, not moved. Parameters `$siblingNode` `FOFTableNested` - $siblingNode We will be inserted before this node Returns `mixed` - $this for chaining Throws `Exception` `RuntimeException`
`public mixed`	# `insertRightOf( FOFTableNested & $siblingNode )` Insert the current node to the right of (after) a sibling node Insert the current node to the right of (after) a sibling node WARNING: If it's an existing node it will be COPIED, not moved. Parameters `$siblingNode` `FOFTableNested` - $siblingNode We will be inserted after this node Returns `mixed` - $this for chaining Throws `Exception` `RuntimeException`
`public mixed`	# `insertAsSiblingOf( FOFTableNested & $siblingNode )` Alias for insertRightOf Alias for insertRightOf Parameters `$siblingNode` `FOFTableNested` - $siblingNode Returns `mixed` - $this for chaining CodeCoverageIgnore
`public mixed`	# `moveLeft( )` Move the current node (and its subtree) one position to the left in the tree, i.e. before its left-hand sibling Move the current node (and its subtree) one position to the left in the tree, i.e. before its left-hand sibling Returns `mixed` - $this Throws `RuntimeException`
`public mixed`	# `moveRight( )` Move the current node (and its subtree) one position to the right in the tree, i.e. after its right-hand sibling Move the current node (and its subtree) one position to the right in the tree, i.e. after its right-hand sibling Returns `mixed` - $this Throws `RuntimeException`
`public mixed`	# `moveToLeftOf( FOFTableNested $siblingNode )` Moves the current node (and its subtree) to the left of another node. The other node can be in a different position in the tree or even under a different root. Moves the current node (and its subtree) to the left of another node. The other node can be in a different position in the tree or even under a different root. Parameters `$siblingNode` `FOFTableNested` - $siblingNode Returns `mixed` - $this for chaining Throws `Exception` `RuntimeException`
`public mixed`	# `moveToRightOf( FOFTableNested $siblingNode )` Moves the current node (and its subtree) to the right of another node. The other node can be in a different position in the tree or even under a different root. Moves the current node (and its subtree) to the right of another node. The other node can be in a different position in the tree or even under a different root. Parameters `$siblingNode` `FOFTableNested` - $siblingNode Returns `mixed` - $this for chaining Throws `Exception` `RuntimeException`
`public mixed`	# `makeNextSiblingOf( FOFTableNested $siblingNode )` Alias for moveToRightOf Alias for moveToRightOf Parameters `$siblingNode` `FOFTableNested` - $siblingNode Returns `mixed` - $this for chaining CodeCoverageIgnore
`public mixed`	# `makeSiblingOf( FOFTableNested $siblingNode )` Alias for makeNextSiblingOf Alias for makeNextSiblingOf Parameters `$siblingNode` `FOFTableNested` - $siblingNode Returns `mixed` - $this for chaining CodeCoverageIgnore
`public mixed`	# `makePreviousSiblingOf( FOFTableNested $siblingNode )` Alias for moveToLeftOf Alias for moveToLeftOf Parameters `$siblingNode` `FOFTableNested` - $siblingNode Returns `mixed` - $this for chaining CodeCoverageIgnore
`public mixed`	# `makeFirstChildOf( FOFTableNested $parentNode )` Moves a node and its subtree as a the first (leftmost) child of $parentNode Moves a node and its subtree as a the first (leftmost) child of $parentNode Parameters `$parentNode` `FOFTableNested` - $parentNode Returns `mixed` - $this for chaining Throws `Exception`
`public mixed`	# `makeLastChildOf( FOFTableNested $parentNode )` Moves a node and its subtree as a the last (rightmost) child of $parentNode Moves a node and its subtree as a the last (rightmost) child of $parentNode Parameters `$parentNode` `FOFTableNested` - $parentNode Returns `mixed` - $this for chaining Throws `Exception` `RuntimeException`
`public mixed`	# `makeChildOf( FOFTableNested $parentNode )` Alias for makeLastChildOf Alias for makeLastChildOf Parameters `$parentNode` `FOFTableNested` - $parentNode Returns `mixed` - $this for chaining CodeCoverageIgnore
`public mixed`	# `makeRoot( )` Makes the current node a root (and moving its entire subtree along the way). This is achieved by moving the node to the right of its root node Makes the current node a root (and moving its entire subtree along the way). This is achieved by moving the node to the right of its root node Returns `mixed` - $this for chaining
`public integer\|mixed`	# `getLevel( )` Gets the level (depth) of this node in the tree. The result is cached in $this->treeDepth for faster retrieval. Gets the level (depth) of this node in the tree. The result is cached in $this->treeDepth for faster retrieval. Returns `integer\|mixed` Throws `RuntimeException`
`public FOFTableNested`	# `getParent( )` Returns the immediate parent of the current node Returns the immediate parent of the current node Returns `FOFTableNested` Throws `RuntimeException`
`public boolean`	# `isRoot( )` Is this a top-level root node? Is this a top-level root node? Returns `boolean`
`public boolean`	# `isLeaf( )` Is this a leaf node (a node without children)? Is this a leaf node (a node without children)? Returns `boolean` Throws `RuntimeException`
`public boolean`	# `isChild( )` Is this a child node (not root)? Is this a child node (not root)? Returns `boolean` CodeCoverageIgnore
`public boolean`	# `isDescendantOf( FOFTableNested $otherNode )` Returns true if we are a descendant of $otherNode Returns true if we are a descendant of $otherNode Parameters `$otherNode` `FOFTableNested` - $otherNode Returns `boolean` Throws `RuntimeException`
`public boolean`	# `isSelfOrDescendantOf( FOFTableNested $otherNode )` Returns true if $otherNode is ourselves or if we are a descendant of $otherNode Returns true if $otherNode is ourselves or if we are a descendant of $otherNode Parameters `$otherNode` `FOFTableNested` - $otherNode Returns `boolean` Throws `RuntimeException`
`public boolean`	# `isAncestorOf( FOFTableNested $otherNode )` Returns true if we are an ancestor of $otherNode Returns true if we are an ancestor of $otherNode Parameters `$otherNode` `FOFTableNested` - $otherNode Returns `boolean` CodeCoverageIgnore
`public boolean`	# `isSelfOrAncestorOf( FOFTableNested $otherNode )` Returns true if $otherNode is ourselves or we are an ancestor of $otherNode Returns true if $otherNode is ourselves or we are an ancestor of $otherNode Parameters `$otherNode` `FOFTableNested` - $otherNode Returns `boolean` CodeCoverageIgnore
`public boolean`	# `equals( FOFTableNested & $node )` Is $node this very node? Is $node this very node? Parameters `$node` `FOFTableNested` - $node Returns `boolean` Throws `RuntimeException`
`public boolean`	# `insideSubtree( FOFTableNested $otherNode )` Alias for isDescendantOf Alias for isDescendantOf Parameters `$otherNode` `FOFTableNested` - $otherNode Returns `boolean` CodeCoverageIgnore
`public boolean`	# `inSameScope( FOFTableNested $otherNode )` Returns true if both this node and $otherNode are root, leaf or child (same tree scope) Returns true if both this node and $otherNode are root, leaf or child (same tree scope) Parameters `$otherNode` `FOFTableNested` - $otherNode Returns `boolean`
`protected`	# `scopeAncestorsAndSelf( )` get() will return all ancestor nodes and ourselves get() will return all ancestor nodes and ourselves
`protected`	# `scopeAncestors( )` get() will return all ancestor nodes but not ourselves get() will return all ancestor nodes but not ourselves
`protected`	# `scopeSiblingsAndSelf( )` get() will return all sibling nodes and ourselves get() will return all sibling nodes and ourselves
`protected`	# `scopeSiblings( )` get() will return all sibling nodes but not ourselves get() will return all sibling nodes but not ourselves CodeCoverageIgnore
`protected`	# `scopeLeaves( )` get() will return only leaf nodes get() will return only leaf nodes
`protected`	# `scopeDescendantsAndSelf( )` get() will return all descendants (even subtrees of subtrees!) and ourselves get() will return all descendants (even subtrees of subtrees!) and ourselves
`protected`	# `scopeDescendants( )` get() will return all descendants (even subtrees of subtrees!) but not ourselves get() will return all descendants (even subtrees of subtrees!) but not ourselves
`protected`	# `scopeImmediateDescendants( )` get() will only return immediate descendants (first level children) of the current node get() will only return immediate descendants (first level children) of the current node
`public`	# `withoutNode( FOFTableNested $node )` get() will not return the selected node if it's part of the query results get() will not return the selected node if it's part of the query results Parameters `$node` `FOFTableNested` - $node The node to exclude from the results
`protected`	# `scopeWithoutSelf( )` get() will not return ourselves if it's part of the query results get() will not return ourselves if it's part of the query results CodeCoverageIgnore
`protected`	# `scopeWithoutRoot( )` get() will not return our root if it's part of the query results get() will not return our root if it's part of the query results CodeCoverageIgnore
`public FOFTableNested`	# `getRoot( )` Returns the root node of the tree this node belongs to Returns the root node of the tree this node belongs to Returns `FOFTableNested` Throws `RuntimeException`
`public FOFDatabaseIterator`	# `getAncestorsAndSelf( )` Get all ancestors to this node and the node itself. In other words it gets the full path to the node and the node itself. Get all ancestors to this node and the node itself. In other words it gets the full path to the node and the node itself. Returns `FOFDatabaseIterator` CodeCoverageIgnore
`public FOFDatabaseIterator`	# `getAncestorsAndSelfWithoutRoot( )` Get all ancestors to this node and the node itself, but not the root node. If you want to Get all ancestors to this node and the node itself, but not the root node. If you want to Returns `FOFDatabaseIterator` CodeCoverageIgnore
`public FOFDatabaseIterator`	# `getAncestors( )` Get all ancestors to this node but not the node itself. In other words it gets the path to the node, without the node itself. Get all ancestors to this node but not the node itself. In other words it gets the path to the node, without the node itself. Returns `FOFDatabaseIterator` CodeCoverageIgnore
`public FOFDatabaseIterator`	# `getAncestorsWithoutRoot( )` Get all ancestors to this node but not the node itself and its root. Get all ancestors to this node but not the node itself and its root. Returns `FOFDatabaseIterator` CodeCoverageIgnore
`public FOFDatabaseIterator`	# `getSiblingsAndSelf( )` Get all sibling nodes, including ourselves Get all sibling nodes, including ourselves Returns `FOFDatabaseIterator` CodeCoverageIgnore
`public FOFDatabaseIterator`	# `getSiblings( )` Get all sibling nodes, except ourselves Get all sibling nodes, except ourselves Returns `FOFDatabaseIterator` CodeCoverageIgnore
`public FOFDatabaseIterator`	# `getLeaves( )` Get all leaf nodes in the tree. You may want to use the scopes to narrow down the search in a specific subtree or path. Get all leaf nodes in the tree. You may want to use the scopes to narrow down the search in a specific subtree or path. Returns `FOFDatabaseIterator` CodeCoverageIgnore
`public FOFDatabaseIterator`	# `getDescendantsAndSelf( )` Get all descendant (children) nodes and ourselves. Get all descendant (children) nodes and ourselves. Note: all descendant nodes, even descendants of our immediate descendants, will be returned. Returns `FOFDatabaseIterator` CodeCoverageIgnore
`public FOFDatabaseIterator`	# `getDescendants( )` Get only our descendant (children) nodes, not ourselves. Get only our descendant (children) nodes, not ourselves. Note: all descendant nodes, even descendants of our immediate descendants, will be returned. Returns `FOFDatabaseIterator` CodeCoverageIgnore
`public FOFDatabaseIterator`	# `getImmediateDescendants( )` Get the immediate descendants (children). Unlike getDescendants it only goes one level deep into the tree structure. Descendants of descendant nodes will not be returned. Get the immediate descendants (children). Unlike getDescendants it only goes one level deep into the tree structure. Descendants of descendant nodes will not be returned. Returns `FOFDatabaseIterator` CodeCoverageIgnore
`public array`	# `getNestedList( string $column = 'title', null $key = null, string $seperator = ' ' )` Returns a hashed array where each element's key is the value of the $key column (default: the ID column of the table) and its value is the value of the $column column (default: title). Each nesting level will have the value of the $column column prefixed by a number of $separator strings, as many as its nesting level (depth). Returns a hashed array where each element's key is the value of the $key column (default: the ID column of the table) and its value is the value of the $column column (default: title). Each nesting level will have the value of the $column column prefixed by a number of $separator strings, as many as its nesting level (depth). This is useful for creating HTML select elements showing the hierarchy in a human readable format. Parameters `$column` `string` - $column `$key` `null` - $key `$seperator` `string` - $seperator Returns `array`
`public FOFTableNested\|null`	# `findByPath( string $path )` Locate a node from a given path, e.g. "/some/other/leaf" Locate a node from a given path, e.g. "/some/other/leaf" Notes: This will only work when you have a "slug" and a "hash" field in your table. If the path starts with "/" we will use the root with lft=1. Otherwise the first component of the path is supposed to be the slug of the root node. If the root node is not found you'll get null as the return value You will also get null if any component of the path is not found Parameters `$path` `string` - $path The path to locate Returns `FOFTableNested\|null` - The found node or null if nothing is found
`public`	# `isValid( )`
`public`	# `rebuild( )`
`protected static`	# `resetTreeCache( )` Resets cached values used to speed up querying the tree Resets cached values used to speed up querying the tree Returns `static` - for chaining
`public mixed`	# `whereRaw( string $rawWhereClause )` Add custom, pre-compiled WHERE clauses for use in buildQuery. The raw WHERE clause you specify is added as is to the query generated by buildQuery. You are responsible for quoting and escaping the field names and data found inside the WHERE clause. Add custom, pre-compiled WHERE clauses for use in buildQuery. The raw WHERE clause you specify is added as is to the query generated by buildQuery. You are responsible for quoting and escaping the field names and data found inside the WHERE clause. Parameters `$rawWhereClause` `string` - $rawWhereClause The raw WHERE clause to add Returns `mixed` - $this For chaining
`protected FOFDatabaseQuery`	# `buildQuery( )` Builds the query for the get() method Builds the query for the get() method Returns `FOFDatabaseQuery`
`public FOFDatabaseIterator`	# `get( integer $limitstart = 0, integer $limit = 0 )` Returns a database iterator to retrieve records. Use the scope methods and the whereRaw method to define what exactly will be returned. Returns a database iterator to retrieve records. Use the scope methods and the whereRaw method to define what exactly will be returned. Parameters `$limitstart` `integer` - $limitstart How many items to skip from the start, only when $overrideLimits = true `$limit` `integer` - $limit How many items to return, only when $overrideLimits = true Returns `FOFDatabaseIterator` - The data collection Overrides `FOFUtilsObject::get`

Methods inherited from FOFTable

_lock(), _unlock(), addBehavior(), addIncludePath(), addKnownField(), bind(), canDelete(), checkContentType(), checkin(), checkout(), forceInstance(), getAnInstance(), getAsset(), getAssetKey(), getAssetName(), getAssetParentId(), getAssetTitle(), getCSVHeader(), getClone(), getColumnAlias(), getConfigProvider(), getConfigProviderKey(), getContentType(), getData(), getDbo(), getFields(), getId(), getInstance(), getKeyName(), getKnownFields(), getNextOrder(), getQueryJoin(), getQueryJoinFields(), getRelations(), getRules(), getTableAlias(), getTableFields(), getTableName(), getTriggerEvents(), getUcmCoreAlias(), hasField(), hasTags(), hit(), isAssetsTracked(), isCheckedOut(), isQuoted(), load(), normalizeSelectFields(), onAfterBind(), onAfterCopy(), onAfterHit(), onAfterLoad(), onAfterMove(), onAfterReorder(), onAfterReset(), onAfterStore(), onBeforeBind(), onBeforeCopy(), onBeforeDelete(), onBeforeHit(), onBeforeMove(), onBeforePublish(), onBeforeReorder(), onBeforeReset(), onBeforeStore(), publish(), removeKnownField(), save(), setAssetKey(), setAssetsTracked(), setColumnAlias(), setConfig(), setDBO(), setHasTags(), setInput(), setKnownFields(), setQueryJoin(), setRules(), setSkipChecks(), setTableAlias(), setTablePrefix(), setTriggerEvents(), store(), toCSV()

Methods inherited from FOFUtilsObject

__toString(), def(), getError(), getErrors(), getProperties(), set(), setError(), setProperties()

Magic methods summary

Properties summary

`protected integer`	`$treeDepth`	# The level (depth) of this node in the tree The level (depth) of this node in the tree
`protected FOFTableNested`	`$treeRoot`	# The root node in the tree The root node in the tree
`protected FOFTableNested`	`$treeParent`	# The parent node of ourselves The parent node of ourselves
`protected boolean`	`$treeNestedGet`	# Should I perform a nested get (used to query ascendants/descendants) Should I perform a nested get (used to query ascendants/descendants)
`protected array`	`$whereClauses`	# A collection of custom, additional where clauses to apply during buildQuery A collection of custom, additional where clauses to apply during buildQuery

Properties inherited from FOFTable

$_assetKey, $_autoChecks, $_columnAlias, $_configProviderKey, $_db, $_has_tags, $_includePaths, $_locked, $_queryJoin, $_relations, $_rules, $_skipChecks, $_tableAlias, $_tableExists, $_tablePrefix, $_tbl, $_tbl_key, $_trackAssets, $_trigger_events, $config, $configProvider, $contentType, $default_behaviors, $input, $instances, $knownFields, $tableCache, $tableDispatcher, $tableFieldCache

Properties inherited from FOFUtilsObject

$_errors

Magic properties

`public integer`	`$lft`	# Left value (for nested set implementation) Left value (for nested set implementation)
`public integer`	`$rgt`	# Right value (for nested set implementation) Right value (for nested set implementation)
`public string`	`$hash`	# Slug hash (optional; for faster searching) Slug hash (optional; for faster searching)
`public string`	`$slug`	# Node's slug (optional) Node's slug (optional)
`public string`	`$title`	# Title of the node (optional) Title of the node (optional)

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFTableNested

Methods summary

Parameters

Throws

Overrides

Returns

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Overrides

Parameters

Throws

Overrides

Parameters

Throws

Overrides

Parameters

Returns

Parameters

Returns

Overrides

Overrides

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

CodeCoverageIgnore

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

CodeCoverageIgnore

Returns

Throws

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

CodeCoverageIgnore

Parameters

Returns

CodeCoverageIgnore

Parameters

Returns

CodeCoverageIgnore

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

CodeCoverageIgnore