Adds move before, after and below

Author: kimpepper

src/NestedSetInterface.php

@@ -74,14 +74,34 @@ public function findAncestors(Leaf $leaf);
   public function getLeaf($id, $revision_id);
 
   /**
-   * Moves a Leaf and its sub-tree into a new position.
+   * Moves a Leaf and its sub-tree below the target leaf.
    *
-   * @param int $newLeftPosition
-   *   The new left position for the leaf.
+   * @param Leaf $target
+   *   The leaf to move below.
    * @param \PNX\Tree\Leaf $leaf
    *   The leaf to move.
    */
-  public function moveSubTree($newLeftPosition, Leaf $leaf);
+  public function moveSubTreeBelow(Leaf $target, Leaf $leaf);
+
+  /**
+   * Moves a Leaf and its sub-tree before the target leaf.
+   *
+   * @param Leaf $target
+   *   The leaf to move before.
+   * @param \PNX\Tree\Leaf $leaf
+   *   The leaf to move.
+   */
+  public function moveSubTreeBefore(Leaf $target, Leaf $leaf);
+
+  /**
+   * Moves a Leaf and its sub-tree after the target leaf.
+   *
+   * @param Leaf $target
+   *   The leaf to move after.
+   * @param \PNX\Tree\Leaf $leaf
+   *   The leaf to move.
+   */
+  public function moveSubTreeAfter(Leaf $target, Leaf $leaf);
 
   /**
    * Gets a leaf at a specified left position.

src/Storage/DbalNestedSet.php

@@ -238,18 +238,49 @@ public function deleteSubTree(Leaf $leaf) {
   /**
    * {@inheritdoc}
    */
-  public function moveSubTree($newLeftPostion, Leaf $leaf) {
+  public function moveSubTreeBelow(Leaf $target, Leaf $leaf) {
+    $newLeftPosition = $target->getLeft() + 1;
+    $this->moveSubTreeToPosition($newLeftPosition, $leaf);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function moveSubTreeBefore(Leaf $target, Leaf $leaf) {
+    $newLeftPosition = $target->getLeft();
+    $this->moveSubTreeToPosition($newLeftPosition, $leaf);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function moveSubTreeAfter(Leaf $target, Leaf $leaf) {
+    $newLeftPosition = $target->getRight() + 1;
+    $this->moveSubTreeToPosition($newLeftPosition, $leaf);
+  }
 
+  /**
+   * Moves a subtree to a new position.
+   *
+   * @param int $newLeftPosition
+   *   The new left position.
+   * @param \PNX\Tree\Leaf $leaf
+   *   The leaf to move.
+   *
+   * @throws \Exception
+   *   If a transaction error occurs.
+   */
+  protected function moveSubTreeToPosition($newLeftPosition, Leaf $leaf) {
     try {
       // Calculate position adjustment variables.
       $width = $leaf->getRight() - $leaf->getLeft() + 1;
-      $distance = $newLeftPostion - $leaf->getLeft();
+      $distance = $newLeftPosition - $leaf->getLeft();
       $tempPos = $leaf->getLeft();
 
       $this->connection->beginTransaction();
 
       // Calculate depth difference.
-      $newLeaf = $this->getLeafAtPosition($newLeftPostion);
+      $newLeaf = $this->getLeafAtPosition($newLeftPosition);
       $depthDiff = $newLeaf->getDepth() - $leaf->getDepth();
 
       // Backwards movement must account for new space.
@@ -260,11 +291,11 @@ public function moveSubTree($newLeftPostion, Leaf $leaf) {
 
       // Create new space for subtree.
       $this->connection->executeUpdate('UPDATE tree SET nested_left = nested_left + ? WHERE nested_left >= ?',
-        [$width, $newLeftPostion]
+        [$width, $newLeftPosition]
       );
 
       $this->connection->executeUpdate('UPDATE tree SET nested_right = nested_right + ? WHERE nested_right >= ?',
-        [$width, $newLeftPostion]
+        [$width, $newLeftPosition]
       );
 
       // Move subtree into new space.

tests/Functional/DbalNestedSetTest.php

@@ -235,17 +235,17 @@ public function testDeleteSubTree() {
   }
 
   /**
-   * Tests moving a sub-tree.
+   * Tests moving a sub-tree under a parent leaf.
    */
-  public function testMoveSubTree() {
+  public function testMoveSubTreeBelow() {
     print "BEFORE:" . PHP_EOL;
     $tree = $this->nestedSet->getTree();
     $this->printTree($tree);
 
+    $parent = $this->nestedSet->getLeaf(1, 1);
     $leaf = $this->nestedSet->getLeaf(7, 1);
 
-    $newPosition = 2;
-    $this->nestedSet->moveSubTree($newPosition, $leaf);
+    $this->nestedSet->moveSubTreeBelow($parent, $leaf);
 
     print "AFTER:" . PHP_EOL;
     $tree = $this->nestedSet->getTree();
@@ -276,6 +276,48 @@ public function testMoveSubTree() {
 
   }
 
+  /**
+   * Tests moving a sub-tree before a target leaf.
+   */
+  public function testMoveSubTreeBefore() {
+    print "BEFORE:" . PHP_EOL;
+    $tree = $this->nestedSet->getTree();
+    $this->printTree($tree);
+
+    $target = $this->nestedSet->getLeaf(4, 1);
+    $leaf = $this->nestedSet->getLeaf(7, 1);
+
+    $this->nestedSet->moveSubTreeBefore($target, $leaf);
+
+    print "AFTER:" . PHP_EOL;
+    $tree = $this->nestedSet->getTree();
+    $this->printTree($tree);
+
+    // Check leaf is in new position.
+    $leaf = $this->nestedSet->getLeaf(7, 1);
+    $this->assertEquals(3, $leaf->getLeft());
+    $this->assertEquals(8, $leaf->getRight());
+    $this->assertEquals(2, $leaf->getDepth());
+
+    // Check children are in new position.
+    $leaf = $this->nestedSet->getLeaf(10, 1);
+    $this->assertEquals(4, $leaf->getLeft());
+    $this->assertEquals(5, $leaf->getRight());
+    $this->assertEquals(3, $leaf->getDepth());
+
+    $leaf = $this->nestedSet->getLeaf(11, 1);
+    $this->assertEquals(6, $leaf->getLeft());
+    $this->assertEquals(7, $leaf->getRight());
+    $this->assertEquals(3, $leaf->getDepth());
+
+    // Check old parent is updated.
+    $leaf = $this->nestedSet->getLeaf(3, 1);
+    $this->assertEquals(16, $leaf->getLeft());
+    $this->assertEquals(21, $leaf->getRight());
+    $this->assertEquals(1, $leaf->getDepth());
+
+  }
+
   /**
    * Creates the table.
    */