[Framework][debug:config] Allow to debug path with dot in key

Jibbarth · Jibbarth · commit db59a7f456e5 · 2026-05-17T12:19:01.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/ConfigDebugCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/ConfigDebugCommand.php
@@ -72,6 +72,10 @@ protected function configure(): void
 
                   <info>php %command.full_name% framework serializer.enabled</info>
 
+                If a key in your path contains dots, surround it by brackets:
+
+                  <info>php %command.full_name% extension "path.[sub.path].option"</info>
+
                 EOF
             )
         ;
@@ -168,9 +172,14 @@ private function compileContainer(): ContainerBuilder
      */
     private function getConfigForPath(array $config, string $path, string $alias): mixed
     {
-        $steps = explode('.', $path);
+        preg_match_all('/\[([^\]]+)\]|[^.]+/', $path, $matches);
+        $steps = $matches[0];
 
         foreach ($steps as $step) {
+            if (str_starts_with($step, '[') && str_ends_with($step, ']')) {
+                $step = substr($step, 1, -1);
+            }
+
             if (!\is_array($config) || !\array_key_exists($step, $config)) {
                 throw new LogicException(\sprintf('Unable to find configuration for "%s.%s".', $alias, $path));
             }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/DependencyInjection/Config/CustomConfig.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/DependencyInjection/Config/CustomConfig.php
@@ -22,6 +22,14 @@ public function addConfiguration($rootNode)
                     ->children()
                         ->scalarNode('child1')->end()
                         ->scalarNode('child2')->end()
+                    ->end()
+                ->end()
+                ->arrayNode('options')
+                    ->useAttributeAsKey('key')
+                    ->arrayPrototype()
+                        ->children()
+                            ->scalarNode('key')->end()
+                            ->scalarNode('data')->end()
                         ->end()
                     ->end()
                 ->end()
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/DependencyInjection/TestExtension.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/DependencyInjection/TestExtension.php
@@ -29,7 +29,13 @@ public function load(array $configs, ContainerBuilder $container): void
 
     public function prepend(ContainerBuilder $container): void
     {
-        $container->prependExtensionConfig('test', ['custom' => 'foo']);
+        $container->prependExtensionConfig('test', [
+            'custom' => 'foo',
+            'options' => [
+                'option.main' => ['data' => 'foo'],
+                'option.sub' => ['data' => 'bar'],
+            ]
+        ]);
     }
 
     public function getConfiguration(array $config, ContainerBuilder $container): ?ConfigurationInterface
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/ConfigDebugCommandTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/ConfigDebugCommandTest.php
@@ -78,6 +78,27 @@ public function testDumpBundleOption(bool $debug)
         $this->assertStringContainsString('foo', $tester->getDisplay());
     }
 
+    #[TestWith([true])]
+    #[TestWith([false])]
+    public function testDumpBundleOptionWithDotInKeyWithoutBracket(bool $debug)
+    {
+        $tester = $this->createCommandTester($debug);
+        $ret = $tester->execute(['name' => 'TestBundle', 'path' => 'options.option.main']);
+        $this->assertSame(1, $ret, 'Returns 0 in case of success');
+        $this->assertStringContainsString('Unable to find configuration for "test.options.option.main"', $tester->getDisplay());
+    }
+
+    #[TestWith([true])]
+    #[TestWith([false])]
+    public function testDumpBundleOptionWithDotInKeyWithBracket(bool $debug)
+    {
+        $tester = $this->createCommandTester($debug);
+        $ret = $tester->execute(['name' => 'TestBundle', 'path' => 'options.[option.main]']);
+
+        $this->assertSame(0, $ret, 'Returns 0 in case of success');
+        $this->assertStringContainsString('data: foo', $tester->getDisplay());
+    }
+
     #[TestWith([true])]
     #[TestWith([false])]
     public function testDumpWithoutTitleIsValidJson(bool $debug)

Original file line number	Diff line number	Diff line change
`@@ -72,6 +72,10 @@ protected function configure(): void`
`72`	`72`
`73`	`73`	`<info>php %command.full_name% framework serializer.enabled</info>`
`74`	`74`
	`75`	`+ If a key in your path contains dots, surround it by brackets:`
	`76`	`+`
	`77`	`+ <info>php %command.full_name% extension "path.[sub.path].option"</info>`
	`78`	`+`
`75`	`79`	`EOF`
`76`	`80`	`)`
`77`	`81`	`;`
`@@ -168,9 +172,14 @@ private function compileContainer(): ContainerBuilder`
`168`	`172`	`*/`
`169`	`173`	`private function getConfigForPath(array $config, string $path, string $alias): mixed`
`170`	`174`	`{`
`171`		`- $steps = explode('.', $path);`
	`175`	`+ preg_match_all('/\[([^\]]+)\]\|[^.]+/', $path, $matches);`
	`176`	`+ $steps = $matches[0];`
`172`	`177`
`173`	`178`	`foreach ($steps as $step) {`
	`179`	`+ if (str_starts_with($step, '[') && str_ends_with($step, ']')) {`
	`180`	`+ $step = substr($step, 1, -1);`
	`181`	`+ }`
	`182`	`+`
`174`	`183`	`if (!\is_array($config) \|\| !\array_key_exists($step, $config)) {`
`175`	`184`	`throw new LogicException(\sprintf('Unable to find configuration for "%s.%s".', $alias, $path));`
`176`	`185`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,13 @@ public function load(array $configs, ContainerBuilder $container): void`
`29`	`29`
`30`	`30`	`public function prepend(ContainerBuilder $container): void`
`31`	`31`	`{`
`32`		`- $container->prependExtensionConfig('test', ['custom' => 'foo']);`
	`32`	`+ $container->prependExtensionConfig('test', [`
	`33`	`+ 'custom' => 'foo',`
	`34`	`+ 'options' => [`
	`35`	`+ 'option.main' => ['data' => 'foo'],`
	`36`	`+ 'option.sub' => ['data' => 'bar'],`
	`37`	`+ ]`
	`38`	`+ ]);`
`33`	`39`	`}`
`34`	`40`
`35`	`41`	`public function getConfiguration(array $config, ContainerBuilder $container): ?ConfigurationInterface`