minor #62616 [Config] Define TreeBuilder default generic type (alexander-schranz)

nicolas-grekas · nicolas-grekas · commit 2a6721aa30c6 · 2025-12-05T08:47:23.000+01:00
This PR was squashed before being merged into the 7.4 branch. Discussion ---------- [Config] Define `TreeBuilder` default generic type | Q | A | ------------- | --- | Branch? | 7.4 | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Issues | Fix #...  | License | MIT The generics make sense internal but are very confusing for all people not knowing about internal behaviours and hard to guess whats corrct so we should provide defaults for them. Similar to #61805 add some defaults. Stumbled over this during upgrade StofDoctrineExtensionBundle: ``` 14 Method Stof\DoctrineExtensionsBundle\DependencyInjection\Configuration::getConfigTreeBuilder() return type with generic class Symfony\Component\Config\Definition\Builder\TreeBuilder does not specify its types: T 🪪 missingType.generics 40 Method Stof\DoctrineExtensionsBundle\DependencyInjection\Configuration::getVendorNode() return type with generic class Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition does not specify its types: TParent 🪪 missingType.generics 67 Method Stof\DoctrineExtensionsBundle\DependencyInjection\Configuration::getClassNode() return type with generic class Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition does not specify its types: TParent 🪪 missingType.generics 121 Method Stof\DoctrineExtensionsBundle\DependencyInjection\Configuration::getSoftDeleteableNode() return type with generic class Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition does not specify its types: TParent 🪪 missingType.generics 136 Method Stof\DoctrineExtensionsBundle\DependencyInjection\Configuration::getUploadableNode() return type with generic class Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition does not specify its types: TParent 🪪 missingType.generics ``` Commits ------- d21ad61 [Config] Define `TreeBuilder` default generic type
diff --git a/src/Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php b/src/Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php
@@ -19,7 +19,7 @@
 /**
  * This class provides a fluent interface for defining an array node.
  *
- * @template TParent of NodeParentInterface|null
+ * @template TParent of NodeParentInterface|null = null
  *
  * @extends NodeDefinition<TParent>
  *
diff --git a/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php b/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php
@@ -16,7 +16,7 @@
 /**
  * This is the entry class for building a config tree.
  *
- * @template T of 'array'|'variable'|'scalar'|'string'|'boolean'|'integer'|'float'|'enum'
+ * @template T of 'array'|'variable'|'scalar'|'string'|'boolean'|'integer'|'float'|'enum' = 'array'
  *
  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  */
diff --git a/src/Symfony/Component/Config/Definition/Configuration.php b/src/Symfony/Component/Config/Definition/Configuration.php
@@ -31,9 +31,12 @@ public function __construct(
     ) {
     }
 
+    /**
+     * @return TreeBuilder<'array'>
+     */
     public function getConfigTreeBuilder(): TreeBuilder
     {
-        $treeBuilder = new TreeBuilder($this->alias);
+        $treeBuilder = new TreeBuilder($this->alias, 'array');
         $file = (new \ReflectionObject($this->subject))->getFileName();
         $loader = new DefinitionFileLoader($treeBuilder, new FileLocator(\dirname($file)), $this->container);
         $configurator = new DefinitionConfigurator($treeBuilder, $loader, $file, $file);
diff --git a/src/Symfony/Component/Config/Definition/ConfigurationInterface.php b/src/Symfony/Component/Config/Definition/ConfigurationInterface.php
@@ -22,6 +22,8 @@ interface ConfigurationInterface
 {
     /**
      * Generates the configuration tree builder.
+     *
+     * @return TreeBuilder<'array'>
      */
     public function getConfigTreeBuilder(): TreeBuilder;
 }

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`/**`
`20`	`20`	`* This class provides a fluent interface for defining an array node.`
`21`	`21`	`*`
`22`		`- * @template TParent of NodeParentInterface\|null`
	`22`	`+ * @template TParent of NodeParentInterface\|null = null`
`23`	`23`	`*`
`24`	`24`	`* @extends NodeDefinition<TParent>`
`25`	`25`	`*`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`/**`
`17`	`17`	`* This is the entry class for building a config tree.`
`18`	`18`	`*`
`19`		`- * @template T of 'array'\|'variable'\|'scalar'\|'string'\|'boolean'\|'integer'\|'float'\|'enum'`
	`19`	`+ * @template T of 'array'\|'variable'\|'scalar'\|'string'\|'boolean'\|'integer'\|'float'\|'enum' = 'array'`
`20`	`20`	`*`
`21`	`21`	`* @author Johannes M. Schmitt <[email protected]>`
`22`	`22`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -31,9 +31,12 @@ public function __construct(`
`31`	`31`	`) {`
`32`	`32`	`}`
`33`	`33`
	`34`	`+ /**`
	`35`	`+ * @return TreeBuilder<'array'>`
	`36`	`+ */`
`34`	`37`	`public function getConfigTreeBuilder(): TreeBuilder`
`35`	`38`	`{`
`36`		`- $treeBuilder = new TreeBuilder($this->alias);`
	`39`	`+ $treeBuilder = new TreeBuilder($this->alias, 'array');`
`37`	`40`	`$file = (new \ReflectionObject($this->subject))->getFileName();`
`38`	`41`	`$loader = new DefinitionFileLoader($treeBuilder, new FileLocator(\dirname($file)), $this->container);`
`39`	`42`	`$configurator = new DefinitionConfigurator($treeBuilder, $loader, $file, $file);`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,8 @@ interface ConfigurationInterface`
`22`	`22`	`{`
`23`	`23`	`/**`
`24`	`24`	`* Generates the configuration tree builder.`
	`25`	`+ *`
	`26`	`+ * @return TreeBuilder<'array'>`
`25`	`27`	`*/`
`26`	`28`	`public function getConfigTreeBuilder(): TreeBuilder;`
`27`	`29`	`}`