ezcTreeXml is an implementation of a tree backend that operates on an XML file.
Example:
See ezcTree for examples on how to operate on the tree.
Source for this file: /Tree/src/backends/xml.php
ezcTree | --ezcTreeXml
Version: | //autogentag// |
relaxNG
= '<?xml version="1.0" encoding="UTF-8"?>
|
Contains the relax-NG schema to validate the tree XML. |
string | read/write |
$nodeClassName
Which class is used as tree node - this class *must* inherit the ezcTreeNode class. |
string | read |
$prefix
The prefix that is used to prefix node IDs with in the tree. |
ezcTreeXmlDataStore | read |
$store
The data store that is used for retrieving/storing data. |
From ezcTree | |
---|---|
protected |
ezcTree::$inTransaction
|
protected |
ezcTree::$inTransactionCommit
|
protected |
ezcTree::$properties
|
public static ezcTreeXml |
create(
$xmlFile
, $store
, [ $prefix
= 'id'] )
Creates a new XML tree in the file $xmlFile using $store as data store. |
public ezcTreeXml |
__construct(
$xmlFile
, $store
)
Constructs a new ezcTreeXml object from the XML data in $xmlFile and using the $store to retrieve data from. |
public void |
addChild(
$parentId
, $childNode
)
Adds the node $childNode as child of the node with ID $parentId. |
public void |
delete(
$nodeId
)
Deletes the node with ID $nodeId from the tree, including all its children. |
public ezcTreeNodeList |
fetchChildren(
$nodeId
)
Returns all the children of the node with ID $nodeId. |
public ezcTreeNode |
fetchParent(
$nodeId
)
Returns the parent node of the node with ID $nodeId. |
public ezcTreeNodeList |
fetchPath(
$nodeId
)
Returns all the nodes in the path from the root node to the node with ID $nodeId, including those two nodes. |
public ezcTreeNodeList |
fetchSubtree(
$nodeId
)
Alias for fetchSubtreeDepthFirst(). |
public ezcTreeNodeList |
fetchSubtreeBreadthFirst(
$nodeId
)
Returns the node with ID $nodeId and all its children, sorted according to the Breadth-first sorting algorithm. |
public ezcTreeNodeList |
fetchSubtreeDepthFirst(
$nodeId
)
Returns the node with ID $nodeId and all its children, sorted according to the Depth-first sorting algorithm. |
public void |
fixateTransaction(
)
Fixates the transaction (saves the XML file). |
protected integer |
generateNodeID(
)
This method generates the next node ID. |
public int |
getChildCount(
$nodeId
)
Returns the number of direct children of the node with ID $nodeId. |
public int |
getChildCountRecursive(
$nodeId
)
Returns the number of children of the node with ID $nodeId, recursively. |
public int |
getPathLength(
$nodeId
)
Returns the distance from the root node to the node with ID $nodeId. |
public ezcTreeNode |
getRootNode(
)
Returns the root node. |
public bool |
hasChildNodes(
$nodeId
)
Returns whether the node with ID $nodeId has children. |
public bool |
isChildOf(
$childId
, $parentId
)
Returns whether the node with ID $childId is a direct child of the node with ID $parentId. |
public bool |
isDescendantOf(
$childId
, $parentId
)
Returns whether the node with ID $childId is a direct or indirect child of the node with ID $parentId. |
public bool |
isSiblingOf(
$child1Id
, $child2Id
)
Returns whether the nodes with IDs $child1Id and $child2Id are siblings (ie, they share the same parent). |
public void |
move(
$nodeId
, $targetParentId
)
Moves the node with ID $nodeId as child to the node with ID $targetParentId. |
public bool |
nodeExists(
$nodeId
)
Returns whether the node with ID $nodeId exists. |
public void |
saveFile(
)
Saves the internal DOM representation of the tree back to disk. |
public void |
setRootNode(
$node
)
Sets a new node as root node, this also wipes out the whole tree. |
From ezcTree | |
---|---|
public void |
ezcTree::accept()
Implements the accept method for visiting. |
public abstract void |
ezcTree::addChild()
Adds the node $childNode as child of the node with ID $parentId. |
protected void |
ezcTree::addTransactionItem()
Adds a new transaction item to the list. |
public void |
ezcTree::beginTransaction()
Starts an transaction in which all tree modifications are queued until the transaction is committed with the commit() method. |
protected void |
ezcTree::checkNodeId()
This method checks whether a node ID is valid to be used in a backend. |
public void |
ezcTree::commit()
Commits the transaction by running the stored instructions to modify the tree structure. |
public static void |
ezcTree::copy()
Copies the tree in $from to the empty tree in $to. |
public ezcTreeNode |
ezcTree::createNode()
Creates a new tree node with node ID $nodeId and $data. |
public abstract void |
ezcTree::delete()
Deletes the node with ID $nodeId from the tree, including all its children. |
public abstract ezcTreeNodeList |
ezcTree::fetchChildren()
Returns all the children of the node with ID $nodeId. |
public ezcTreeNode |
ezcTree::fetchNodeById()
Returns the node identified by the ID $nodeId. |
public abstract ezcTreeNode |
ezcTree::fetchParent()
Returns the parent node of the node with ID $nodeId. |
public abstract ezcTreeNodeList |
ezcTree::fetchPath()
Returns all the nodes in the path from the root node to the node with ID $nodeId, including those two nodes. |
public abstract ezcTreeNodeList |
ezcTree::fetchSubtree()
Alias for fetchSubtreeDepthFirst(). |
public abstract ezcTreeNodeList |
ezcTree::fetchSubtreeBreadthFirst()
Returns the node with ID $nodeId and all its children, sorted according to the Breadth-first sorting algorithm. |
public abstract ezcTreeNodeList |
ezcTree::fetchSubtreeDepthFirst()
Returns the node with ID $nodeId and all its children, sorted according to the Depth-first sorting algorithm. |
protected abstract integer |
ezcTree::generateNodeID()
This method generates the next node ID. |
public abstract int |
ezcTree::getChildCount()
Returns the number of direct children of the node with ID $nodeId. |
public abstract int |
ezcTree::getChildCountRecursive()
Returns the number of children of the node with ID $nodeId, recursively. |
public abstract int |
ezcTree::getPathLength()
Returns the distance from the root node to the node with ID $nodeId. |
public abstract ezcTreeNode |
ezcTree::getRootNode()
Returns the root node. |
public abstract bool |
ezcTree::hasChildNodes()
Returns whether the node with ID $nodeId has children. |
public bool |
ezcTree::inTransaction()
Returns whether we are currently in a transaction or not |
public bool |
ezcTree::inTransactionCommit()
Returns whether we are currently in a transaction commit state or not |
public abstract bool |
ezcTree::isChildOf()
Returns whether the node with ID $childId is a direct child of the node with ID $parentId. |
public abstract bool |
ezcTree::isDescendantOf()
Returns whether the node with ID $childId is a direct or indirect child of the node with ID $parentId. |
public abstract bool |
ezcTree::isSiblingOf()
Returns whether the nodes with IDs $child1Id and $child2Id are siblings (ie, they share the same parent). |
public abstract void |
ezcTree::move()
Moves the node with ID $nodeId as child to the node with ID $targetParentId. |
public abstract bool |
ezcTree::nodeExists()
Returns whether the node with ID $nodeId exists. |
public void |
ezcTree::rollback()
Rolls back the transaction by clearing all stored instructions. |
public abstract void |
ezcTree::setRootNode()
Sets a new node as root node, this also wipes out the whole tree. |
Creates a new XML tree in the file $xmlFile using $store as data store.
The $prefix option can be used to change the prefix that is used for IDs in the created tree. By default this is set to "id" so that numerical node IDs are not a problem.
Name | Type | Description |
---|---|---|
$xmlFile |
string | |
$store |
ezcTreeXmlDataStore | |
$prefix |
string |
Constructs a new ezcTreeXml object from the XML data in $xmlFile and using the $store to retrieve data from.
Name | Type | Description |
---|---|---|
$xmlFile |
string | |
$store |
ezcTreeXmlDataStore |
Adds the node $childNode as child of the node with ID $parentId.
Name | Type | Description |
---|---|---|
$parentId |
string | |
$childNode |
ezcTreeNode |
Method | Description |
---|---|
ezcTree::addChild() |
Adds the node $childNode as child of the node with ID $parentId. |
Deletes the node with ID $nodeId from the tree, including all its children.
Name | Type | Description |
---|---|---|
$nodeId |
string |
Method | Description |
---|---|
ezcTree::delete() |
Deletes the node with ID $nodeId from the tree, including all its children. |
Returns all the children of the node with ID $nodeId.
Name | Type | Description |
---|---|---|
$nodeId |
string |
Method | Description |
---|---|
ezcTree::fetchChildren() |
Returns all the children of the node with ID $nodeId. |
Returns the parent node of the node with ID $nodeId.
This method returns null if there is no parent node.
Name | Type | Description |
---|---|---|
$nodeId |
string |
Method | Description |
---|---|
ezcTree::fetchParent() |
Returns the parent node of the node with ID $nodeId. |
Returns all the nodes in the path from the root node to the node with ID $nodeId, including those two nodes.
Name | Type | Description |
---|---|---|
$nodeId |
string |
Method | Description |
---|---|
ezcTree::fetchPath() |
Returns all the nodes in the path from the root node to the node with ID $nodeId, including those two nodes. |
Alias for fetchSubtreeDepthFirst().
Name | Type | Description |
---|---|---|
$nodeId |
string |
Method | Description |
---|---|
ezcTree::fetchSubtree() |
Alias for fetchSubtreeDepthFirst(). |
Returns the node with ID $nodeId and all its children, sorted according to the Breadth-first sorting algorithm.
Name | Type | Description |
---|---|---|
$nodeId |
string |
Method | Description |
---|---|
ezcTree::fetchSubtreeBreadthFirst() |
Returns the node with ID $nodeId and all its children, sorted according to the Breadth-first sorting algorithm. |
Returns the node with ID $nodeId and all its children, sorted according to the Depth-first sorting algorithm.
Name | Type | Description |
---|---|---|
$nodeId |
string |
Method | Description |
---|---|
ezcTree::fetchSubtreeDepthFirst() |
Returns the node with ID $nodeId and all its children, sorted according to the Depth-first sorting algorithm. |
Fixates the transaction (saves the XML file).
This method generates the next node ID.
It uses the stored last generated ID, and also stores this in an attribute on the root node so that it can be correctly incremented without having to search for the last generated ID in the whole tree.
Method | Description |
---|---|
ezcTree::generateNodeID() |
This method generates the next node ID. |
Returns the number of direct children of the node with ID $nodeId.
Name | Type | Description |
---|---|---|
$nodeId |
string |
Method | Description |
---|---|
ezcTree::getChildCount() |
Returns the number of direct children of the node with ID $nodeId. |
Returns the number of children of the node with ID $nodeId, recursively.
Name | Type | Description |
---|---|---|
$nodeId |
string |
Method | Description |
---|---|
ezcTree::getChildCountRecursive() |
Returns the number of children of the node with ID $nodeId, recursively. |
Returns the distance from the root node to the node with ID $nodeId.
Name | Type | Description |
---|---|---|
$nodeId |
string |
Method | Description |
---|---|
ezcTree::getPathLength() |
Returns the distance from the root node to the node with ID $nodeId. |
Returns the root node.
This methods returns null if there is no root node.
Method | Description |
---|---|
ezcTree::getRootNode() |
Returns the root node. |
Returns whether the node with ID $nodeId has children.
Name | Type | Description |
---|---|---|
$nodeId |
string |
Method | Description |
---|---|
ezcTree::hasChildNodes() |
Returns whether the node with ID $nodeId has children. |
Returns whether the node with ID $childId is a direct child of the node with ID $parentId.
Name | Type | Description |
---|---|---|
$childId |
string | |
$parentId |
string |
Method | Description |
---|---|
ezcTree::isChildOf() |
Returns whether the node with ID $childId is a direct child of the node with ID $parentId. |
Returns whether the node with ID $childId is a direct or indirect child of the node with ID $parentId.
Name | Type | Description |
---|---|---|
$childId |
string | |
$parentId |
string |
Method | Description |
---|---|
ezcTree::isDescendantOf() |
Returns whether the node with ID $childId is a direct or indirect child of the node with ID $parentId. |
Returns whether the nodes with IDs $child1Id and $child2Id are siblings (ie, they share the same parent).
Name | Type | Description |
---|---|---|
$child1Id |
string | |
$child2Id |
string |
Method | Description |
---|---|
ezcTree::isSiblingOf() |
Returns whether the nodes with IDs $child1Id and $child2Id are siblings (ie, they share the same parent). |
Moves the node with ID $nodeId as child to the node with ID $targetParentId.
Name | Type | Description |
---|---|---|
$nodeId |
string | |
$targetParentId |
string |
Method | Description |
---|---|
ezcTree::move() |
Moves the node with ID $nodeId as child to the node with ID $targetParentId. |
Returns whether the node with ID $nodeId exists.
Name | Type | Description |
---|---|---|
$nodeId |
string |
Method | Description |
---|---|
ezcTree::nodeExists() |
Returns whether the node with ID $nodeId exists. |
Saves the internal DOM representation of the tree back to disk.
Sets a new node as root node, this also wipes out the whole tree.
Name | Type | Description |
---|---|---|
$node |
ezcTreeNode |
Method | Description |
---|---|
ezcTree::setRootNode() |
Sets a new node as root node, this also wipes out the whole tree. |