bug #61080 [Console] Fix TreeHelper::addChild when providing a string (jtattevin)

fabpot · fabpot · commit 1c43dcd7df32 · 2025-07-26T15:03:16.000+02:00
This PR was squashed before being merged into the 7.3 branch.

Discussion
----------

[Console] Fix `TreeHelper::addChild` when providing a string

| Q             | A
| ------------- | ---
| Branch?       | 7.3
| Bug fix?      | yes
| New feature?  | no
| Deprecations? | no
| Issues        | --
| License       | MIT

When using the tree helper, the method addChild allow to pass a string instead of an instance of TreeNode, for example :

```php
$rootNode = new TreeNode('Root');
$rootNode-&gt;addChild('Child 1');
$rootNode-&gt;addChild('Child 2');
$rootNode-&gt;addChild('Child 3');
$tree = TreeHelper::createTree($output, $rootNode);
$tree-&gt;render();
```

This method was creating the TreeNode from the string and using the parent as the children iterator, leading to an error like `LogicException: Cycle detected at node: "Child 1"`

This commit remove this second parameter.

Commits
-------

f53504aabb8 [Console] Fix `TreeHelper::addChild` when providing a string
diff --git a/Helper/TreeNode.php b/Helper/TreeNode.php
@@ -58,7 +58,7 @@ public function getValue(): string
     public function addChild(self|string|callable $node): self
     {
         if (\is_string($node)) {
-            $node = new self($node, $this);
+            $node = new self($node);
         }
 
         $this->children[] = $node;
diff --git a/Tests/Helper/TreeHelperTest.php b/Tests/Helper/TreeHelperTest.php
@@ -195,6 +195,26 @@ public function testRenderNodeWithMultipleChildren()
 TREE, self::normalizeLineBreaks(trim($output->fetch())));
     }
 
+    public function testRenderNodeWithMultipleChildrenWithStringConversion()
+    {
+        $rootNode = new TreeNode('Root');
+
+        $rootNode->addChild('Child 1');
+        $rootNode->addChild('Child 2');
+        $rootNode->addChild('Child 3');
+
+        $output = new BufferedOutput();
+        $tree = TreeHelper::createTree($output, $rootNode);
+
+        $tree->render();
+        $this->assertSame(<<<TREE
+Root
+├── Child 1
+├── Child 2
+└── Child 3
+TREE, self::normalizeLineBreaks(trim($output->fetch())));
+    }
+
     public function testRenderTreeWithDuplicateNodeNames()
     {
         $rootNode = new TreeNode('Root');
diff --git a/Tests/Helper/TreeNodeTest.php b/Tests/Helper/TreeNodeTest.php
@@ -34,6 +34,24 @@ public function testAddingChildren()
         $this->assertSame($child, iterator_to_array($root->getChildren())[0]);
     }
 
+    public function testAddingChildrenAsString()
+    {
+        $root = new TreeNode('Root');
+
+        $root->addChild('Child 1');
+        $root->addChild('Child 2');
+
+        $this->assertSame(2, iterator_count($root->getChildren()));
+
+        $children = iterator_to_array($root->getChildren());
+
+        $this->assertSame(0, iterator_count($children[0]->getChildren()));
+        $this->assertSame(0, iterator_count($children[1]->getChildren()));
+
+        $this->assertSame('Child 1', $children[0]->getValue());
+        $this->assertSame('Child 2', $children[1]->getValue());
+    }
+
     public function testAddingChildrenWithGenerators()
     {
         $root = new TreeNode('Root');

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ public function getValue(): string`
`58`	`58`	`public function addChild(self\|string\|callable $node): self`
`59`	`59`	`{`
`60`	`60`	`if (\is_string($node)) {`
`61`		`- $node = new self($node, $this);`
	`61`	`+ $node = new self($node);`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`$this->children[] = $node;`