bug #48917 [Config] Fix XML dump when node example is an array (alexandre-daubois)

fabpot · fabpot · commit 573e841b3e2d · 2023-01-08T16:20:07.000+01:00
This PR was merged into the 5.4 branch. Discussion ---------- [Config] Fix XML dump when node example is an array | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Tickets | _NA_ | License | MIT | Doc PR | _NA_ Dumping reference config in XML format doesn't work when an example is an array. This aims to fix this. Current behavior when trying to dump reference of the FrameworkBundle in XML: <img width="1043" alt="image" src="https://user-images.githubusercontent.com/2144837/211198188-eee6f2d5-dc0a-4771-9075-0df739c3d4a8.png"> Commits ------- ee9d357 [Config] Fix XML dump when node example is an array
diff --git a/src/Symfony/Component/Config/Definition/Dumper/XmlReferenceDumper.php b/src/Symfony/Component/Config/Definition/Dumper/XmlReferenceDumper.php
@@ -147,7 +147,7 @@ private function writeNode(NodeInterface $node, int $depth = 0, bool $root = fal
                 }
 
                 if ($child instanceof BaseNode && $example = $child->getExample()) {
-                    $comments[] = 'Example: '.$example;
+                    $comments[] = 'Example: '.(\is_array($example) ? implode(', ', $example) : $example);
                 }
 
                 if ($child->isRequired()) {
diff --git a/src/Symfony/Component/Config/Tests/Definition/Dumper/XmlReferenceDumperTest.php b/src/Symfony/Component/Config/Tests/Definition/Dumper/XmlReferenceDumperTest.php
@@ -42,6 +42,7 @@ private function getConfigurationAsString()
 <!-- scalar-deprecated-with-message: Deprecated (Since vendor/package 1.1: Deprecation custom message for "scalar_deprecated_with_message" at "acme_root") -->
 <!-- enum-with-default: One of "this"; "that" -->
 <!-- enum: One of "this"; "that" -->
+<!-- variable: Example: foo, bar -->
 <config
     boolean="true"
     scalar-empty=""
@@ -57,6 +58,7 @@ private function getConfigurationAsString()
     node-with-a-looong-name=""
     enum-with-default="this"
     enum=""
+    variable=""
     custom-node="true"
 >
 
diff --git a/src/Symfony/Component/Config/Tests/Definition/Dumper/YamlReferenceDumperTest.php b/src/Symfony/Component/Config/Tests/Definition/Dumper/YamlReferenceDumperTest.php
@@ -114,6 +114,11 @@ enum:                 ~ # One of "this"; "that"
         # which should be indented
         child3:               ~ # Example: 'example setting'
     scalar_prototyped:    []
+    variable:
+
+        # Examples:
+        - foo
+        - bar
     parameters:
 
         # Prototype: Parameter name
diff --git a/src/Symfony/Component/Config/Tests/Fixtures/Configuration/ExampleConfiguration.php b/src/Symfony/Component/Config/Tests/Fixtures/Configuration/ExampleConfiguration.php
@@ -58,6 +58,9 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->arrayNode('scalar_prototyped')
                     ->prototype('scalar')->end()
                 ->end()
+                ->variableNode('variable')
+                    ->example(['foo', 'bar'])
+                ->end()
                 ->arrayNode('parameters')
                     ->useAttributeAsKey('name')
                     ->prototype('scalar')->info('Parameter name')->end()

Original file line number	Diff line number	Diff line change
`@@ -147,7 +147,7 @@ private function writeNode(NodeInterface $node, int $depth = 0, bool $root = fal`
`147`	`147`	`}`
`148`	`148`
`149`	`149`	`if ($child instanceof BaseNode && $example = $child->getExample()) {`
`150`		`- $comments[] = 'Example: '.$example;`
	`150`	`+ $comments[] = 'Example: '.(\is_array($example) ? implode(', ', $example) : $example);`
`151`	`151`	`}`
`152`	`152`
`153`	`153`	`if ($child->isRequired()) {`