Tweaking some of the table classes related to reordering, but mostly adding a unit test for reordering.

Author: weaverryan

lib/model/doctrine/PluginioDoctrineMenuItemTable.class.php

@@ -119,7 +119,7 @@ public function fetchRootByName($name)
    * @return void
    * @author Brent Shaffer
    */
-  public function clearTree($root)
+  public function clearTree(ioDoctrineMenuItem $root)
   {
     $nodes = $this->createQuery()
       ->where('root_id = ?', $root['id'])
@@ -142,34 +142,46 @@ public function clearTree($root)
    * @return void
    * @author Brent Shaffer
    */
-  public function restoreTreeFromNestedArray($arr, $name)
+  public function restoreTreeFromNestedArray($arr, ioDoctrineMenuItem $root)
   {
-    $root = $this->fetchRootByName($name);
+    if (!$root->getNode()->isRoot())
+    {
+      throw new sfException('ioDoctrineMenuItemTable::restoreTreeFromNestedArray() must be called using a root node.');
+    }
 
+    // remove all of the nodes from the tree
     $this->clearTree($root);
 
-    Doctrine::getTable('ioDoctrineMenuItem')->getTree()->createRoot($root);
-    
-    $this->restoreBranchFromNestedArray(array('id' => $root['id'], 'children' => $arr));
+    // reestablish the root
+    $this->getTree()->createRoot($root);
+
+    // put the nodes back on
+    $this->restoreBranchFromNestedArray(array('menu' => $root, 'children' => $arr));
   }
-  
+
   /**
-   * recursive function to create a nested set from an array
+   * recursive function to create a nested set sourced from an array
    *
-   * @param string $arr
-   * @return void
+   * @param array $arr The source array with keys menu and children
+   * @return ioDoctrineMenuItem
    * @author Brent Shaffer
    */
   public function restoreBranchFromNestedArray($arr)
   {
-    $parent = Doctrine::getTable('ioDoctrineMenuItem')->findOneById($arr['id']);
+    $parent = $arr['menu'];
 
-    if (isset($arr['children'])) 
+    if (isset($arr['children']))
     {
-      foreach ($arr['children'] as $childArr) 
+      foreach ($arr['children'] as $childArr)
       {
-        $child = Doctrine::getTable('ioDoctrineMenuItem')->findOneById($childArr['id']);
+        $child = $this->find($childArr['id']);
         $child->getNode()->insertAsLastChildOf($parent);
+
+        // put the child object into the array
+        $childArr['menu'] = $child;
+        unset($childArr['id']);
+
+        // recurse down and ultimately refresh the parent
         $this->restoreBranchFromNestedArray($childArr);
         $parent->refresh();
       }

test/unit/model/doctrine/PluginioDoctrineMenuItemTableTest.php

@@ -4,7 +4,7 @@
 require_once $_SERVER['SYMFONY'].'/vendor/lime/lime.php';
 require_once sfConfig::get('sf_lib_dir').'/test/unitHelper.php';
 
-$t = new lime_test(60);
+$t = new lime_test(68);
 $tbl = Doctrine_Core::getTable('ioDoctrineMenuItem');
 
 $t->info('1 - Add a tree to an existing node. This should have the same effect as using ioDoctrineMenuItem::persistFromMenuArray()');
@@ -73,4 +73,36 @@
   $children = $rt->getNode()->getChildren();
   $children[0]->setRoute('http://www.doctrine-project.org');
   $children[0]->save();
-  $t->is($manager->getCacheDriver()->has($cacheKey), false, 'The cache is now unset.');
+  $t->is($manager->getCacheDriver()->has($cacheKey), false, 'The cache is now unset.');
+
+$t->info('6 - Test restoreTreeFromNestedArray()');
+  $tbl->createQuery()->delete()->execute();
+  extract(create_doctrine_test_tree($t));
+
+  $newOrder = array(
+    array(
+      'id' => $pt2->id,
+      'children' => array(
+        array(
+          'id' => $ch4->id,
+          'children' => array(
+            array('id' => $gc1->id),
+          )
+        ),
+      )
+    ),
+    array(
+      'id' => $pt1->id,
+      'children' => array(
+        array('id' => $ch3->id),
+        array('id' => $ch1->id),
+        array('id' => $ch2->id),
+      )
+    )
+  );
+
+  $tbl->restoreTreeFromNestedArray($newOrder, $rt);
+  root_sanity_check($t, $rt);    
+  check_child_ordering($t, $rt, array(), array('Parent 2', 'Parent 1'));
+  check_child_ordering($t, $rt, array(0), array('Child 4'));
+  check_child_ordering($t, $rt, array(1), array('Child 3', 'Child 1', 'Child 2'));