Deprecate using XML routing configuration files

fabpot · fabpot · commit 3225a1502964 · 2025-04-27T14:43:23.000+02:00
diff --git a/UPGRADE-7.3.md b/UPGRADE-7.3.md
@@ -76,6 +76,34 @@ FrameworkBundle
    public function __construct(#[Autowire('@serializer.normalizer.object')] NormalizerInterface $normalizer) {}
    ```
 
+
+ * The XML routing configuration files (`errors.xml` and `webhook.xml`) are
+   deprecated, use their PHP equivalent ones:
+
+  *Before*
+  ```yaml
+    when@dev:
+        _errors:
+            resource: '@FrameworkBundle/Resources/config/routing/errors.xml'
+            prefix: /_error
+
+    webhook:
+        resource: '@FrameworkBundle/Resources/config/routing/webhook.xml'
+        prefix: /webhook
+    ```
+
+  *After*
+  ```yaml
+    when@dev:
+        _errors:
+            resource: '@FrameworkBundle/Resources/config/routing/errors.php'
+            prefix: /_error
+
+    webhook:
+        resource: '@FrameworkBundle/Resources/config/routing/webhook.php'
+        prefix: /webhook
+    ```
+
 HttpFoundation
 --------------
 
@@ -112,6 +140,36 @@ PropertyInfo
  * Deprecate the `PropertyTypeExtractorInterface::getTypes()` method, use `PropertyTypeExtractorInterface::getType()` instead
  * Deprecate the `ConstructorArgumentTypeExtractorInterface::getTypesFromConstructor()` method, use `ConstructorArgumentTypeExtractorInterface::getTypeFromConstructor()` instead
 
+Routing
+-------
+
+ * The XML routing configuration files (`profiler.xml` and `wdt.xml`) are
+   deprecated, use their PHP equivalent ones:
+
+  *Before*
+  ```yaml
+    when@dev:
+        web_profiler_wdt:
+            resource: '@WebProfilerBundle/Resources/config/routing/wdt.xml'
+            prefix: /_wdt
+
+        web_profiler_profiler:
+            resource: '@WebProfilerBundle/Resources/config/routing/profiler.xml'
+            prefix: /_profiler
+    ```
+
+  *After*
+  ```yaml
+    when@dev:
+        web_profiler_wdt:
+            resource: '@WebProfilerBundle/Resources/config/routing/wdt.php'
+            prefix: /_wdt
+
+        web_profiler_profiler:
+            resource: '@WebProfilerBundle/Resources/config/routing/profiler.php
+            prefix: /_profiler
+    ```
+
 Security
 --------
 
diff --git a/src/Symfony/Bundle/WebProfilerBundle/Resources/config/routing/profiler.php b/src/Symfony/Bundle/WebProfilerBundle/Resources/config/routing/profiler.php
@@ -10,8 +10,19 @@
  */
 
 use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
+use Symfony\Component\Routing\Loader\XmlFileLoader;
 
 return function (RoutingConfigurator $routes): void {
+    foreach (debug_backtrace(\DEBUG_BACKTRACE_PROVIDE_OBJECT) as $trace) {
+        if (isset($trace['object']) && $trace['object'] instanceof XmlFileLoader && 'doImport' === $trace['function']) {
+            if (__DIR__ === dirname(realpath($trace['args'][3]))) {
+                trigger_deprecation('symfony/routing', '7.3', 'The "profiler.xml" routing configuration file is deprecated, import "profile.php" instead.');
+
+                break;
+            }
+        }
+    }
+
     $routes->add('_profiler_home', '/')
         ->controller('web_profiler.controller.profiler::homeAction')
     ;
diff --git a/src/Symfony/Bundle/WebProfilerBundle/Resources/config/routing/wdt.php b/src/Symfony/Bundle/WebProfilerBundle/Resources/config/routing/wdt.php
@@ -10,8 +10,19 @@
  */
 
 use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
+use Symfony\Component\Routing\Loader\XmlFileLoader;
 
 return function (RoutingConfigurator $routes): void {
+    foreach (debug_backtrace(\DEBUG_BACKTRACE_PROVIDE_OBJECT) as $trace) {
+        if (isset($trace['object']) && $trace['object'] instanceof XmlFileLoader && 'doImport' === $trace['function']) {
+            if (__DIR__ === dirname(realpath($trace['args'][3]))) {
+                trigger_deprecation('symfony/routing', '7.3', 'The "xdt.xml" routing configuration file is deprecated, import "xdt.php" instead.');
+
+                break;
+            }
+        }
+    }
+
     $routes->add('_wdt_stylesheet', '/styles')
         ->controller('web_profiler.controller.profiler::toolbarStylesheetAction')
     ;
