feature #62135 [Config] Deprecate config builder generators (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit c47fb9d92ddd · 2025-10-23T18:42:40.000+02:00
This PR was merged into the 7.4 branch. Discussion ---------- [Config] Deprecate config builder generators | Q | A | ------------- | --- | Branch? | 7.4 | Bug fix? | no | New feature? | yes | Deprecations? | | Issues | - | License | MIT You served us well! 👋 Commits ------- 85a9b76 [Config] Deprecate config builder generators
diff --git a/UPGRADE-7.4.md b/UPGRADE-7.4.md
@@ -23,7 +23,7 @@ Config
 
  * Deprecate accessing the internal scope of the loader in PHP config files, use only its public API instead
  * Deprecate setting a default value to a node that is required, and vice versa
- * Deprecate generating fluent methods in config builders
+ * Deprecate fluent config builders, return PHP arrays from your config instead
 
 Console
 -------
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -18,6 +18,7 @@ CHANGELOG
  * Add support for union types with `Symfony\Component\EventDispatcher\Attribute\AsEventListener`
  * Add `framework.allowed_http_method_override` option
  * Initialize `router.request_context`'s `_locale` parameter to `%kernel.default_locale%`
+ * Deprecate `ConfigBuilderCacheWarmer`, return PHP arrays from your config instead
 
 7.3
 ---
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/ConfigBuilderCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/ConfigBuilderCacheWarmer.php
@@ -30,7 +30,7 @@
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  *
- * @final since Symfony 7.1
+ * @deprecated since Symfony 7.4
  */
 class ConfigBuilderCacheWarmer implements CacheWarmerInterface
 {
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -47,6 +47,7 @@
 use Symfony\Component\Cache\Marshaller\MarshallerInterface;
 use Symfony\Component\Cache\ResettableInterface;
 use Symfony\Component\Clock\ClockInterface;
+use Symfony\Component\Config\Builder\ConfigBuilderGenerator;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\Config\Loader\LoaderInterface;
@@ -297,6 +298,9 @@ public function load(array $configs, ContainerBuilder $container): void
         if (!class_exists(IsSignatureValidAttributeListener::class)) {
             $container->removeDefinition('controller.is_signature_valid_attribute_listener');
         }
+        if (!class_exists(ConfigBuilderGenerator::class)) {
+            $container->removeDefinition('config_builder.warmer');
+        }
 
         if ($this->hasConsole()) {
             $loader->load('console.php');
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/CacheWarmer/ConfigBuilderCacheWarmerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/CacheWarmer/ConfigBuilderCacheWarmerTest.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Tests\CacheWarmer;
 
+use PHPUnit\Framework\Attributes\Group;
+use PHPUnit\Framework\Attributes\IgnoreDeprecations;
 use Symfony\Bundle\FrameworkBundle\CacheWarmer\ConfigBuilderCacheWarmer;
 use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
 use Symfony\Bundle\FrameworkBundle\Tests\TestCase;
@@ -31,7 +33,9 @@
 use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\HttpKernel\KernelInterface;
 
-class ConfigBuilderCacheWarmerTest extends TestCase
+#[IgnoreDeprecations]
+#[Group('legacy')]
+final class ConfigBuilderCacheWarmerTest extends TestCase
 {
     private string $varDir;
 
diff --git a/src/Symfony/Component/Config/Builder/ConfigBuilderGenerator.php b/src/Symfony/Component/Config/Builder/ConfigBuilderGenerator.php
@@ -30,6 +30,8 @@
  * Generate ConfigBuilders to help create valid config.
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * @deprecated since Symfony 7.4
  */
 class ConfigBuilderGenerator implements ConfigBuilderGeneratorInterface
 {
diff --git a/src/Symfony/Component/Config/Builder/ConfigBuilderGeneratorInterface.php b/src/Symfony/Component/Config/Builder/ConfigBuilderGeneratorInterface.php
@@ -17,6 +17,8 @@
  * Generates ConfigBuilders to help create valid config.
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * @deprecated since Symfony 7.4
  */
 interface ConfigBuilderGeneratorInterface
 {
diff --git a/src/Symfony/Component/Config/Builder/ConfigBuilderInterface.php b/src/Symfony/Component/Config/Builder/ConfigBuilderInterface.php
@@ -15,6 +15,8 @@
  * A ConfigBuilder provides helper methods to build a large complex array.
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * @deprecated since Symfony 7.4
  */
 interface ConfigBuilderInterface
 {
diff --git a/src/Symfony/Component/Config/CHANGELOG.md b/src/Symfony/Component/Config/CHANGELOG.md
@@ -11,7 +11,7 @@ CHANGELOG
  * Add array-shapes to generated config builders
  * Deprecate accessing the internal scope of the loader in PHP config files, use only its public API instead
  * Deprecate setting a default value to a node that is required, and vice versa
- * Deprecate generating fluent methods in config builders
+ * Deprecate fluent config builders, return PHP arrays from your config instead
 
 7.3
 ---
diff --git a/src/Symfony/Component/Config/Tests/Builder/GeneratedConfigTest.php b/src/Symfony/Component/Config/Tests/Builder/GeneratedConfigTest.php
@@ -11,16 +11,13 @@
 
 namespace Symfony\Component\Config\Tests\Builder;
 
-use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Group;
 use PHPUnit\Framework\Attributes\IgnoreDeprecations;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Config\Builder\ClassBuilder;
 use Symfony\Component\Config\Builder\ConfigBuilderGenerator;
 use Symfony\Component\Config\Builder\ConfigBuilderInterface;
-use Symfony\Component\Config\Builder\Method;
-use Symfony\Component\Config\Builder\Property;
 use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
 use Symfony\Component\Config\Tests\Builder\Fixtures\AddToList;
 use Symfony\Component\Config\Tests\Builder\Fixtures\NodeInitialValues;
@@ -35,10 +32,8 @@
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
-#[CoversClass(ClassBuilder::class)]
-#[CoversClass(ConfigBuilderGenerator::class)]
-#[CoversClass(Method::class)]
-#[CoversClass(Property::class)]
+#[IgnoreDeprecations]
+#[Group('legacy')]
 class GeneratedConfigTest extends TestCase
 {
     private array $tempDir = [];

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`*`
`31`	`31`	`* @author Tobias Nyholm <tobias.nyholm@gmail.com>`
`32`	`32`	`*`
`33`		`- * @final since Symfony 7.1`
	`33`	`+ * @deprecated since Symfony 7.4`
`34`	`34`	`*/`
`35`	`35`	`class ConfigBuilderCacheWarmer implements CacheWarmerInterface`
`36`	`36`	`{`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,8 @@`
`30`	`30`	`* Generate ConfigBuilders to help create valid config.`
`31`	`31`	`*`
`32`	`32`	`* @author Tobias Nyholm <tobias.nyholm@gmail.com>`
	`33`	`+ *`
	`34`	`+ * @deprecated since Symfony 7.4`
`33`	`35`	`*/`
`34`	`36`	`class ConfigBuilderGenerator implements ConfigBuilderGeneratorInterface`
`35`	`37`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@`
`17`	`17`	`* Generates ConfigBuilders to help create valid config.`
`18`	`18`	`*`
`19`	`19`	`* @author Tobias Nyholm <tobias.nyholm@gmail.com>`
	`20`	`+ *`
	`21`	`+ * @deprecated since Symfony 7.4`
`20`	`22`	`*/`
`21`	`23`	`interface ConfigBuilderGeneratorInterface`
`22`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,8 @@`
`15`	`15`	`* A ConfigBuilder provides helper methods to build a large complex array.`
`16`	`16`	`*`
`17`	`17`	`* @author Tobias Nyholm <tobias.nyholm@gmail.com>`
	`18`	`+ *`
	`19`	`+ * @deprecated since Symfony 7.4`
`18`	`20`	`*/`
`19`	`21`	`interface ConfigBuilderInterface`
`20`	`22`	`{`