combined hierarchical data docs(missing from TOC structure renaming)

manual/docs/Object relational mapping - Hierarchical data - Adjacency list - Introduction.php

-Not yet implemented
\ No newline at end of file
+Not yet implemented
+
+
+

manual/docs/Object relational mapping - Hierarchical data - Introduction - Node interface.php

 
 
-The node interface, for inserting and manipulating nodes within the tree, is accessed on a record level. A full implementation of this interface will be as follows:
\ No newline at end of file
+The node interface, for inserting and manipulating nodes within the tree, is accessed on a record level. A full implementation of this interface will be as follows:
+
+
+
+<code type="php">
+interface Doctrine_Node_Interface {
+
+    /**
+     * insert node into tree
+     */
+    public function insertAsParentOf(Doctrine_Record $dest);
+
+    public function insertAsPrevSiblingOf(Doctrine_Record $dest);
+
+    public function insertAsNextSiblingOf(Doctrine_Record $dest);
+
+    public function insertAsFirstChildOf(Doctrine_Record $dest);
+
+    public function insertAsLastChildOf(Doctrine_Record $dest);
+
+    public function addChild(Doctrine_Record $record);
+
+    /**
+     * moves node (if has children, moves branch)
+     *
+     */  
+    public function moveAsPrevSiblingOf(Doctrine_Record $dest);
+
+    public function moveAsNextSiblingOf(Doctrine_Record $dest);
+
+    public function moveAsFirstChildOf(Doctrine_Record $dest);
+
+    public function moveAsLastChildOf(Doctrine_Record $dest);
+
+    /**
+     * node information
+     */
+    public function getPrevSibling();
+
+    public function getNextSibling();
+
+    public function getSiblings($includeNode = false);
+
+    public function getFirstChild();
+
+    public function getLastChild();
+
+    public function getChildren();
+
+    public function getDescendants();
+
+    public function getParent();
+
+    public function getAncestors();
+
+    public function getPath($seperator = ' > ', $includeNode = false);
+
+    public function getLevel();
+
+    public function getNumberChildren();
+
+    public function getNumberDescendants();
+
+    /**
+     * node checks
+     */
+    public function hasPrevSibling();
+
+    public function hasNextSibling();
+
+    public function hasChildren();
+
+    public function hasParent();
+
+    public function isLeaf();
+
+    public function isRoot();
+
+    public function isEqualTo(Doctrine_Record $subj);
+
+    public function isDescendantOf(Doctrine_Record $subj);
+
+    public function isDescendantOfOrEqualTo(Doctrine_Record $subj);
+
+    public function isValidNode();
+
+    /**
+     * deletes node and it's descendants
+     */
+    public function delete();
+}
+
+// if your model acts as tree you can retrieve the associated node object as follows
+$record = $manager->getTable('Model')->find($pk);
+$nodeObj = $record->getNode();
+</code>
\ No newline at end of file

manual/docs/Object relational mapping - Hierarchical data - Introduction - Setting up.php

@@ -8,4 +8,30 @@ Now that Doctrine knows that this model acts as a tree, it will automatically ad
 
 
 
-Doctrine has standard interface's for managing tree's, that are used by all the implementations. Every record in the table represents a node within the tree (the table), so doctrine provides two interfaces, Tree and Node.
\ No newline at end of file
+Doctrine has standard interface's for managing tree's, that are used by all the implementations. Every record in the table represents a node within the tree (the table), so doctrine provides two interfaces, Tree and Node.
+
+
+
+<code type="php">
+class Menu extends Doctrine_Record { 
+    public function setTableDefinition() {
+
+        $this->setTableName('menu');
+
+        // add this your table definition to set the table as NestedSet tree implementation
+		// $implName is 'NestedSet' or 'AdjacencyList' or 'MaterializedPath'
+		// $options is an assoc array of options, see implementation docs for options
+        $this->option('treeImpl', $implName);
+        $this->option('treeOptions', $options);
+       
+        // you do not need to add any columns specific to the nested set implementation, these are added for you
+        $this->hasColumn("name","string",30);
+
+    }
+    
+    // this __toString() function is used to get the name for the path, see node::getPath()
+    public function __toString() {
+        return $this->get('name');
+    }
+}
+</code>
\ No newline at end of file

manual/docs/Object relational mapping - Hierarchical data - Introduction - Traversing or Walking Trees.php

@@ -4,4 +4,49 @@ You can traverse a Tree in different ways, please see here for more information
 
 
 
-The most common way of traversing a tree is Pre Order Traversal as explained in the link above, this is also what is known as walking the tree, this is the default approach when traversing a tree in Doctrine, however Doctrine does plan to provide support for Post and Level Order Traversal (not currently implemented)
\ No newline at end of file
+The most common way of traversing a tree is Pre Order Traversal as explained in the link above, this is also what is known as walking the tree, this is the default approach when traversing a tree in Doctrine, however Doctrine does plan to provide support for Post and Level Order Traversal (not currently implemented)
+
+
+
+<code type="php">
+/*
+ * traverse the entire tree from root
+ */
+$root = $manager->getTable('Model')->getTree()->fetchRoot();
+if($root->exists())
+{
+	$tree = $root->traverse();
+	while($node = $tree->next())
+	{
+		// output your tree here
+	}
+}
+
+// or the optimised approach using tree::fetchTree
+$tree = $manager->getTable('Model')->getTree()->fetchTree();
+while($node = $tree->next())
+{
+	// output tree here
+}
+
+/*
+ * traverse a branch of the tree
+ */
+$record = $manager->getTable('Model')->find($pk);
+if($record->exists())
+{
+	$branch = $record->traverse();
+	while($node = $branch->next())
+	{
+		// output your tree here
+	}
+}
+
+// or the optimised approach
+$branch = $manager->getTable('Model')->getTree()->fetchBranch($pk);
+while($node = $branch->traverse())
+{
+	// output your tree here
+}
+
+</code>
\ No newline at end of file

manual/docs/Object relational mapping - Hierarchical data - Introduction - Tree interface.php

 
 
-The tree interface, for creating and accessing the tree, is accessed on a table level. A full implementation of this interface would be as follows:
\ No newline at end of file
+The tree interface, for creating and accessing the tree, is accessed on a table level. A full implementation of this interface would be as follows:
+
+
+
+<code type="php">
+
+interface Doctrine_Tree_Interface {
+
+    /**
+     * creates root node from given record or from a new record
+     */
+    public function createRoot(Doctrine_Record $record = null);
+
+    /**
+     * returns root node
+     */
+    public function findRoot($root_id = 1);
+
+    /**
+     * optimised method to returns iterator for traversal of the entire tree from root
+     */
+    public function fetchTree($options = array());
+
+    /**
+     * optimised method that returns iterator for traversal of the tree from the given record's primary key
+     */
+    public function fetchBranch($pk, $options = array());
+}
+
+// if your model acts as tree you can retrieve the associated tree object as follows
+$treeObj = $manager->getTable('Model')->getTree();
+
+</code>
\ No newline at end of file

manual/docs/Object relational mapping - Hierarchical data - Introduction.php

+
+
+
+

manual/docs/Object relational mapping - Hierarchical data - Materialized path - Introduction.php

-Not yet implemented
\ No newline at end of file
+Not yet implemented
+
+
+

manual/docs/Object relational mapping - Hierarchical data - Nested set - Introduction.php

@@ -8,3 +8,7 @@ For more information, read here:
 
 [http://www.sitepoint.com/article/hierarchical-data-database/2 http://www.sitepoint.com/article/hierarchical-data-database/2],
 [http://dev.mysql.com/tech-resources/articles/hierarchical-data.html http://dev.mysql.com/tech-resources/articles/hierarchical-data.html]
+
+
+
+

manual/docs/Object relational mapping - Hierarchical data - Nested set - Setting up.php

 
 
-To set up your model as Nested Set, you must add the following code to your model's table definition.
\ No newline at end of file
+To set up your model as Nested Set, you must add the following code to your model's table definition.
+
+
+
+<code type="php">
+class Menu extends Doctrine_Record { 
+    public function setTableDefinition() {
+
+        $this->setTableName('menu');
+		
+        // add this your table definition to set the table as NestedSet tree implementation
+        $this->option('treeImpl', 'NestedSet');
+        $this->option('treeOptions', array());        
+       
+        // you do not need to add any columns specific to the nested set implementation, these are added for you
+        $this->hasColumn("name","string",30);
+
+    }
+    
+    // this __toString() function is used to get the name for the path, see node::getPath()
+    public function __toString() {
+        return $this->get('name');
+    }
+}
+</code>
\ No newline at end of file

manual/docs/Object relational mapping - Hierarchical data - Nested set - Tree options.php

@@ -4,4 +4,33 @@ The nested implementation can be configured to allow your table to have multiple
 
 
 
-The example below shows how to setup and use multiple roots based upon the set up above:
\ No newline at end of file
+The example below shows how to setup and use multiple roots based upon the set up above:
+
+
+
+<code type="php">
+//use these options in the setTableDefinition
+$options = array('hasManyRoots' => true,			// enable many roots
+	  			 'rootColumnName' => 'root_id');	// set root column name, defaults to 'root_id'
+
+// To create new root nodes, if you have manually set the root_id, then it will be used
+// otherwise it will automatically use the next available root id
+$root = new Menu();
+$root->set('name', 'root');
+
+// insert first root, will auto be assigned root_id = 1
+$manager->getTable('Menu')->getTree()->createRoot($root);
+
+$another_root = new Menu();
+$another_root->set('name', 'another root');
+
+// insert another root, will auto be assigned root_id = 2
+$manager->getTable('Menu')->getTree()->createRoot($another_root);
+
+// fetching a specifc root
+$root = $manager->getTable('Menu')->getTree()->fetchRoot(1);
+$another_root = $manager->getTable('Menu')->getTree()->fetchRoot(2);
+
+// fetching all roots
+$roots = $manager->getTable('Menu')->getTree()->fetchRoots();
+</code>