[FrameworkBundle] Add router.ignore_cache config option

okhoshi · okhoshi · commit 7d538db99a23 · 2024-03-23T22:53:49.000+01:00
Signed-off-by: Quentin Devos &lt;4972091+Okhoshi@users.noreply.github.com&gt;
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -13,6 +13,7 @@ CHANGELOG
  * Add `secrets:reveal` command
  * Add `rate_limiter` option to `http_client.default_options` and `http_client.scoped_clients`
  * Attach the workflow's configuration to the `workflow` tag
+ * Add `router.ignore_cache` config option
 
 7.0
 ---
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -619,8 +619,9 @@ private function addRouterSection(ArrayNodeDefinition $rootNode): void
                         ->scalarNode('type')->end()
                         ->scalarNode('cache_dir')
                             ->defaultValue('%kernel.build_dir%')
-                            ->setDeprecated('symfony/framework-bundle', '7.1', 'Setting the "%path%.%node%" configuration option is deprecated. It will be removed in version 8.0.')
+                            ->setDeprecated('symfony/framework-bundle', '7.1', 'Setting the "%path%.%node%" configuration option is deprecated. It will be removed in version 8.0. Please use the "ignore_cache" option if you want to ignore the cache in the router.')
                         ->end()
+                        ->booleanNode('ignore_cache')->defaultFalse()->end()
                         ->scalarNode('default_uri')
                             ->info('The default URI used to generate URLs in a non-HTTP context')
                             ->defaultNull()
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -1181,6 +1181,10 @@ private function registerRouterConfiguration(array $config, ContainerBuilder $co
 
         $container->setParameter('router.resource', $config['resource']);
         $container->setParameter('router.cache_dir', $config['cache_dir']);
+        if ($config['ignore_cache']) {
+            $container->setParameter('router.cache_dir', null);
+        }
+
         $router = $container->findDefinition('router.default');
         $argument = $router->getArgument(2);
         $argument['strict_requirements'] = $config['strict_requirements'];
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd b/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd
@@ -120,6 +120,7 @@
         <xsd:attribute name="utf8" type="xsd:boolean" />
         <xsd:attribute name="default-uri" type="xsd:string" />
         <xsd:attribute name="cache-dir" type="xsd:string" />
+        <xsd:attribute name="ignore-cache" type="xsd:boolean" />
     </xsd:complexType>
 
     <xsd:complexType name="session">
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php
@@ -715,6 +715,7 @@ protected static function getBundleDefaultConfig()
                 'strict_requirements' => true,
                 'utf8' => true,
                 'cache_dir' => '%kernel.build_dir%',
+                'ignore_cache' => false,
             ],
             'session' => [
                 'enabled' => false,
