## Apache Zeta Components Manual :: Package TreeDatabaseTiein Element Index

## Element index for package TreeDatabaseTiein

#### Package indexes

- Document
- NoPackageName
- SystemInformation
- File
- UserInput
- PersistentObjectDatabaseSchemaTiein
- ConsoleTools
- Cache
- Database
- UnitTest
- Feed
- Base
- AuthenticationDatabaseTiein
- TemplateTranslationTiein
- MvcMailTiein
- MvcTools
- MvcTemplateTiein
- Reflection
- Authentication
- Execution
- TranslationCacheTiein
- Archive
- Url
- PhpGenerator
- WorkflowDatabaseTiein
- SignalSlot
- DatabaseSchema
- TreePersistentObjectTiein
- EventLog
- Tree
- Workflow
- ImageConversion
- PersistentObject
- Graph
- EventLogDatabaseTiein
- Translation
- WorkflowSignalSlotTiein
- Template
- Webdav
- Debug
- GraphDatabaseTiein
- MvcAuthenticationTiein
- MvcFeedTiein
- Mail
- ImageAnalysis
- Search
- Configuration
- WorkflowEventLogTiein

[ a ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ m ] [ n ] [ s ] [ u ] [ _ ]

### Letter '_'

__construct
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::__construct()
  Constructs a new ezcTreeDbMaterializedPath object.
__construct
  in file db_external.php, method ezcTreeDbExternalTableDataStore::__construct()
  Constructs a new storage backend that stores data in a table external from the node tree.
__construct
  in file db.php, method ezcTreeDb::__construct()
  Constructs a new ezcTreeDb object.

### Letter 'a'

addChild
  in file db_parent_child.php, method ezcTreeDbParentChild::addChild()
  Adds the node $childNode as child of the node with ID $parentId.
addChild
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::addChild()
  Adds the node $childNode as child of the node with ID $parentId.
addChild
  in file db_nested_set.php, method ezcTreeDbNestedSet::addChild()
  Adds the node $childNode as child of the node with ID $parentId.
addChildNodesBreadthFirst
  in file db_parent_child.php, method ezcTreeDbParentChild::addChildNodesBreadthFirst()
  Adds the children nodes of the node with ID $nodeId to the ezcTreeNodeList $list.
addChildNodesBreadthFirst
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::addChildNodesBreadthFirst()
  Adds the children nodes of the node with ID $nodeId to the ezcTreeNodeList $list.

### Letter 'c'

checkNodeId
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::checkNodeId()
  This method checks whether a node ID is valid to be used in a backend.
countChildNodes
  in file db_parent_child.php, method ezcTreeDbParentChild::countChildNodes()
  Adds the number of children with for the node with ID $nodeId nodes to $count, recursively.
create
  in file db_nested_set.php, method ezcTreeDbNestedSet::create()
  Creates a new ezcTreeDbNestedSet object.
create
  in file db_parent_child.php, method ezcTreeDbParentChild::create()
  Creates a new ezcTreeDbParentChild object.
create
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::create()
  Creates a new ezcTreeDbMaterializedPath object.
createAddEmptyNodeQuery
  in file db_parent_child.php, method ezcTreeDbParentChild::createAddEmptyNodeQuery()
  Creates the query to insert an empty node into the database, so that the last-inserted ID can be obtained.
createAddEmptyNodeQuery
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::createAddEmptyNodeQuery()
  Creates the query to insert an empty node into the database, so that the last-inserted ID can be obtained.
createAddEmptyNodeQuery
  in file db_nested_set.php, method ezcTreeDbNestedSet::createAddEmptyNodeQuery()
  Creates the query to insert an empty node into the database, so that the last-inserted ID can be obtained.
createAddEmptyNodeQuery
  in file db.php, method ezcTreeDb::createAddEmptyNodeQuery()
  Creates the query to insert an empty node into the database, so that the last-inserted ID can be obtained.
createAddNodeQuery
  in file db.php, method ezcTreeDb::createAddNodeQuery()
  Creates the query to insert/update an empty node in the database.

### Letter 'd'

$dbh
  in file db.php, variable ezcTreeDb::$dbh
  Contains the database connection handler.
$dom
  in file db_external.php, variable ezcTreeDbExternalTableDataStore::$dom
  Contains the DOM representing this tree this data store stores data for.
delete
  in file db_parent_child.php, method ezcTreeDbParentChild::delete()
  Deletes the node with ID $nodeId from the tree, including all its children.
delete
  in file db_nested_set.php, method ezcTreeDbNestedSet::delete()
  Deletes the node with ID $nodeId from the tree, including all its children.
delete
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::delete()
  Deletes the node with ID $nodeId from the tree, including all its children.
deleteDataForAllNodes
  in file db_external.php, method ezcTreeDbExternalTableDataStore::deleteDataForAllNodes()
  Deletes the data for all the nodes in the store.
deleteDataForNodes
  in file db_external.php, method ezcTreeDbExternalTableDataStore::deleteDataForNodes()
  Deletes the data for all the nodes in the node list $nodeList.
db.php
  procedural page db.php
db_materialized_path.php
  procedural page db_materialized_path.php
db_nested_set.php
  procedural page db_nested_set.php
db_parent_child.php
  procedural page db_parent_child.php
db.php
  procedural page db.php
db_external.php
  procedural page db_external.php

### Letter 'e'

ezcTreeDb
  in file db.php, class ezcTreeDb
  ezcTreeDb contains common methods for the different database tree backends.
ezcTreeDbDataStore
  in file db.php, class ezcTreeDbDataStore
  ezcTreeDbDataStore is an interface defining methods for database based data stores.
ezcTreeDbExternalTableDataStore
  in file db_external.php, class ezcTreeDbExternalTableDataStore
  ezcTreeDbExternalTableDataStore is an implementation of a tree node data store that uses an external table to store data in.
ezcTreeDbMaterializedPath
  in file db_materialized_path.php, class ezcTreeDbMaterializedPath
  ezcTreeDbMaterializedPath implements a tree backend which stores parent/child information in a path like string (such as /1/4/6/8).
ezcTreeDbNestedSet
  in file db_nested_set.php, class ezcTreeDbNestedSet
  ezcTreeDbNestedSet implements a tree backend which stores parent/child information with left and right values.
ezcTreeDbParentChild
  in file db_parent_child.php, class ezcTreeDbParentChild
  ezcTreeDbParentChild implements a tree backend which stores parent/child information in a simple table containing the node's ID and its parent's ID.

### Letter 'f'

fetchChildRecords
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::fetchChildRecords()
  Runs SQL to get all the children of the node with ID $nodeId as a PDO result set.
fetchChildRecords
  in file db_parent_child.php, method ezcTreeDbParentChild::fetchChildRecords()
  Runs SQL to get all the children of the node with ID $nodeId as a PDO result set.
fetchChildren
  in file db_parent_child.php, method ezcTreeDbParentChild::fetchChildren()
  Returns all the children of the node with ID $nodeId.
fetchChildren
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::fetchChildren()
  Returns all the children of the node with ID $nodeId.
fetchDataForNode
  in file db_external.php, method ezcTreeDbExternalTableDataStore::fetchDataForNode()
  Retrieves the data for the node $node from the data store and assigns it to the node's 'data' property.
fetchDataForNodes
  in file db_external.php, method ezcTreeDbExternalTableDataStore::fetchDataForNodes()
  This method *tries* to fetch the data for all the nodes in the node list $nodeList and assigns this data to the nodes' 'data' properties.
fetchNodeInformation
  in file db_nested_set.php, method ezcTreeDbNestedSet::fetchNodeInformation()
  Returns the left, right and width values for the node with ID $nodeId as an array.
fetchNodeInformation
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::fetchNodeInformation()
  Returns the parent id and path the node with ID $nodeId as an array.
fetchParent
  in file db.php, method ezcTreeDb::fetchParent()
  Returns the parent node of the node with ID $id.
fetchPath
  in file db_nested_set.php, method ezcTreeDbNestedSet::fetchPath()
  Returns all the nodes in the path from the root node to the node with ID $nodeId, including those two nodes.
fetchPath
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::fetchPath()
  Returns all the nodes in the path from the root node to the node with ID $nodeId, including those two nodes.
fetchPath
  in file db_parent_child.php, method ezcTreeDbParentChild::fetchPath()
  Returns all the nodes in the path from the root node to the node with ID $nodeId, including those two nodes.
fetchSubtree
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::fetchSubtree()
  Alias for fetchSubtreeDepthFirst().
fetchSubtree
  in file db_parent_child.php, method ezcTreeDbParentChild::fetchSubtree()
  Alias for fetchSubtreeDepthFirst().
fetchSubtreeBreadthFirst
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::fetchSubtreeBreadthFirst()
  Returns the node with ID $nodeId and all its children, sorted according to the Breadth-first sorting algorithm.
fetchSubtreeBreadthFirst
  in file db_parent_child.php, method ezcTreeDbParentChild::fetchSubtreeBreadthFirst()
  Returns the node with ID $nodeId and all its children, sorted according to the Breadth-first sorting algorithm.
fetchSubtreeDepthFirst
  in file db_parent_child.php, method ezcTreeDbParentChild::fetchSubtreeDepthFirst()
  Returns the node with ID $nodeId and all its children, sorted according to the Depth-first sorting algorithm.
fetchSubtreeDepthFirst
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::fetchSubtreeDepthFirst()
  Returns the node with ID $nodeId and all its children, sorted according to the Depth-first sorting algorithm.
fetchSubtreeDepthFirst
  in file db_nested_set.php, method ezcTreeDbNestedSet::fetchSubtreeDepthFirst()
  Returns the node with ID $nodeId and all its children, sorted according to the Depth-first sorting algorithm.
fixateTransaction
  in file db_parent_child.php, method ezcTreeDbParentChild::fixateTransaction()
  Fixates the transaction.
fixateTransaction
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::fixateTransaction()
  Fixates the transaction.

### Letter 'g'

generateNodeID
  in file db.php, method ezcTreeDb::generateNodeID()
  This method generates the next node ID.
getChildCount
  in file db_parent_child.php, method ezcTreeDbParentChild::getChildCount()
  Returns the number of direct children of the node with ID $nodeId.
getChildCount
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::getChildCount()
  Returns the number of direct children of the node with ID $nodeId.
getChildCountRecursive
  in file db_parent_child.php, method ezcTreeDbParentChild::getChildCountRecursive()
  Returns the number of children of the node with ID $nodeId, recursively.
getChildCountRecursive
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::getChildCountRecursive()
  Returns the number of children of the node with ID $nodeId, recursively.
getParentId
  in file db.php, method ezcTreeDb::getParentId()
  Returns the ID of parent of the node with ID $childId.
getPathLength
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::getPathLength()
  Returns the distance from the root node to the node with ID $nodeId.
getPathLength
  in file db_nested_set.php, method ezcTreeDbNestedSet::getPathLength()
  Returns the distance from the root node to the node with ID $nodeId.
getPathLength
  in file db_parent_child.php, method ezcTreeDbParentChild::getPathLength()
  Returns the distance from the root node to the node with ID $nodeId.
getRootNode
  in file db.php, method ezcTreeDb::getRootNode()
  Returns the root node.

### Letter 'h'

hasChildNodes
  in file db_parent_child.php, method ezcTreeDbParentChild::hasChildNodes()
  Returns whether the node with ID $nodeId has children.
hasChildNodes
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::hasChildNodes()
  Returns whether the node with ID $nodeId has children.

### Letter 'i'

$indexTableName
  in file db.php, variable ezcTreeDb::$indexTableName
  Contains the name of the table to retrieve the relational data from.
isChildOf
  in file db_parent_child.php, method ezcTreeDbParentChild::isChildOf()
  Returns whether the node with ID $childId is a direct child of the node with ID $parentId.
isChildOf
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::isChildOf()
  Returns whether the node with ID $childId is a direct child of the node with ID $parentId.
isDescendantOf
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::isDescendantOf()
  Returns whether the node with ID $childId is a direct or indirect child of the node with ID $parentId.
isDescendantOf
  in file db_nested_set.php, method ezcTreeDbNestedSet::isDescendantOf()
  Returns whether the node with ID $childId is a direct or indirect child of the node with ID $parentId.
isDescendantOf
  in file db_parent_child.php, method ezcTreeDbParentChild::isDescendantOf()
  Returns whether the node with ID $childId is a direct or indirect child of the node with ID $parentId.
isSiblingOf
  in file db_parent_child.php, method ezcTreeDbParentChild::isSiblingOf()
  Returns whether the nodes with IDs $child1Id and $child2Id are siblings (ie, they share the same parent).
isSiblingOf
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::isSiblingOf()
  Returns whether the nodes with IDs $child1Id and $child2Id are siblings (ie, they share the same parent).

### Letter 'm'

move
  in file db_parent_child.php, method ezcTreeDbParentChild::move()
  Moves the node with ID $nodeId as child to the node with ID $targetParentId.
move
  in file db_nested_set.php, method ezcTreeDbNestedSet::move()
  Moves the node with ID $nodeId as child to the node with ID $targetParentId.
move
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::move()
  Moves the node with ID $nodeId as child to the node with ID $targetParentId.

### Letter 'n'

nodeExists
  in file db.php, method ezcTreeDb::nodeExists()
  Returns whether the node with ID $id exists as tree node.

### Letter 's'

setDomTree
  in file db_external.php, method ezcTreeDbExternalTableDataStore::setDomTree()
  Associates the DOM tree for which this data store stores data for with this store.
setRootNode
  in file db_parent_child.php, method ezcTreeDbParentChild::setRootNode()
  Sets a new node as root node, this also wipes out the whole tree.
setRootNode
  in file db_nested_set.php, method ezcTreeDbNestedSet::setRootNode()
  Sets a new node as root node, this also wipes out the whole tree.
setRootNode
  in file db_materialized_path.php, method ezcTreeDbMaterializedPath::setRootNode()
  Sets a new node as root node, this also wipes out the whole tree.
storeDataForNode
  in file db_external.php, method ezcTreeDbExternalTableDataStore::storeDataForNode()
  Stores the data in the node to the data store.

### Letter 'u'

updateNestedValuesForSubtreeAddition
  in file db_nested_set.php, method ezcTreeDbNestedSet::updateNestedValuesForSubtreeAddition()
  Updates the left and right values of the nodes that are added while adding a whole subtree as child of a node.
updateNestedValuesForSubtreeDeletion
  in file db_nested_set.php, method ezcTreeDbNestedSet::updateNestedValuesForSubtreeDeletion()
  Updates the left and right values in case a subtree is deleted.

Documentation generated by phpDocumentor 1.4.3