updated NestedSet to use Zend coding standards. still a few problems with...

updated NestedSet to use Zend coding standards.  still a few problems with return values using () that need to be looked at.

draft/Node.php

@@ -31,119 +31,127 @@
  */
 class Doctrine_Node implements IteratorAggregate
 {
-  /**
-   * @param object    $record   reference to associated Doctrine_Record instance
-   */
-  protected $record;
-
-  /**
-   * @param array     $options
-   */
-  protected $options;
-
-  /**
-   * @param string     $iteratorType  (Pre | Post | Level)
-   */
-  protected $iteratorType;
-
-  /**
-   * @param array     $iteratorOptions
-   */
-  protected $iteratorOptions;
-
-	/**
-	 * contructor, creates node with reference to record and any options
-	 *
-	 * @param object $record		instance of Doctrine_Record
-	 * @param array $options		options				
-	 */ 
-  public function __construct(&$record, $options)
-  {
-    $this->record = $record;
-    $this->options = $options;
-  }
-
-	/**
-	 * factory method to return node instance based upon chosen implementation
-	 *
-	 * @param object $record		instance of Doctrine_Record
-	 * @param string $impName		implementation (NestedSet, AdjacencyList, MaterializedPath)
-	 * @param array $options		options
-	 * @return object $options	instance of Doctrine_Node	 				
-	 */ 
-  public static function factory(&$record, $implName, $options = array()) {
-
-      $class = 'Doctrine_Node_'.$implName;
-
-      if(!class_exists($class))
-        throw new Doctrine_Node_Exception("The class $class must exist and extend Doctrine_Node");
-
-      return new $class($record, $options);
-  }
-
-	/**
-	 * setter for record attribute
-	 *
-	 * @param object $record		instance of Doctrine_Record				
-	 */ 
-  public function setRecord(&$record)
-  {
-    $this->record = $record;
-  }
-
-	/**
-	 * getter for record attribute
-	 *
-	 * @return object 		instance of Doctrine_Record				
-	 */   
-  public function getRecord() {
-    return $this->record;
-  }
-
-	/**
-	 * convenience function for getIterator
-	 *
-	 * @param string  $type   type of iterator (Pre | Post | Level)
-	 * @param array   $options  options			
-	 */ 
-  public function traverse($type = 'Pre', $options = array()) {
-    return $this->getIterator($type, $options);
-  }
-
-	/**
-	 * get iterator
-	 *
-	 * @param string  $type   type of iterator (Pre | Post | Level)
-	 * @param array   $options  options			
-	 */ 
-  public function getIterator($type = null, $options = null)
-  {
-		if ($type === null)
-			$type = (isset($this->iteratorType) ? $this->iteratorType : 'Pre');
-				
-		if ($options === null)
-			$options = (isset($this->iteratorOptions) ? $this->iteratorOptions : array());
-			
-		$iteratorClass = 'Doctrine_Node_'.$this->record->getTable()->getTreeImplName().'_'.ucfirst(strtolower($type)).'OrderIterator';
-		
-		return new $iteratorClass($this->record, $options);
-  }
-
-	/**
-	 * sets node's iterator type
-	 *
-	 * @param int			
-	 */  
-  public function setIteratorType($type) {
-    $this->iteratorType = $type;
-  }
-
-	/**
-	 * sets node's iterator options
-	 *
-	 * @param int			
-	 */  
-  public function setIteratorOptions($options) {
-    $this->iteratorOptions = $options;
-  }
-} // END class 
+    /**
+     * @param object    $record   reference to associated Doctrine_Record instance
+     */
+    protected $record;
+
+    /**
+     * @param array     $options
+     */
+    protected $options;
+
+    /**
+     * @param string     $iteratorType  (Pre | Post | Level)
+     */
+    protected $iteratorType;
+
+    /**
+     * @param array     $iteratorOptions
+     */
+    protected $iteratorOptions;
+
+    /**
+     * contructor, creates node with reference to record and any options
+     *
+     * @param object $record                    instance of Doctrine_Record
+     * @param array $options                    options
+     */
+    public function __construct(&$record, $options)
+    {
+        $this->record = $record;
+        $this->options = $options;
+    }
+
+    /**
+     * factory method to return node instance based upon chosen implementation
+     *
+     * @param object $record                    instance of Doctrine_Record
+     * @param string $impName                   implementation (NestedSet, AdjacencyList, MaterializedPath)
+     * @param array $options                    options
+     * @return object $options                  instance of Doctrine_Node
+     */
+    public static function factory(&$record, $implName, $options = array())
+    {
+        $class = 'Doctrine_Node_' . $implName;
+
+        if (!class_exists($class)) {
+            throw new Doctrine_Node_Exception("The class $class must exist and extend Doctrine_Node");
+        }
+
+        return new $class($record, $options);
+    }
+
+    /**
+     * setter for record attribute
+     *
+     * @param object $record                    instance of Doctrine_Record
+     */
+    public function setRecord(&$record)
+    {
+        $this->record = $record;
+    }
+
+    /**
+     * getter for record attribute
+     *
+     * @return object                           instance of Doctrine_Record
+     */
+    public function getRecord()
+    {
+        return $this->record;
+    }
+
+    /**
+     * convenience function for getIterator
+     *
+     * @param string $type                      type of iterator (Pre | Post | Level)
+     * @param array $options                    options
+     */
+    public function traverse($type = 'Pre', $options = array())
+    {
+        return $this->getIterator($type, $options);
+    }
+
+    /**
+     * get iterator
+     *
+     * @param string $type                      type of iterator (Pre | Post | Level)
+     * @param array $options                    options
+     */
+    public function getIterator($type = null, $options = null)
+    {
+        if ($type === null) {
+            $type = (isset($this->iteratorType) ? $this->iteratorType : 'Pre');
+        }
+
+        if ($options === null) {
+            $options = (isset($this->iteratorOptions) ? $this->iteratorOptions : array());
+        }
+
+        $implName = $this->record->getTable()->getTreeImplName();
+        $iteratorClass = 'Doctrine_Node_' . $implName . '_' . ucfirst(strtolower($type)) . 'OrderIterator';
+
+        return new $iteratorClass($this->record, $options);
+    }
+
+    /**
+     * sets node's iterator type
+     *
+     * @param int
+     */
+    public function setIteratorType($type)
+    {
+        $this->iteratorType = $type;
+    }
+
+    /**
+     * sets node's iterator options
\ No newline at end of file
+     *
+     * @param int
+     */
+    public function setIteratorOptions($options)
+    {
+        $this->iteratorOptions = $options;
+    }
+}

draft/Node/AdjacencyList.php

@@ -29,5 +29,6 @@
  * @version     $Revision$
  * @author      Joe Simms <joe.simms@websites4.com>
  */
-class Doctrine_Node_AdjacencyList extends Doctrine_Node implements Doctrine_Node_Interface { }
- 
+class Doctrine_Node_AdjacencyList extends Doctrine_Node implements Doctrine_Node_Interface
+{}
\ No newline at end of file
+

draft/Node/AdjacencyList/LevelOrderIterator.php

@@ -29,4 +29,5 @@
  * @version     $Revision$
  * @author      Joe Simms <joe.simms@websites4.com>
  */
-class Doctrine_Node_AdjacencyList_LevelOrderIterator implements Iterator {}
+class Doctrine_Node_AdjacencyList_LevelOrderIterator implements Iterator
+{}

draft/Node/AdjacencyList/PostOrderIterator.php

@@ -29,4 +29,5 @@
  * @version     $Revision$
  * @author      Joe Simms <joe.simms@websites4.com>
  */
-class Doctrine_Node_AdjacencyList_PostOrderIterator implements Iterator {}
+class Doctrine_Node_AdjacencyList_PostOrderIterator implements Iterator
+{}

draft/Node/AdjacencyList/PreOrderIterator.php

@@ -29,4 +29,5 @@
  * @version     $Revision$
  * @author      Joe Simms <joe.simms@websites4.com>
  */
-class Doctrine_Node_AdjacencyList_PreOrderIterator implements Iterator {}
+class Doctrine_Node_AdjacencyList_PreOrderIterator implements Iterator
+{}

draft/Node/Exception.php

@@ -29,4 +29,5 @@
  * @version     $Revision$
  * @author      Joe Simms <joe.simms@websites4.com>
  */
-class Doctrine_Node_Exception extends Doctrine_Exception { }
+class Doctrine_Node_Exception extends Doctrine_Exception
+{}

draft/Node/Interface.php

@@ -31,237 +31,237 @@
  */
 interface Doctrine_Node_Interface {
 
-	/**
-	 * test if node has previous sibling
-	 *
-	 * @return bool			
-	 */
-  public function hasPrevSibling();
-
-	/**
-	 * test if node has next sibling
-	 *
-	 * @return bool			
-	 */  
-  public function hasNextSibling();
-
-	/**
-	 * test if node has children
-	 *
-	 * @return bool			
-	 */ 
-  public function hasChildren();
-
-	/**
-	 * test if node has parent
-	 *
-	 * @return bool			
-	 */ 
-  public function hasParent();
-
-	/**
-	 * gets record of prev sibling or empty record
-	 *
-	 * @return object   Doctrine_Record			
-	 */
-  public function getPrevSibling();
-  
-	/**
-	 * gets record of next sibling or empty record
-	 *
-	 * @return object   Doctrine_Record			
-	 */
-  public function getNextSibling();
-  
-	/**
-	 * gets siblings for node
-	 *
-	 * @return array   array of sibling Doctrine_Record objects			
-	 */
-  public function getSiblings($includeNode = false);
-
-	/**
-	 * gets record of first child or empty record
-	 *
-	 * @return object   Doctrine_Record			
-	 */
-  public function getFirstChild();
-
-	/**
-	 * gets record of last child or empty record
-	 *
-	 * @return object   Doctrine_Record			
-	 */
-  public function getLastChild();
-
-	/**
-	 * gets children for node (direct descendants only)
-	 *
-	 * @return array   array of sibling Doctrine_Record objects				
-	 */
-  public function getChildren();
-
-	/**
-	 * gets descendants for node (direct descendants only)
-	 *
-	 * @return iterator   iterator to traverse descendants from node				
-	 */
-  public function getDescendants();
-
-	/**
-	 * gets record of parent or empty record
-	 *
-	 * @return object   Doctrine_Record			
-	 */
-  public function getParent();
-
-	/**
-	 * gets ancestors for node
-	 *
-	 * @return object   Doctrine_Collection				
-	 */
-  public function getAncestors();
-
-	/**
-	 * gets path to node from root, uses record::toString() method to get node names
-	 *
-	 * @param string   $seperator   path seperator
-	 * @param bool   $includeNode   whether or not to include node at end of path
-	 * @return string   string representation of path				
-	 */  
-  public function getPath($seperator = ' > ', $includeNode = false);
-
-	/**
-	 * gets level (depth) of node in the tree
-	 *
-	 * @return int			
-	 */ 
-  public function getLevel();
-
-	/**
-	 * gets number of children (direct descendants)
-	 *
-	 * @return int			
-	 */   
-  public function getNumberChildren();
-
-	/**
-	 * gets number of descendants (children and their children)
-	 *
-	 * @return int			
-	 */
-  public function getNumberDescendants();
-
-	/**
-	 * inserts node as parent of dest record
-	 *
-	 * @return bool			
-	 */
-  public function insertAsParentOf(Doctrine_Record $dest);
-
-	/**
-	 * inserts node as previous sibling of dest record
-	 *
-	 * @return bool			
-	 */
-  public function insertAsPrevSiblingOf(Doctrine_Record $dest);
-
-	/**
-	 * inserts node as next sibling of dest record
-	 *
-	 * @return bool			
-	 */
-  public function insertAsNextSiblingOf(Doctrine_Record $dest);
-
-	/**
-	 * inserts node as first child of dest record
-	 *
-	 * @return bool			
-	 */
-  public function insertAsFirstChildOf(Doctrine_Record $dest);
-
-	/**
-	 * inserts node as first child of dest record
-	 *
-	 * @return bool			
-	 */
-  public function insertAsLastChildOf(Doctrine_Record $dest);
-
-	/**
-	 * moves node as prev sibling of dest record
-	 *		
-	 */  
-  public function moveAsPrevSiblingOf(Doctrine_Record $dest);
-
-	/**
-	 * moves node as next sibling of dest record
-	 *		
-	 */
-  public function moveAsNextSiblingOf(Doctrine_Record $dest);
-
-	/**
-	 * moves node as first child of dest record
-	 *			
-	 */
-  public function moveAsFirstChildOf(Doctrine_Record $dest);
-
-	/**
-	 * moves node as last child of dest record
-	 *		
-	 */
-  public function moveAsLastChildOf(Doctrine_Record $dest);
-
-	/**
-	 * adds node as last child of record
-	 *		
-	 */
-  public function addChild(Doctrine_Record $record);
-
-	/**
-	 * determines if node is leaf
-	 *
-	 * @return bool			
-	 */
-  public function isLeaf();
-
-	/**
-	 * determines if node is root
-	 *
-	 * @return bool			
-	 */
-  public function isRoot();
-
-	/**
-	 * determines if node is equal to subject node
-	 *
-	 * @return bool			
-	 */
-  public function isEqualTo(Doctrine_Record $subj);
-
-	/**
-	 * determines if node is child of subject node
-	 *
-	 * @return bool			
-	 */
-  public function isDescendantOf(Doctrine_Record $subj);
-
-	/**
-	 * determines if node is child of or sibling to subject node
-	 *
-	 * @return bool			
-	 */
-  public function isDescendantOfOrEqualTo(Doctrine_Record $subj);
-
-	/**
-	 * determines if node is valid
-	 *
-	 * @return bool			
-	 */
-  public function isValidNode();
-
-	/**
-	 * deletes node and it's descendants
-	 *			
-	 */
-  public function delete();
-}
+    /**
+     * test if node has previous sibling
+     *
+     * @return bool
+     */
+    public function hasPrevSibling();
+
+    /**
+     * test if node has next sibling
+     *
+     * @return bool
+     */
+    public function hasNextSibling();
+
+    /**
+     * test if node has children
+     *
+     * @return bool
+     */
+    public function hasChildren();
+
+    /**
+     * test if node has parent
+     *
+     * @return bool
+     */
+    public function hasParent();
+
+    /**
+     * gets record of prev sibling or empty record
+     *
+     * @return object Doctrine_Record
+     */
+    public function getPrevSibling();
+
+    /**
+     * gets record of next sibling or empty record
+     *
+     * @return object Doctrine_Record
+     */
+    public function getNextSibling();
+
+    /**
+     * gets siblings for node
+     *
+     * @return array                            array of sibling Doctrine_Record objects
+     */
+    public function getSiblings($includeNode = false);
+
+    /**
+     * gets record of first child or empty record
+     *
+     * @return object Doctrine_Record
+     */
+    public function getFirstChild();
+
+    /**
+     * gets record of last child or empty record
+     *
+     * @return object Doctrine_Record
+     */
+    public function getLastChild();
+
+    /**
+     * gets children for node (direct descendants only)
+     *
+     * @return array                            array of sibling Doctrine_Record objects
+     */
+    public function getChildren();
+
+    /**
+     * gets descendants for node (direct descendants only)
+     *
+     * @return iterator                         iterator to traverse descendants from node
+     */
+    public function getDescendants();
+
+    /**
+     * gets record of parent or empty record
+     *
+     * @return object Doctrine_Record
+     */
+    public function getParent();
+
+    /**
+     * gets ancestors for node
+     *
+     * @return object Doctrine_Collection
+     */
+    public function getAncestors();
+
+    /**
+     * gets path to node from root, uses record::toString() method to get node names
+     *
+     * @param string $seperator                 path seperator
+     * @param bool $includeNode                 whether or not to include node at end of path
+     * @return string                           string representation of path
+     */
+    public function getPath($seperator = ' > ', $includeNode = false);
+
+    /**
+     * gets level (depth) of node in the tree
+     *
+     * @return int
+     */
+    public function getLevel();
+
+    /**
+     * gets number of children (direct descendants)
+     *
+     * @return int
+     */
+    public function getNumberChildren();
+
+    /**
+     * gets number of descendants (children and their children)
+     *
+     * @return int
+     */
+    public function getNumberDescendants();
+
+    /**
+     * inserts node as parent of dest record
+     *
+     * @return bool
+     */
+    public function insertAsParentOf(Doctrine_Record $dest);
+
+    /**
+     * inserts node as previous sibling of dest record
+     *
+     * @return bool
+     */
+    public function insertAsPrevSiblingOf(Doctrine_Record $dest);
+
+    /**
+     * inserts node as next sibling of dest record
+     *
+     * @return bool
+     */
+    public function insertAsNextSiblingOf(Doctrine_Record $dest);
+
+    /**
+     * inserts node as first child of dest record
+     *
+     * @return bool
+     */
+    public function insertAsFirstChildOf(Doctrine_Record $dest);
+
+    /**
+     * inserts node as first child of dest record
+     *
+     * @return bool
+     */
+    public function insertAsLastChildOf(Doctrine_Record $dest);
+
+    /**
+     * moves node as prev sibling of dest record
+     *
+     */  
+    public function moveAsPrevSiblingOf(Doctrine_Record $dest);
+
+    /**
+     * moves node as next sibling of dest record
+     *
+     */
+    public function moveAsNextSiblingOf(Doctrine_Record $dest);
+
+    /**
+     * moves node as first child of dest record
+     *
+     */
+    public function moveAsFirstChildOf(Doctrine_Record $dest);
+
+    /**
+     * moves node as last child of dest record
+     *
+     */
+    public function moveAsLastChildOf(Doctrine_Record $dest);
+
+    /**
+     * adds node as last child of record
+     *
+     */
+    public function addChild(Doctrine_Record $record);
+
+    /**
+     * determines if node is leaf
+     *
+     * @return bool
+     */
+    public function isLeaf();
+
+    /**
+     * determines if node is root
+     *
+     * @return bool
+     */
+    public function isRoot();
+
+    /**
+     * determines if node is equal to subject node
+     *
+     * @return bool
+     */
+    public function isEqualTo(Doctrine_Record $subj);
+
+    /**
+     * determines if node is child of subject node
+     *
+     * @return bool
+     */
+    public function isDescendantOf(Doctrine_Record $subj);
+
+    /**
+     * determines if node is child of or sibling to subject node
+     *
+     * @return bool
+     */
+    public function isDescendantOfOrEqualTo(Doctrine_Record $subj);
+
+    /**
+     * determines if node is valid
+     *
+     * @return bool
+     */
+    public function isValidNode();
+
+    /**
+     * deletes node and it's descendants
+     *
+     */
+    public function delete();
+}
\ No newline at end of file

draft/Node/MaterializedPath.php

@@ -29,5 +29,6 @@
  * @version     $Revision$
  * @author      Joe Simms <joe.simms@websites4.com>
  */
- class Doctrine_Node_MaterializedPath extends Doctrine_Node implements Doctrine_Node_Interface { }
- 
+class Doctrine_Node_MaterializedPath extends Doctrine_Node implements Doctrine_Node_Interface
+{}
\ No newline at end of file
+

draft/Node/MaterializedPath/LevelOrderIterator.php

@@ -32,30 +32,36 @@
 class Doctrine_Node_MaterializedPath_LevelOrderIterator implements Iterator
 {
     private $topNode = null;
-    
+
     private $curNode = null;
-    
-    public function __construct($node, $opts) {
+
+    public function __construct($node, $opts)
+    {
         throw new Doctrine_Exception('Not yet implemented');
     }
-    
-    public function rewind() {
+
+    public function rewind()
+    {
         throw new Doctrine_Exception('Not yet implemented');
     }
-    
-    public function valid() {
+
+    public function valid()
+    {
         throw new Doctrine_Exception('Not yet implemented');
     }
-    
-    public function current() {
+
+    public function current()
+    {
         throw new Doctrine_Exception('Not yet implemented');
     }
-    
-    public function key() {
+
+    public function key()
+    {
         throw new Doctrine_Exception('Not yet implemented');
     }
 
-    public function next() {
+    public function next()
+    {
         throw new Doctrine_Exception('Not yet implemented');
-    }  
+    }
 }

draft/Node/MaterializedPath/PostOrderIterator.php

@@ -32,30 +32,36 @@
 class Doctrine_Node_MaterializedPath_PostOrderIterator implements Iterator
 {
     private $topNode = null;
-    
+
     private $curNode = null;
-    
-    public function __construct($node, $opts) {
+
+    public function __construct($node, $opts)
+    {
         throw new Doctrine_Exception('Not yet implemented');
     }
-    
-    public function rewind() {
+
+    public function rewind()
+    {
         throw new Doctrine_Exception('Not yet implemented');
     }
-    
-    public function valid() {
+
+    public function valid()
+    {
         throw new Doctrine_Exception('Not yet implemented');
     }
-    
-    public function current() {
+
+    public function current()
+    {
         throw new Doctrine_Exception('Not yet implemented');
     }
-    
-    public function key() {
+
+    public function key()
+    {
         throw new Doctrine_Exception('Not yet implemented');
     }
 
-    public function next() {
+    public function next()
+    {
         throw new Doctrine_Exception('Not yet implemented');
-    }  
+    }
 }

draft/Node/MaterializedPath/PreOrderIterator.php

@@ -32,30 +32,36 @@
 class Doctrine_Node_MaterializedPath_PreOrderIterator implements Iterator
 {
     private $topNode = null;
-    
+
     private $curNode = null;
-    
-    public function __construct($node, $opts) {
+
+    public function __construct($node, $opts)
+    {
         throw new Doctrine_Exception('Not yet implemented');
     }
-    
-    public function rewind() {
+
+    public function rewind()
+    {
         throw new Doctrine_Exception('Not yet implemented');
     }
-    
-    public function valid() {
+
+    public function valid()
+    {
         throw new Doctrine_Exception('Not yet implemented');
     }
-    
-    public function current() {
+
+    public function current()
+    {
         throw new Doctrine_Exception('Not yet implemented');
     }
-    
-    public function key() {
+
+    public function key()
+    {
         throw new Doctrine_Exception('Not yet implemented');
     }
 
-    public function next() {
+    public function next()
+    {
         throw new Doctrine_Exception('Not yet implemented');
-    }  
+    }
 }

draft/Node/NestedSet.php

@@ -31,643 +31,654 @@
  */
 class Doctrine_Node_NestedSet extends Doctrine_Node implements Doctrine_Node_Interface
 {
-	/**
-	 * test if node has previous sibling
-	 *
-	 * @return bool			
-	 */
-  public function hasPrevSibling()
-  {
-    return $this->isValidNode($this->getPrevSibling());    
-  }
-
-	/**
-	 * test if node has next sibling
-	 *
-	 * @return bool			
-	 */ 
-  public function hasNextSibling()
-  {
-    return $this->isValidNode($this->getNextSibling());    
-  }
-
-	/**
-	 * test if node has children
-	 *
-	 * @return bool			
-	 */
-  public function hasChildren()
-  {
-    return (($this->getRightValue() - $this->getLeftValue() ) >1 );    
-  }
-
-	/**
-	 * test if node has parent
-	 *
-	 * @return bool			
-	 */
-  public function hasParent()
-  {
-    return !$this->isRoot();
-  }
-
-	/**
-	 * gets record of prev sibling or empty record
-	 *
-	 * @return object   Doctrine_Record			
-	 */
-  public function getPrevSibling()
-  {
-    $q = $this->record->getTable()->createQuery();
-    $result = $q->where('rgt = ?', $this->getLeftValue() - 1)->execute()->getFirst();
-
-		if(!$result)
-		   $result = $this->record->getTable()->create();
-		
-		return $result;  
-  }
-
-	/**
-	 * gets record of next sibling or empty record
-	 *
-	 * @return object   Doctrine_Record			
-	 */
-  public function getNextSibling()
-  {
-    $q = $this->record->getTable()->createQuery();
-    $result = $q->where('lft = ?', $this->getRightValue() + 1)->execute()->getFirst();
-
-		if(!$result)
-		   $result = $this->record->getTable()->create();
-		
-		return $result;
-  }
-
-	/**
-	 * gets siblings for node
-	 *
-	 * @return array   array of sibling Doctrine_Record objects			
-	 */
-  public function getSiblings($includeNode = false)
-  {
-    $parent = $this->getParent();
-    $siblings = array();
-    if($parent->exists())
-    {
-  		foreach($parent->getNode()->getChildren() as $child)
-  		{
-  		  if($this->isEqualTo($child) && !$includeNode)
-  		    continue;
-  		    
-  		  $siblings[] = $child;
-  		}      
-    }
-	
-		return $siblings;
-  }
-
-	/**
-	 * gets record of first child or empty record
-	 *
-	 * @return object   Doctrine_Record			
-	 */
-  public function getFirstChild()
-  {
-    $q = $this->record->getTable()->createQuery();
-    $result = $q->where('lft = ?', $this->getLeftValue() + 1)->execute()->getFirst();
-    
-		if(!$result)
-		   $result = $this->record->getTable()->create();
-		
-		return $result;    
-  }
-
-	/**
-	 * gets record of last child or empty record
-	 *
-	 * @return object   Doctrine_Record			
-	 */
-  public function getLastChild()
-  {
-    $q = $this->record->getTable()->createQuery();
-    $result = $q->where('rgt = ?', $this->getRightValue() - 1)->execute()->getFirst();
-
-		if(!$result)
-		   $result = $this->record->getTable()->create();
-		
-		return $result;   
-  }
-
-	/**
-	 * gets children for node (direct descendants only)
-	 *
-	 * @return array   array of sibling Doctrine_Record objects				
-	 */
-  public function getChildren()
-  { 
-    return $this->getIterator('Pre', array('depth' => 1));
-  }
-
-	/**
-	 * gets descendants for node (direct descendants only)
-	 *
-	 * @return iterator   iterator to traverse descendants from node				
-	 */
-  public function getDescendants()
-  {
-    return $this->getIterator();
-  }
-
-	/**
-	 * gets record of parent or empty record
-	 *
-	 * @return object   Doctrine_Record			
-	 */
-  public function getParent()
-  {
-    $q = $this->record->getTable()->createQuery();
-
-    $parent =   $q->where('lft < ? AND rgt > ?', array($this->getLeftValue(), $this->getRightValue()))
-                  ->orderBy('rgt asc')
-                  ->execute()
-                  ->getFirst();
-
-		if(!$parent)
-		   $parent = $this->record->getTable()->create();
-		
-		return $parent;
-  }
-
-	/**
-	 * gets ancestors for node
-	 *
-	 * @return object   Doctrine_Collection				
-	 */
-  public function getAncestors()
-  {
-    $q = $this->record->getTable()->createQuery();
-
-    $ancestors =  $q->where('lft < ? AND rgt > ?', array($this->getLeftValue(), $this->getRightValue()))
-                    ->orderBy('lft asc')
-                    ->execute();
-
-    return $ancestors;
-  }
-
-	/**
-	 * gets path to node from root, uses record::toString() method to get node names
-	 *
-	 * @param string   $seperator   path seperator
-	 * @param bool   $includeNode   whether or not to include node at end of path
-	 * @return string   string representation of path				
-	 */   
-  public function getPath($seperator = ' > ', $includeRecord = false)
-  {
-    $path = array();
-    $ancestors = $this->getAncestors();
-    foreach($ancestors as $ancestor)
-    {
-      $path[] = $ancestor->toString();
-    }
-    if($includeRecord)
-      $path[] = $this->getRecord()->toString();
-    
-    return implode($seperator, $path);
-  }
-
-	/**
-	 * gets number of children (direct descendants)
-	 *
-	 * @return int			
-	 */   
-  public function getNumberChildren()
-  {
-    $count = 0;
-    $children = $this->getChildren();
-  
-		while($children->next())
-		{
-		  $count++;
-		}
-		return $count; 
-  }
-
-	/**
-	 * gets number of descendants (children and their children)
-	 *
-	 * @return int			
-	 */
-  public function getNumberDescendants()
-  {
-    return ($this->getRightValue() - $this->getLeftValue() - 1) / 2;
-  }
-
-	/**
-	 * inserts node as parent of dest record
-	 *
-	 * @return bool			
-	 */
-  public function insertAsParentOf(Doctrine_Record $dest)
-  {
-    // cannot insert a node that has already has a place within the tree
-    if($this->isValidNode())
-      return false;
-    
-    // cannot insert as parent of root
-    if($dest->getNode()->isRoot())
-      return false;
-
-	  $this->shiftRLValues($dest->getNode()->getLeftValue(), 1);
-	  $this->shiftRLValues($dest->getNode()->getRightValue() + 2, 1);
-	  
-	  $newLeft = $dest->getNode()->getLeftValue();
-	  $newRight = $dest->getNode()->getRightValue()  + 2;
-	  $this->insertNode($newLeft, $newRight);
-    
-    return true;
-  }
-
-	/**
-	 * inserts node as previous sibling of dest record
-	 *
-	 * @return bool			
-	 */
-  public function insertAsPrevSiblingOf(Doctrine_Record $dest)
-  {
-    // cannot insert a node that has already has a place within the tree
-    if($this->isValidNode())
-      return false;
-
-		$newLeft = $dest->getNode()->getLeftValue();
-		$newRight = $dest->getNode()->getLeftValue() + 1;
-		
-		$this->shiftRLValues($newLeft, 2);
-		$this->insertNode($newLeft, $newRight);
-
-    // update destination left/right values to prevent a refresh
-    // $dest->getNode()->setLeftValue($dest->getNode()->getLeftValue() + 2);
-    // $dest->getNode()->setRightValue($dest->getNode()->getRightValue() + 2);
-            
-    return true;
-  }
-
-	/**
-	 * inserts node as next sibling of dest record
-	 *
-	 * @return bool			
-	 */  
-  public function insertAsNextSiblingOf(Doctrine_Record $dest)
-  {
-    // cannot insert a node that has already has a place within the tree
-    if($this->isValidNode())
-      return false;
-
-		$newLeft = $dest->getNode()->getRightValue() + 1;
-		$newRight = $dest->getNode()->getRightValue() + 2;
-
-		$this->shiftRLValues($newLeft, 2);
-		$this->insertNode($newLeft, $newRight);
-
-    // update destination left/right values to prevent a refresh
-    // no need, node not affected
-
-    return true;	
-  }
-
-	/**
-	 * inserts node as first child of dest record
-	 *
-	 * @return bool			
-	 */
-  public function insertAsFirstChildOf(Doctrine_Record $dest)
-  {
-    // cannot insert a node that has already has a place within the tree
-    if($this->isValidNode())
-      return false;
-
-		$newLeft = $dest->getNode()->getLeftValue() + 1;
-		$newRight = $dest->getNode()->getLeftValue() + 2;
-
-		$this->shiftRLValues($newLeft, 2);
-    $this->insertNode($newLeft, $newRight);
-    
-    // update destination left/right values to prevent a refresh
-    // $dest->getNode()->setRightValue($dest->getNode()->getRightValue() + 2);
-
-    return true;
-  }
-
-	/**
-	 * inserts node as last child of dest record
-	 *
-	 * @return bool			
-	 */
-  public function insertAsLastChildOf(Doctrine_Record $dest)
-  {
-    // cannot insert a node that has already has a place within the tree
-    if($this->isValidNode())
-      return false;
-
-		$newLeft = $dest->getNode()->getRightValue();
-		$newRight = $dest->getNode()->getRightValue() + 1;
-
-		$this->shiftRLValues($newLeft, 2);
-		$this->insertNode($newLeft, $newRight);
-
-    // update destination left/right values to prevent a refresh
-    // $dest->getNode()->setRightValue($dest->getNode()->getRightValue() + 2);
-    
-    return true;
-  }
-
-	/**
-	 * moves node as prev sibling of dest record
-	 *		
-	 */   
-  public function moveAsPrevSiblingOf(Doctrine_Record $dest)
-  {
-		$this->updateNode($dest->getNode()->getLeftValue());
-  }
-
-	/**
-	 * moves node as next sibling of dest record
-	 *		
-	 */
-  public function moveAsNextSiblingOf(Doctrine_Record $dest)
-  {
-		$this->updateNode($dest->getNode()->getRightValue() + 1);
-  }
-
-	/**
-	 * moves node as first child of dest record
-	 *			
-	 */
-  public function moveAsFirstChildOf(Doctrine_Record $dest)
-  {
-		$this->updateNode($dest->getNode()->getLeftValue() + 1);
-  }
-
-	/**
-	 * moves node as last child of dest record
-	 *		
-	 */
-  public function moveAsLastChildOf(Doctrine_Record $dest)
-  {
-		$this->updateNode($dest->getNode()->getRightValue());
-  }
-
-	/**
-	 * adds node as last child of record
-	 *		
-	 */
-  public function addChild(Doctrine_Record $record)
-  {
-    $record->getNode()->insertAsLastChildOf($this->getRecord());
-  }
-
-	/**
-	 * determines if node is leaf
-	 *
-	 * @return bool			
-	 */
-  public function isLeaf()
-  {
-    return (($this->getRightValue()-$this->getLeftValue())==1);   
-  }
-
-	/**
-	 * determines if node is root
-	 *
-	 * @return bool			
-	 */
-  public function isRoot()
-  {
-		return ($this->getLeftValue()==1);    
-  }
-
-	/**
-	 * determines if node is equal to subject node
-	 *
-	 * @return bool			
-	 */  
-  public function isEqualTo(Doctrine_Record $subj)
-  {
-    return (($this->getLeftValue()==$subj->getNode()->getLeftValue()) and ($this->getRightValue()==$subj->getNode()->getRightValue()));    
-  }
-
-	/**
-	 * determines if node is child of subject node
-	 *
-	 * @return bool			
-	 */
-  public function isDescendantOf(Doctrine_Record $subj)
-  {
-		return (($this->getLeftValue()>$subj->getNode()->getLeftValue()) and ($this->getRightValue()<$subj->getNode()->getRightValue()));    
-  }
-
-	/**
-	 * determines if node is child of or sibling to subject node
-	 *
-	 * @return bool			
-	 */
-  public function isDescendantOfOrEqualTo(Doctrine_Record $subj)
-  {
-		return (($this->getLeftValue()>=$subj->getNode()->getLeftValue()) and ($this->getRightValue()<=$subj->getNode()->getRightValue()));    
-  }
-
-	/**
-	 * determines if node is valid
-	 *
-	 * @return bool			
-	 */
-  public function isValidNode()
-  {
-    return ($this->getRightValue() > $this->getLeftValue());
-  }
-
-	/**
-	 * deletes node and it's descendants
-	 *			
-	 */
-  public function delete()
-  {
-    // TODO: add the setting whether or not to delete descendants or relocate children
-
-    $q = $this->record->getTable()->createQuery();
-    
-    $componentName = $this->record->getTable()->getComponentName();
-
-    $coll = $q->where("$componentName.lft >= ? AND $componentName.rgt <= ?", array($this->getLeftValue(), $this->getRightValue()))->execute();
-    $coll->delete();
-
-    $first = $this->getRightValue() + 1;
-    $delta = $this->getLeftValue() - $this->getRightValue() - 1;
-		$this->shiftRLValues($first, $delta);
-		
-		return true; 
-  }
-
-	/**
-	 * sets node's left and right values and save's it
-	 *
-	 * @param int   $destLeft   node left value
-	 * @param int	  $destRight  node right value
-	 */  
-  private function insertNode($destLeft = 0, $destRight = 0)
-  {
-		$this->setLeftValue($destLeft);
-		$this->setRightValue($destRight);
-		$this->record->save();  
-  }
-
-	/**
-	 * move node's and its children to location $destLeft and updates rest of tree
-	 *
-	 * @param int	 $destLeft  destination left value
-	 */
-  private function updateNode($destLeft)
-  { 
-		$left = $this->getLeftValue();
-		$right = $this->getRightValue();
-
-		$treeSize = $right - $left + 1;
-
-		$this->shiftRLValues($destLeft, $treeSize);
-
-		if($left >= $destLeft){ // src was shifted too?
-			$left += $treeSize;
-			$right += $treeSize;
-		}
-
-		// now there's enough room next to target to move the subtree
-		$this->shiftRLRange($left, $right, $destLeft - $left);
-
-		// correct values after source
-		$this->shiftRLValues($right + 1, -$treeSize);
-
-    $this->record->save();
-    $this->record->refresh();
-  }
-
-	/**
-	 * adds '$delta' to all Left and Right values that are >= '$first'. '$delta' can also be negative.
-	 *
-	 * @param int $first 		First node to be shifted
-	 * @param int $delta 		Value to be shifted by, can be negative
-	 */  
-  private function shiftRLValues($first, $delta)
-  {
-	  $qLeft = $this->record->getTable()->createQuery();
-	  $qRight = $this->record->getTable()->createQuery();
-
-	  // TODO: Wrap in transaction
-
-	  // shift left columns
-	  $resultLeft = $qLeft->update($this->record->getTable()->getComponentName())
-	              ->set('lft', "lft + $delta")
-	              ->where('lft >= ?', $first)
-	              ->execute();
-	  
-	  // shift right columns
-	  $resultRight = $qRight->update($this->record->getTable()->getComponentName())
-	              ->set('rgt', "rgt  + $delta")
-	              ->where('rgt >= ?', $first)
-	              ->execute();  
-  }
-
-	/**
-	 * adds '$delta' to all Left and Right values that are >= '$first' and <= '$last'. 
-	 * '$delta' can also be negative.
-	 *
-	 * @param int $first 	First node to be shifted (L value)
-	 * @param int $last 	Last node to be shifted (L value)
-	 * @param int $delta   	Value to be shifted by, can be negative
-	 */ 
-  private function shiftRLRange($first, $last, $delta)
-  {
-    $qLeft = $this->record->getTable()->createQuery();
-    $qRight = $this->record->getTable()->createQuery();
-    
-    // TODO : Wrap in transaction
-
-    // shift left column values
-    $result = $qLeft->update($this->record->getTable()->getComponentName())
-                ->set('lft', "lft + $delta")
-                ->where('lft >= ? AND lft <= ?', array($first, $last))
-                ->execute();
-    
-    // shift right column values
-    $result = $qRight->update($this->record->getTable()->getComponentName())
-                ->set('rgt', "rgt + $delta")
-                ->where('rgt >= ? AND rgt <= ?', array($first, $last))
-                ->execute();
-  }
-  
-	/**
-	 * gets record's left value
-	 *
-	 * @return int			
-	 */   
-  public function getLeftValue()
-  {
-    return $this->record->get('lft');
-  }
-
-	/**
-	 * sets record's left value
-	 *
-	 * @param int			
-	 */   
-  public function setLeftValue($lft)
-  {
-    $this->record->set('lft', $lft);    
-  }
-
-	/**
-	 * gets record's right value
-	 *
-	 * @return int			
-	 */   
-  public function getRightValue()
-  {
-    return $this->record->get('rgt');    
-  }
-
-	/**
-	 * sets record's right value
-	 *
-	 * @param int			
-	 */  
-  public function setRightValue($rgt)
-  {
-    $this->record->set('rgt', $rgt);     
-  }
-
-	/**
-	 * gets level (depth) of node in the tree
-	 *
-	 * @return int			
-	 */  
-  public function getLevel()
-  {
-    if(!isset($this->level))
-    {
-      $q = $this->record->getTable()->createQuery();
-      $coll = $q->where('lft < ? AND rgt > ?', array($this->getLeftValue(), $this->getRightValue()))
-                ->execute();
-      $this->level = $coll->count() ? $coll->count() : 0;
-    }
-
-    return $this->level;
-  }
-
-	/**
-	 * sets node's level
-	 *
-	 * @param int			
-	 */  
-  public function setLevel($level)
-  {
-    $this->level = $level;     
-  }
-}
+    /**
+     * test if node has previous sibling
+     *
+     * @return bool
+     */
+    public function hasPrevSibling()
+    {
+        return $this->isValidNode($this->getPrevSibling());
+    }
+
+    /**
+     * test if node has next sibling
+     *
+     * @return bool
+     */
+    public function hasNextSibling()
+    {
+        return $this->isValidNode($this->getNextSibling());
+    }
+
+    /**
+     * test if node has children
+     *
+     * @return bool
+     */
+    public function hasChildren()
+    {
+        return (($this->getRightValue() - $this->getLeftValue() ) >1);
+    }
+
+    /**
+     * test if node has parent
+     *
+     * @return bool
+     */
+    public function hasParent()
+    {
+        return !$this->isRoot();
+    }
+
+    /**
+     * gets record of prev sibling or empty record
+     *
+     * @return object Doctrine_Record
+     */
+    public function getPrevSibling()
+    {
+        $q = $this->record->getTable()->createQuery();
+        $result = $q->where('rgt = ?', $this->getLeftValue() - 1)->execute()->getFirst();
+
+        if (!$result) {
+            $result = $this->record->getTable()->create();
+        }
+
+        return $result;
+    }
+
+    /**
+     * gets record of next sibling or empty record
+     *
+     * @return object Doctrine_Record
+     */
+    public function getNextSibling()
+    {
+        $q = $this->record->getTable()->createQuery();
+        $result = $q->where('lft = ?', $this->getRightValue() + 1)->execute()->getFirst();
+
+        if (!$result) {
+             $result = $this->record->getTable()->create();
+        }
+
+        return $result;
+    }
+
+    /**
+     * gets siblings for node
+     *
+     * @return array                            array of sibling Doctrine_Record objects
+     */
+    public function getSiblings($includeNode = false)
+    {
+        $parent = $this->getParent();
+        $siblings = array();
+        if ($parent->exists()) {
+            foreach($parent->getNode()->getChildren() as $child) {
+                if ($this->isEqualTo($child) && !$includeNode) {
+                    continue;
+                }
+                $siblings[] = $child;
+            }
+        }
+
+        return $siblings;
+    }
+
+    /**
+     * gets record of first child or empty record
+     *
+     * @return object Doctrine_Record
+     */
+    public function getFirstChild()
+    {
+        $q = $this->record->getTable()->createQuery();
+        $result = $q->where('lft = ?', $this->getLeftValue() + 1)->execute()->getFirst();
+
+        if (!$result) {
+             $result = $this->record->getTable()->create();
+        }
+
+        return $result;
+    }
+
+    /**
+     * gets record of last child or empty record
+     *
+     * @return object Doctrine_Record
+     */
+    public function getLastChild()
+    {
+        $q = $this->record->getTable()->createQuery();
+        $result = $q->where('rgt = ?', $this->getRightValue() - 1)->execute()->getFirst();
+
+        if (!$result) {
+             $result = $this->record->getTable()->create();
+        }
+
+        return $result;
+    }
+
+    /**
+     * gets children for node (direct descendants only)
+     *
+     * @return array                            array of sibling Doctrine_Record objects
+     */
+    public function getChildren()
+    {
+        return $this->getIterator('Pre', array('depth' => 1));
+    }
+
+    /**
+     * gets descendants for node (direct descendants only)
+     *
+     * @return iterator                         iterator to traverse descendants from node
+     */
+    public function getDescendants()
+    {
+        return $this->getIterator();
+    }
+
+    /**
+     * gets record of parent or empty record
+     *
+     * @return object Doctrine_Record
+     */
+    public function getParent()
+    {
+        $q = $this->record->getTable()->createQuery();
+
+        $parent = $q->where('lft < ? AND rgt > ?', array($this->getLeftValue(), $this->getRightValue()))
+                    ->orderBy('rgt asc')
+                    ->execute()
+                    ->getFirst();
+
+        if (!$parent) {
+             $parent = $this->record->getTable()->create();
+        }
+
+        return $parent;
+    }
+
+    /**
+     * gets ancestors for node
+     *
+     * @return object Doctrine_Collection
+     */
+    public function getAncestors()
+    {
+        $q = $this->record->getTable()->createQuery();
+
+        $ancestors = $q->where('lft < ? AND rgt > ?', array($this->getLeftValue(), $this->getRightValue()))
+                       ->orderBy('lft asc')
+                       ->execute();
+
+        return $ancestors;
+    }
+
+    /**
+     * gets path to node from root, uses record::toString() method to get node names
+     *
+     * @param string $seperator                 path seperator
+     * @param bool $includeNode                 whether or not to include node at end of path
+     * @return string                           string representation of path
+     */
+    public function getPath($seperator = ' > ', $includeRecord = false)
+    {
+        $path = array();
+        $ancestors = $this->getAncestors();
+        foreach ($ancestors as $ancestor) {
+            $path[] = $ancestor->toString();
+        }
+        if ($includeRecord) {
+            $path[] = $this->getRecord()->toString();
+        }
+
+        return implode($seperator, $path);
+    }
+
+    /**
+     * gets number of children (direct descendants)
+     *
+     * @return int
+     */
+    public function getNumberChildren()
+    {
+        $count = 0;
+        $children = $this->getChildren();
+
+        while ($children->next()) {
+            $count++;
+        }
+        return $count;
+    }
+
+    /**
+     * gets number of descendants (children and their children)
+     *
+     * @return int
+     */
+    public function getNumberDescendants()
+    {
+        return ($this->getRightValue() - $this->getLeftValue() - 1) / 2;
+    }
+
+    /**
+     * inserts node as parent of dest record
+     *
+     * @return bool
+     */
+    public function insertAsParentOf(Doctrine_Record $dest)
+    {
+        // cannot insert a node that has already has a place within the tree
+        if ($this->isValidNode()) {
+            return false;
+        }
+
+        // cannot insert as parent of root
+        if ($dest->getNode()->isRoot()) {
+            return false;
+        }
+
+        $this->shiftRLValues($dest->getNode()->getLeftValue(), 1);
+        $this->shiftRLValues($dest->getNode()->getRightValue() + 2, 1);
+
+        $newLeft = $dest->getNode()->getLeftValue();
+        $newRight = $dest->getNode()->getRightValue() + 2;
+        $this->insertNode($newLeft, $newRight);
+
+        return true;
+    }
+
+    /**
+     * inserts node as previous sibling of dest record
+     *
+     * @return bool
+     */
+    public function insertAsPrevSiblingOf(Doctrine_Record $dest)
+    {
+        // cannot insert a node that has already has a place within the tree
+        if ($this->isValidNode()) {
+            return false;
+        }
+
+        $newLeft = $dest->getNode()->getLeftValue();
+        $newRight = $dest->getNode()->getLeftValue() + 1;
+
+        $this->shiftRLValues($newLeft, 2);
+        $this->insertNode($newLeft, $newRight);
+
+        // update destination left/right values to prevent a refresh
+        // $dest->getNode()->setLeftValue($dest->getNode()->getLeftValue() + 2);
+        // $dest->getNode()->setRightValue($dest->getNode()->getRightValue() + 2);
+
+        return true;
+    }
+
+    /**
+     * inserts node as next sibling of dest record
+     *
+     * @return bool
+     */
+    public function insertAsNextSiblingOf(Doctrine_Record $dest)
+    {
+        // cannot insert a node that has already has a place within the tree
+        if ($this->isValidNode()) {
+            return false;
+        }
+
+        $newLeft = $dest->getNode()->getRightValue() + 1;
+        $newRight = $dest->getNode()->getRightValue() + 2;
+
+        $this->shiftRLValues($newLeft, 2);
+        $this->insertNode($newLeft, $newRight);
+
+        // update destination left/right values to prevent a refresh
+        // no need, node not affected
+
+        return true;
+    }
+
+    /**
+     * inserts node as first child of dest record
+     *
+     * @return bool
+     */
+    public function insertAsFirstChildOf(Doctrine_Record $dest)
+    {
+        // cannot insert a node that has already has a place within the tree
+        if ($this->isValidNode()) {
+            return false;
+        }
+
+        $newLeft = $dest->getNode()->getLeftValue() + 1;
+        $newRight = $dest->getNode()->getLeftValue() + 2;
+
+        $this->shiftRLValues($newLeft, 2);
+        $this->insertNode($newLeft, $newRight);
+
+        // update destination left/right values to prevent a refresh
+        // $dest->getNode()->setRightValue($dest->getNode()->getRightValue() + 2);
+
+        return true;
+    }
+
+    /**
+     * inserts node as last child of dest record
+     *
+     * @return bool
+     */
+    public function insertAsLastChildOf(Doctrine_Record $dest)
+    {
+        // cannot insert a node that has already has a place within the tree
+        if ($this->isValidNode()) {
+            return false;
+        }
+
+        $newLeft = $dest->getNode()->getRightValue();
+        $newRight = $dest->getNode()->getRightValue() + 1;
+
+        $this->shiftRLValues($newLeft, 2);
+        $this->insertNode($newLeft, $newRight);
+
+        // update destination left/right values to prevent a refresh
+        // $dest->getNode()->setRightValue($dest->getNode()->getRightValue() + 2);
+
+        return true;
+    }
+
+    /**
+     * moves node as prev sibling of dest record
+     *
+     */
+    public function moveAsPrevSiblingOf(Doctrine_Record $dest)
+    {
+        $this->updateNode($dest->getNode()->getLeftValue());
+    }
+
+    /**
+     * moves node as next sibling of dest record
+     *
+     */
+    public function moveAsNextSiblingOf(Doctrine_Record $dest)
+    {
+        $this->updateNode($dest->getNode()->getRightValue() + 1);
+    }
+
+    /**
+     * moves node as first child of dest record
+     *
+     */
+    public function moveAsFirstChildOf(Doctrine_Record $dest)
+    {
+        $this->updateNode($dest->getNode()->getLeftValue() + 1);
+    }
+
+    /**
+     * moves node as last child of dest record
+     *
+     */
+    public function moveAsLastChildOf(Doctrine_Record $dest)
+    {
+        $this->updateNode($dest->getNode()->getRightValue());
+    }
+
+    /**
+     * adds node as last child of record
+     *
+     */
+    public function addChild(Doctrine_Record $record)
+    {
+        $record->getNode()->insertAsLastChildOf($this->getRecord());
+    }
+
+    /**
+     * determines if node is leaf
+     *
+     * @return bool
+     */
+    public function isLeaf()
+    {
+        return (($this->getRightValue() - $this->getLeftValue()) == 1);
+    }
+
+    /**
+     * determines if node is root
+     *
+     * @return bool
+     */
+    public function isRoot()
+    {
+        return ($this->getLeftValue() == 1);
+    }
+
+    /**
+     * determines if node is equal to subject node
+     *
+     * @return bool
+     */
+    public function isEqualTo(Doctrine_Record $subj)
+    {
+        // TODO: break this out to reduce line length <120 (Zend)
+        return (($this->getLeftValue()==$subj->getNode()->getLeftValue()) and ($this->getRightValue()==$subj->getNode()->getRightValue()));
+    }
+
+    /**
+     * determines if node is child of subject node
+     *
+     * @return bool
+     */
+    public function isDescendantOf(Doctrine_Record $subj)
+    {
+        // TODO: break this out to reduce line length <120 (Zend)
+        return (($this->getLeftValue()>$subj->getNode()->getLeftValue()) and ($this->getRightValue()<$subj->getNode()->getRightValue()));
+    }
+
+    /**
+     * determines if node is child of or sibling to subject node
+     *
+     * @return bool
+     */
+    public function isDescendantOfOrEqualTo(Doctrine_Record $subj)
+    {
+        // TODO: break this out to reduce line length <120 (Zend)
+        return (($this->getLeftValue()>=$subj->getNode()->getLeftValue()) and ($this->getRightValue()<=$subj->getNode()->getRightValue()));
+    }
+
+    /**
+     * determines if node is valid
+     *
+     * @return bool
+     */
+    public function isValidNode()
+    {
+        return ($this->getRightValue() > $this->getLeftValue());
+    }
+
+    /**
+     * deletes node and it's descendants
+     *
+     */
+    public function delete()
+    {
+        // TODO: add the setting whether or not to delete descendants or relocate children
+
+        $q = $this->record->getTable()->createQuery();
+
+        $componentName = $this->record->getTable()->getComponentName();
+
+        $params = array($this->getLeftValue(), $this->getRightValue());
+        $coll = $q->where("$componentName.lft >= ? AND $componentName.rgt <= ?", $params)->execute();
+        $coll->delete();
+
+        $first = $this->getRightValue() + 1;
+        $delta = $this->getLeftValue() - $this->getRightValue() - 1;
+        $this->shiftRLValues($first, $delta);
+
+        return true;
+    }
+
+    /**
+     * sets node's left and right values and save's it
+     *
+     * @param int $destLeft                     node left value
+     * @param int $destRight                    node right value
+     */
+    private function insertNode($destLeft = 0, $destRight = 0)
+    {
+        $this->setLeftValue($destLeft);
+        $this->setRightValue($destRight);
+        $this->record->save();
+    }
+
+    /**
+     * move node's and its children to location $destLeft and updates rest of tree
+     *
+     * @param int $destLeft                     destination left value
+     */
+    private function updateNode($destLeft)
+    {
+        $left = $this->getLeftValue();
+        $right = $this->getRightValue();
+
+        $treeSize = $right - $left + 1;
+
+        $this->shiftRLValues($destLeft, $treeSize);
+
+        if ($left >= $destLeft) { // src was shifted too?
+            $left += $treeSize;
+            $right += $treeSize;
+        }
+
+        // now there's enough room next to target to move the subtree
+        $this->shiftRLRange($left, $right, $destLeft - $left);
+
+        // correct values after source
+        $this->shiftRLValues($right + 1, -$treeSize);
+
+        $this->record->save();
+        $this->record->refresh();
+    }
+
+    /**
+     * adds '$delta' to all Left and Right values that are >= '$first'. '$delta' can also be negative.
+     *
+     * @param int $first                        first node to be shifted
+     * @param int $delta                        value to be shifted by, can be negative
+     */
+    private function shiftRLValues($first, $delta)
+    {
+        $qLeft = $this->record->getTable()->createQuery();
+        $qRight = $this->record->getTable()->createQuery();
+
+        // TODO: Wrap in transaction
+
+        // shift left columns
+        $resultLeft = $qLeft->update($this->record->getTable()->getComponentName())
+                            ->set('lft', "lft + $delta")
+                            ->where('lft >= ?', $first)
+                            ->execute();
+
+        // shift right columns
+        $resultRight = $qRight->update($this->record->getTable()->getComponentName())
+                              ->set('rgt', "rgt  + $delta")
+                              ->where('rgt >= ?', $first)
+                              ->execute();
+    }
+
+    /**
+     * adds '$delta' to all Left and Right values that are >= '$first' and <= '$last'.
+     * '$delta' can also be negative.
+     *
+     * @param int $first                        first node to be shifted (L value)
+     * @param int $last                         last node to be shifted (L value)
+     * @param int $delta                        value to be shifted by, can be negative
+     */
+    private function shiftRLRange($first, $last, $delta)
+    {
+        $qLeft = $this->record->getTable()->createQuery();
+        $qRight = $this->record->getTable()->createQuery();
+
+        // TODO : Wrap in transaction
+
+        // shift left column values
+        $result = $qLeft->update($this->record->getTable()->getComponentName())
+                        ->set('lft', "lft + $delta")
+                        ->where('lft >= ? AND lft <= ?', array($first, $last))
+                        ->execute();
+
+        // shift right column values
+        $result = $qRight->update($this->record->getTable()->getComponentName())
+                         ->set('rgt', "rgt + $delta")
+                         ->where('rgt >= ? AND rgt <= ?', array($first, $last))
+                         ->execute();
+    }
+
+    /**
+     * gets record's left value
+     *
+     * @return int
+     */
+    public function getLeftValue()
+    {
+        return $this->record->get('lft');
+    }
+
+    /**
+     * sets record's left value
+     *
+     * @param int
+     */
+    public function setLeftValue($lft)
+    {
+        $this->record->set('lft', $lft);
+    }
+
+    /**
+     * gets record's right value
+     *
+     * @return int
+     */
+    public function getRightValue()
+    {
+        return $this->record->get('rgt');
+    }
+
+    /**
+     * sets record's right value
+     *
+     * @param int
+     */
+    public function setRightValue($rgt)
+    {
+        $this->record->set('rgt', $rgt);
+    }
+
+    /**
+     * gets level (depth) of node in the tree
+     *
+     * @return int
+     */
+    public function getLevel()
+    {
+        if (!isset($this->level)) {
+            $q = $this->record->getTable()->createQuery();
+            $coll = $q->where('lft < ? AND rgt > ?', array($this->getLeftValue(), $this->getRightValue()))
+                      ->execute();
+            $this->level = $coll->count() ? $coll->count() : 0;
+        }
+
+        return $this->level;
+    }
\ No newline at end of file
+
+    /**
+     * sets node's level
+     *
+     * @param int
+     */
+    public function setLevel($level)
+    {
+        $this->level = $level;
+    }
+}

draft/Node/NestedSet/LevelOrderIterator.php

@@ -29,4 +29,5 @@
  * @version     $Revision$
  * @author      Joe Simms <joe.simms@websites4.com>
  */
-class Doctrine_Node_NestedSet_LevelOrderIterator implements Iterator {}
+class Doctrine_Node_NestedSet_LevelOrderIterator implements Iterator
+{}

draft/Node/NestedSet/PostOrderIterator.php

@@ -29,4 +29,5 @@
  * @version     $Revision$
  * @author      Joe Simms <joe.simms@websites4.com>
  */
-class Doctrine_Node_NestedSet_PostOrderIterator implements Iterator {}
+class Doctrine_Node_NestedSet_PostOrderIterator implements Iterator
+{}

draft/Node/NestedSet/PreOrderIterator.php

@@ -30,9 +30,9 @@
  * @author      Joe Simms <joe.simms@websites4.com>
  */
 class Doctrine_Node_NestedSet_PreOrderIterator implements Iterator
-{    
+{
     /**
-     * @var Doctrine_Collection $collection         
+     * @var Doctrine_Collection $collection
      */
     protected $collection;
     /**
@@ -59,34 +59,32 @@ class Doctrine_Node_NestedSet_PreOrderIterator implements Iterator
      * @var integer $count
      */
     protected $count;
-   
-    public function __construct($record, $opts) {
-
-      $componentName = $record->getTable()->getComponentName();
-            
-      $q = $record->getTable()->createQuery();
-
-      if(isset($opts['include_record']) && $opts['include_record'])
-      {
-          $query =  $q->where("$componentName.lft >= ? AND $componentName.rgt <= ?", array($record->get('lft'), $record->get('rgt')))->orderBy('lft asc');           
-      }
-      else
-      {
-          $query =  $q->where("$componentName.lft > ? AND $componentName.rgt < ?", array($record->get('lft'), $record->get('rgt')))->orderBy('lft asc');          
-      }
-
-      $this->maxLevel   = isset($opts['depth']) ? ($opts['depth'] + $record->getNode()->getLevel()) : 0;
-      $this->options    = $opts;
-      $this->collection = isset($opts['collection']) ? $opts['collection'] : $query->execute();
-      $this->keys       = $this->collection->getKeys();
-      $this->count      = $this->collection->count();
-      $this->index      = -1;
-      $this->level      = $record->getNode()->getLevel();
-      $this->prevLeft   = $record->getNode()->getLeftValue();
-      
-      echo $this->maxDepth;
-      // clear the table identity cache
-      $record->getTable()->clear();
+
+    public function __construct($record, $opts)
+    {
+        $componentName = $record->getTable()->getComponentName();
+
+        $q = $record->getTable()->createQuery();
+
+        $params = array($record->get('lft'), $record->get('rgt'));
+        if (isset($opts['include_record']) && $opts['include_record']) {
+            $query = $q->where("$componentName.lft >= ? AND $componentName.rgt <= ?", $params)->orderBy('lft asc');
+        } else {
+            $query = $q->where("$componentName.lft > ? AND $componentName.rgt < ?", $params)->orderBy('lft asc');
+        }
+
+        $this->maxLevel   = isset($opts['depth']) ? ($opts['depth'] + $record->getNode()->getLevel()) : 0;
+        $this->options    = $opts;
+        $this->collection = isset($opts['collection']) ? $opts['collection'] : $query->execute();
+        $this->keys       = $this->collection->getKeys();
+        $this->count      = $this->collection->count();
+        $this->index      = -1;
+        $this->level      = $record->getNode()->getLevel();
+        $this->prevLeft   = $record->getNode()->getLeftValue();
+
+        echo $this->maxDepth;
+        // clear the table identity cache
+        $record->getTable()->clear();
     }
 
     /**
@@ -94,7 +92,8 @@ class Doctrine_Node_NestedSet_PreOrderIterator implements Iterator
      *
      * @return void
      */
-    public function rewind() {
+    public function rewind()
+    {
         $this->index = -1;
         $this->key = null;
     }
@@ -104,66 +103,73 @@ class Doctrine_Node_NestedSet_PreOrderIterator implements Iterator
      *
      * @return integer
      */
-    public function key() {
+    public function key()
+    {
         return $this->key;
     }
+
     /**
      * returns the current record
      *
      * @return Doctrine_Record
      */
-    public function current() {
+    public function current()
+    {
         $record = $this->collection->get($this->key);
         $record->getNode()->setLevel($this->level);
         return $record;
     }
+
     /**
      * advances the internal pointer
      *
      * @return void
      */
-    public function next() {
-      while($current = $this->advanceIndex())
-      {
-        if($this->maxLevel && ($this->level > $this->maxLevel))
-          continue;          
- 
-        return $current;
-      }
-      
-      return false;
+    public function next()
+    {
+        while ($current = $this->advanceIndex()) {
+            if ($this->maxLevel && ($this->level > $this->maxLevel)) {
+                continue;
+            }
+
+            return $current;
+        }
+
+        return false;
     }
 
     /**
-     * @return boolean          whether or not the iteration will continue
+     * @return boolean                          whether or not the iteration will continue
      */
-    public function valid() {
+    public function valid()
+    {
         return ($this->index < $this->count);
     }
-    
-    public function count() {
+
+    public function count()
+    {
         return $this->count;
     }
-    
-    private function updateLevel() {
-        if(!(isset($this->options['include_record']) && $this->options['include_record'] && $this->index == 0))
-        {
-          $left = $this->collection->get($this->key)->getNode()->getLeftValue();
-          $this->level += $this->prevLeft - $left + 2;
-          $this->prevLeft = $left;           
+
+    private function updateLevel()
+    {
+        if (!(isset($this->options['include_record']) && $this->options['include_record'] && $this->index == 0)) {
+            $left = $this->collection->get($this->key)->getNode()->getLeftValue();
+            $this->level += $this->prevLeft - $left + 2;
+            $this->prevLeft = $left;
         }
     }
-    
-    private function advanceIndex() {
+
+    private function advanceIndex()
+    {
         $this->index++;
         $i = $this->index;
-        if(isset($this->keys[$i]))
-        {
+        if (isset($this->keys[$i])) {
             $this->key   = $this->keys[$i];
             $this->updateLevel();
-            return $this->current();          
+            return $this->current();
         }
 
-        return false;      
-    } 
+        return false;
+    }
 }

draft/Tree.php

@@ -29,61 +29,63 @@
  * @version     $Revision$
  * @author      Joe Simms <joe.simms@websites4.com>
  */
-class Doctrine_Tree 
+class Doctrine_Tree
 {
-  /**
-   * @param object $table   reference to associated Doctrine_Table instance
-   */
-  protected $table;
-  
-  /**
-   * @param array $options
-   */
-  protected $options; 
+    /**
+     * @param object $table   reference to associated Doctrine_Table instance
+     */
+    protected $table;
 
-	/**
-	 * contructor, creates tree with reference to table and any options
-	 *
-	 * @param object $table		instance of Doctrine_Table
-	 * @param array $options		options				
-	 */ 
-  public function __construct($table, $options)
-  {
-    $this->table = $table;
-    $this->options = $options;
-  }
+    /**
+     * @param array $options
+     */
+    protected $options;
 
-	/**
-	 * Used to define table attributes required for the given implementation
-	 *			
-	 */ 
-  public function setTableDefinition()
-  {
-      throw new Doctrine_Tree_Exception('Table attributes have not been defined for this Tree implementation.');      
-  }
+    /**
+     * constructor, creates tree with reference to table and any options
+     *
+     * @param object $table                     instance of Doctrine_Table
+     * @param array $options                    options
+     */
+    public function __construct($table, $options)
+    {
+        $this->table = $table;
+        $this->options = $options;
+    }
 
-	/**
-   * this method is used for setting up relations and attributes and should be used by specific implementations
-	 *			
-	 */ 
-  public function setUp()
-  {
-      
-  }
+    /**
+     * Used to define table attributes required for the given implementation
+     *
+     * @throws Doctrine_Tree_Exception          if table attributes have not been defined
+     */
+    public function setTableDefinition()
+    {
+        throw new Doctrine_Tree_Exception('Table attributes have not been defined for this Tree implementation.');
+    }
 
-	/**
-	 * factory method to return tree instance based upon chosen implementation
-	 *
-	 * @param object $table		  instance of Doctrine_Table
-	 * @param string $impName		implementation (NestedSet, AdjacencyList, MaterializedPath)
-	 * @param array $options		options
-	 * @return object $options	instance of Doctrine_Node	 				
-	 */   
-  public static function factory( &$table, $implName, $options = array())
-  {
-    $class = 'Doctrine_Tree_'.$implName;
-    if(!class_exists($class))
-      throw new Doctrine_Exception('The chosen class must extend Doctrine_Tree');
-    return new $class($table, $options);
-  }
-} // END class 
+    /**
+     * this method is used for setting up relations and attributes and should be used by specific implementations
+     *
+     */
+    public function setUp()
+    {
+    }
+
+    /**
+     * factory method to return tree instance based upon chosen implementation
+     *
+     * @param object $table                     instance of Doctrine_Table
+     * @param string $impName                   implementation (NestedSet, AdjacencyList, MaterializedPath)
+     * @param array $options                    options
+     * @return object $options                  instance of Doctrine_Node
+     * @throws Doctrine_Exception               if class does not extend Doctrine_Tree
\ No newline at end of file
+     */
+    public static function factory(&$table, $implName, $options = array())
+    {
+        $class = 'Doctrine_Tree_' . $implName;
+        if (!class_exists($class)) {
+            throw new Doctrine_Exception('The chosen class must extend Doctrine_Tree');
+        }
+        return new $class($table, $options);
+    }
+}

draft/Tree/AdjacencyList.php

@@ -29,4 +29,5 @@
  * @version     $Revision$
  * @author      Joe Simms <joe.simms@websites4.com>
  */
-class Doctrine_Tree_AdjacencyList extends Doctrine_Tree implements Doctrine_Tree_Interface { }
+class Doctrine_Tree_AdjacencyList extends Doctrine_Tree implements Doctrine_Tree_Interface
+{}

draft/Tree/Exception.php

@@ -29,4 +29,5 @@
  * @version     $Revision$
  * @author      Konsta Vesterinen <kvesteri@cc.hut.fi>
  */
-class Doctrine_Tree_Exception extends Doctrine_Exception { }
+class Doctrine_Tree_Exception extends Doctrine_Exception
+{}

draft/Tree/Interface.php

@@ -31,34 +31,34 @@
  */
 interface Doctrine_Tree_Interface {
 
-	/**
-	 * creates root node from given record or from a new record
-	 *
-	 * @param object $record		instance of Doctrine_Record				
-	 */
-  public function createRoot(Doctrine_Record $record = null);
+    /**
+     * creates root node from given record or from a new record
+     *
+     * @param object $record                    instance of Doctrine_Record
+     */
+    public function createRoot(Doctrine_Record $record = null);
 
-	/**
-	 * returns root node
-	 *
-	 * @return object $record		instance of Doctrine_Record				
-	 */
-  public function findRoot();
+    /**
+     * returns root node
+     *
+     * @return object $record                   instance of Doctrine_Record
+     */
+    public function findRoot();
 
-	/**
-	 * optimised method to returns iterator for traversal of the entire tree from root
-	 * 
-	 * @param array $options		  options		
-	 * @return object $iterator		instance of Doctrine_Node_<Implementation>_PreOrderIterator			
-	 */
-  public function fetchTree($options = array());
+    /**
+     * optimised method to returns iterator for traversal of the entire tree from root
+     *
+     * @param array $options                    options
+     * @return object $iterator                 instance of Doctrine_Node_<Implementation>_PreOrderIterator
+     */
+    public function fetchTree($options = array());
 
-	/**
-	 * optimised method that returns iterator for traversal of the tree from the given record primary key
-	 * 
-	 * @param mixed $pk		        primary key as used by table::find() to locate node to traverse tree from
-	 * @param array $options		  options		
-	 * @return iterator		instance of Doctrine_Node_<Implementation>_PreOrderIterator					
-	 */
-  public function fetchBranch($pk, $options = array());
-}
+    /**
+     * optimised method that returns iterator for traversal of the tree from the given record primary key
+     *
+     * @param mixed $pk                         primary key as used by table::find() to locate node to traverse tree from
+     * @param array $options                    options
+     * @return iterator                         instance of Doctrine_Node_<Implementation>_PreOrderIterator
+     */
+    public function fetchBranch($pk, $options = array());
+}
\ No newline at end of file

draft/Tree/MaterializedPath.php

@@ -29,4 +29,5 @@
  * @version     $Revision$
  * @author      Joe Simms <joe.simms@websites4.com>
  */
-class Doctrine_Tree_MaterializedPath extends Doctrine_Tree implements Doctrine_Tree_Interface { }
+class Doctrine_Tree_MaterializedPath extends Doctrine_Tree implements Doctrine_Tree_Interface
\ No newline at end of file
+{}

draft/Tree/NestedSet.php

@@ -31,113 +31,114 @@
  */
 class Doctrine_Tree_NestedSet extends Doctrine_Tree implements Doctrine_Tree_Interface
 {
-	/**
-	 * used to define table attributes required for the NestetSet implementation
-	 * adds lft and rgt columns for corresponding left and right values
-	 *			
-	 */ 
-  public function setTableDefinition()
-  {
-    $this->table->setColumn("lft","integer",11);
-    $this->table->setColumn("rgt","integer",11);
-  }
-
-	/**
-	 * creates root node from given record or from a new record
-	 *
-	 * @param object $record		instance of Doctrine_Record				
-	 */ 
-  public function createRoot(Doctrine_Record $record = null)
-  {
-    if(!$record)
+    /**
+     * used to define table attributes required for the NestetSet implementation
+     * adds lft and rgt columns for corresponding left and right values
+     *
+     */
+    public function setTableDefinition()
     {
-      $record = $this->table->create();
+        $this->table->setColumn("lft","integer",11);
+        $this->table->setColumn("rgt","integer",11);
     }
-    
-    $record->set('lft', '1');
-    $record->set('rgt', '2');
-    $record->save();
-    
-    return $record;
-  }
-
-	/**
-	 * returns root node
-	 *
-	 * @return object $record		instance of Doctrine_Record				
-	 */  
-  public function findRoot()
-  {
-    $q = $this->table->createQuery();
-    $root = $q->where('lft = ?', 1)
-                ->execute()->getFirst();
-    
-    // if no record is returned, create record
-    if(!$root)
+
+    /**
+     * creates root node from given record or from a new record
+     *
+     * @param object $record        instance of Doctrine_Record
+     */
+    public function createRoot(Doctrine_Record $record = null)
     {
-      $root = $this->table->create();
+        if (!$record) {
+            $record = $this->table->create();
+        }
+
+        $record->set('lft', '1');
+        $record->set('rgt', '2');
+        $record->save();
+
+        return $record;
     }
 
-    // set level to prevent additional query to determine level
-    $root->getNode()->setLevel(0);
-
-    return $root;
-  }
-	/**
-	 * optimised method to returns iterator for traversal of the entire tree from root
-	 * 
-	 * @param array $options		  options		
-	 * @return object $iterator		instance of Doctrine_Node_NestedSet_PreOrderIterator			
-	 */  
-  public function fetchTree($options = array())
-  {
-    // fetch tree
-    $q = $this->table->createQuery();
-    
-    $tree = $q->where('lft >= ?', 1)
-              ->orderBy('lft asc')
-              ->execute();
-              
-    $root = $tree->getFirst();
-
-    // if no record is returned, create record
-    if(!$root)
+    /**
+     * returns root node
+     *
+     * @return object $record        instance of Doctrine_Record
+     */
+    public function findRoot()
     {
-      $root = $this->table->create();
+        $q = $this->table->createQuery();
+        $root = $q->where('lft = ?', 1)
+                  ->execute()->getFirst();
+
+        // if no record is returned, create record
+        if (!$root) {
+            $root = $this->table->create();
+        }
+
+        // set level to prevent additional query to determine level
+        $root->getNode()->setLevel(0);
+
+        return $root;
     }
 
-    if($root->exists())
+    /**
+     * optimised method to returns iterator for traversal of the entire tree from root
+     *
+     * @param array $options                    options
+     * @return object $iterator                 instance of Doctrine_Node_NestedSet_PreOrderIterator
+     */
+    public function fetchTree($options = array())
     {
-      // set level to prevent additional query
-      $root->getNode()->setLevel(0);
+        // fetch tree
+        $q = $this->table->createQuery();
+
+        $tree = $q->where('lft >= ?', 1)
+                  ->orderBy('lft asc')
+                  ->execute();
 
-      // default to include root node
-      $options = array_merge(array('include_record'=>true), $options);
-      
-      // remove root node from collection if not required
-      if($options['include_record'] == false)
-        $tree->remove(0);
+        $root = $tree->getFirst();
 
-      // set collection for iterator        
-      $options['collection'] = $tree;
+        // if no record is returned, create record
+        if (!$root) {
+            $root = $this->table->create();
+        }
 
-      return $root->getNode()->traverse('Pre', $options);      
+        if ($root->exists()) {
+            // set level to prevent additional query
+            $root->getNode()->setLevel(0);
+
+            // default to include root node
+            $options = array_merge(array('include_record'=>true), $options);
+
+            // remove root node from collection if not required
+            if($options['include_record'] == false)
+              $tree->remove(0);
+
+            // set collection for iterator
+            $options['collection'] = $tree;
+
+            return $root->getNode()->traverse('Pre', $options);
+        }
+
+        // TODO: no default return value or exception thrown?
     }
-  }
-	/**
-	 * optimised method that returns iterator for traversal of the tree from the given record primary key
-	 * 
-	 * @param mixed $pk		        primary key as used by table::find() to locate node to traverse tree from
-	 * @param array $options		  options		
-	 * @return iterator		instance of Doctrine_Node_<Implementation>_PreOrderIterator					
-	 */   
-  public function fetchBranch($pk, $options = array())
-  {
-    $record = $this->table->find($pk);
-    if($record->exists())
+
+    /**
+     * optimised method that returns iterator for traversal of the tree from the given record primary key
+     *
+     * @param mixed $pk                         primary key as used by table::find() to locate node to traverse tree from
+     * @param array $options                    options
+     * @return iterator                         instance of Doctrine_Node_<Implementation>_PreOrderIterator
+     */
+    public function fetchBranch($pk, $options = array())
     {
-      $options = array_merge(array('include_record'=>true), $options);
-      return $record->getNode()->traverse('Pre', $options);      
+        $record = $this->table->find($pk);
+        if ($record->exists()) {
+            $options = array_merge(array('include_record'=>true), $options);
+            return $record->getNode()->traverse('Pre', $options);
+        }
+
+        // TODO: if record doesn't exist, throw exception or similar?
     }
-  }
-}
+}
\ No newline at end of file