correctly nest items with the same values with different parents

Author: splitbrain

_test/NestedResultTest.php

@@ -26,9 +26,9 @@ class NestedResultTest extends StructTest
         ['laptop', 'apple', 'pro 16'],
         ['laptop', 'apple', 'air'],
         ['laptop', 'apple', 'm1'],
-        ['laptop', 'dell', 'xps'],
         ['laptop', 'dell', 'inspiron'],
         ['laptop', 'dell', 'latitude'],
+        ['laptop', 'bmw', 'latitude'],
     ];
 
     protected $multiItems = [
@@ -151,13 +151,14 @@ public function testSimpleTwoLevels()
         $this->assertEquals('car', $tree[0]->getValueObject()->getValue());
         $this->assertEquals('laptop', $tree[1]->getValueObject()->getValue());
 
-        $this->assertCount(2, $tree[0]->getChildren(true), '2 second level nodes expected');
-        $this->assertCount(2, $tree[1]->getChildren(true), '2 second level nodes expected');
+        $this->assertCount(2, $tree[0]->getChildren(true), '2 car brands expected');
+        $this->assertCount(3, $tree[1]->getChildren(true), '3 laptop brands expected');
 
-        $this->assertCount(3, $tree[0]->getChildren(true)[0]->getResultRows(), 'result rows');
-        $this->assertCount(3, $tree[0]->getChildren(true)[1]->getResultRows(), 'result rows');
-        $this->assertCount(3, $tree[1]->getChildren(true)[0]->getResultRows(), 'result rows');
-        $this->assertCount(3, $tree[1]->getChildren(true)[1]->getResultRows(), 'result rows');
+        $this->assertCount(3, $tree[0]->getChildren(true)[0]->getResultRows(), '3 audis expected');
+        $this->assertCount(3, $tree[0]->getChildren(true)[1]->getResultRows(), '3 bmw expected');
+        $this->assertCount(3, $tree[1]->getChildren(true)[0]->getResultRows(), '3 apple expected');
+        $this->assertCount(1, $tree[1]->getChildren(true)[1]->getResultRows(), '1 bmw expected');
+        $this->assertCount(2, $tree[1]->getChildren(true)[2]->getResultRows(), '2 dell expected');
 
 
         $this->assertEquals('a80', $tree[0]->getChildren(true)[0]->getResultRows()[0][0]->getValue(), 'Audi 80 expected');

meta/NestedResult.php

@@ -111,24 +111,26 @@ protected function nestBranch(NestedValue $parent, $row, $nesting, $depth = 0)
         $valObj = array_shift($row);
         if (!$valObj) return; // no more values to nest, usually shouldn't happen
 
+        $parentPath = (string) $parent;
+
         if ($valObj->getColumn()->isMulti() && $valObj->getValue()) {
             // split up multi values into separate nodes
             $values = $valObj->getValue();
             if ($values) {
                 foreach ($values as $value) {
                     $newValue = new Value($valObj->getColumn(), $value);
-                    $node = $this->getNodeForValue($newValue, $depth);
+                    $node = $this->getNodeForValue($newValue, $parentPath, $depth);
                     $parent->addChild($node);
                     $this->nestBranch($node, $row, $nesting, $depth + 1);
                 }
             } else {
                 $newValue = new Value($valObj->getColumn(), ''); // add empty node
-                $node = $this->getNodeForValue($newValue, $depth);
+                $node = $this->getNodeForValue($newValue, $parentPath, $depth);
                 $parent->addChild($node);
                 $this->nestBranch($node, $row, $nesting, $depth + 1);
             }
         } else {
-            $node = $this->getNodeForValue($valObj, $depth);
+            $node = $this->getNodeForValue($valObj, $parentPath, $depth);
             $parent->addChild($node);
             $this->nestBranch($node, $row, $nesting, $depth + 1);
         }
@@ -141,9 +143,9 @@ protected function nestBranch(NestedValue $parent, $row, $nesting, $depth = 0)
      * @param int $depth
      * @return NestedValue
      */
-    protected function getNodeForValue(Value $value, $depth)
+    protected function getNodeForValue(Value $value, $parentPath, $depth)
     {
-        $node = new NestedValue($value, $depth);
+        $node = new NestedValue($value, $parentPath, $depth);
         $key = (string)$node;
         if (!isset($this->nodes[$key])) {
             $this->nodes[$key] = $node;

meta/NestedValue.php

@@ -22,16 +22,21 @@ class NestedValue
 
     /** @var int the nesting depth */
     protected $depth;
+    /**
+     * @var mixed|string
+     */
+    protected $parentPath;
 
     /**
      * Create a nested version of the given value
      *
      * @param Value|null $value The value to store, null for root node
      * @param int $depth The depth of this node (avoids collision where the same values are selected on multiple levels)
      */
-    public function __construct(?Value $value, $depth = 0)
+    public function __construct(?Value $value, $parentPath = '', $depth = 0)
     {
         $this->value = $value;
+        $this->parentPath = $parentPath;
         $this->depth = $depth;
     }
 
@@ -134,7 +139,7 @@ public function getResultRows()
     public function __toString()
     {
         if ($this->value === null) return ''; // root node
-        return $this->value->__toString() . '-' . $this->depth;
+        return $this->parentPath . '/' . $this->value->__toString();
     }
 
     /**
@@ -171,9 +176,10 @@ public function sortChildren(NestedValue $a, NestedValue $b)
     /**
      * print the tree for debugging
      *
+     * @param bool $sort use sorted children?
      * @return string
      */
-    public function dump()
+    public function dump($sort = true)
     {
         $return = '';
 
@@ -197,7 +203,7 @@ public function dump()
             $return .= "\n";
         }
 
-        foreach ($this->getChildren() as $child) {
+        foreach ($this->getChildren($sort) as $child) {
             $return .= $child->dump();
         }