[FrameworkBundle] [TwigBundle] Move the hinclude key away from templa…

…ting
symfony · fabpot · Apr 8, 2019 · Apr 7, 2019 · Apr 8, 2019 · 4f39339fec120ecc5078d287e0e9b80be1a9765a
commit 4f39339fec120ecc5078d287e0e9b80be1a9765a
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -191,6 +191,7 @@ private function addFragmentsSection(ArrayNodeDefinition $rootNode)
                    ->info('fragments configuration')
                    ->canBeEnabled()
                    ->children()
+                        ->scalarNode('hinclude_default_template')->defaultNull()->end()
                        ->scalarNode('path')->defaultValue('/_fragment')->end()
                    ->end()
                ->end()
@@ -610,7 +611,7 @@ private function addTemplatingSection(ArrayNodeDefinition $rootNode)
                        ->then(function () { return ['enabled' => false, 'engines' => false]; })
                    ->end()
                    ->children()
-                        ->scalarNode('hinclude_default_template')->defaultNull()->end()
+                        ->scalarNode('hinclude_default_template')->setDeprecated('Setting "templating.hinclude_default_template" is deprecated since Symfony 4.3, use "fragments.hinclude_default_template" instead.')->defaultNull()->end()
                        ->scalarNode('cache')->end()
                        ->arrayNode('form')
                            ->addDefaultsIfNotSet()

diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -487,6 +487,11 @@ private function registerFragmentsConfiguration(array $config, ContainerBuilder

            return;
        }
+        if ($container->hasParameter('fragment.renderer.hinclude.global_template') && null !== $container->getParameter('fragment.renderer.hinclude.global_template') && null !== $config['hinclude_default_template']) {
+            throw new \LogicException('You cannot set both "templating.hinclude_default_template" and "fragments.hinclude_default_template", please only use "fragments.hinclude_default_template".');
+        }
+
+        $container->setParameter('fragment.renderer.hinclude.global_template', $config['hinclude_default_template']);

        $loader->load('fragment_listener.xml');
        $container->setParameter('fragment.path', $config['path']);

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
@@ -69,6 +69,7 @@
    <xsd:complexType name="fragments">
        <xsd:attribute name="enabled" type="xsd:boolean" />
        <xsd:attribute name="path" type="xsd:string" />
+        <xsd:attribute name="hinclude-default-template" type="xsd:string" />
    </xsd:complexType>

    <xsd:complexType name="web_link">

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php
@@ -209,6 +209,7 @@ protected static function getBundleDefaultConfig()
            'fragments' => [
                'enabled' => false,
                'path' => '/_fragment',
+                'hinclude_default_template' => null,
            ],
            'profiler' => [
                'enabled' => false,

diff --git a/.../Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/template_and_fragments.php b/.../Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/template_and_fragments.php
@@ -0,0 +1,18 @@
+<?php
+
+$container->loadFromExtension('framework', [
+    'templating' => [
+        'cache' => '/path/to/cache',
+        'engines' => ['php', 'twig'],
+        'loader' => ['loader.foo', 'loader.bar'],
+        'form' => [
+            'resources' => ['theme1', 'theme2'],
+        ],
+        'hinclude_default_template' => 'global_hinclude_template',
+    ],
+    'assets' => null,
+    'fragments' => [
+        'enabled' => true,
+        'hinclude_default_template' => 'global_hinclude_template',
+    ],
+]);
diff --git a/.../Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/template_and_fragments.xml b/.../Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/template_and_fragments.xml
@@ -0,0 +1,24 @@
+<?xml version="1.0" ?>
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:framework="http://symfony.com/schema/dic/symfony"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
+        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
+
+    <framework:config>
+        <framework:fragments enabled="true" hinclude-default-template="global_hinclude_template"/>
+        <framework:esi enabled="true" />
+        <framework:ssi enabled="true" />
+        <framework:assets />
+        <framework:templating cache="/path/to/cache" hinclude-default-template="global_hinclude_template">
+            <framework:loader>loader.foo</framework:loader>
+            <framework:loader>loader.bar</framework:loader>
+            <framework:engine>php</framework:engine>
+            <framework:engine>twig</framework:engine>
+            <framework:form>
+                <framework:resource>theme1</framework:resource>
+                <framework:resource>theme2</framework:resource>
+            </framework:form>
+        </framework:templating>
+    </framework:config>
+</container>
diff --git a/.../Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/template_and_fragments.yml b/.../Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/template_and_fragments.yml
@@ -0,0 +1,12 @@
+framework:
+    fragments:
+        enabled: true
+        hinclude_default_template: global_hinclude_template
+    templating:
+        engines:          [php, twig]
+        loader:           [loader.foo, loader.bar]
+        cache:            /path/to/cache
+        form:
+            resources:    [theme1, theme2]
+        hinclude_default_template: global_hinclude_template
+    assets: ~
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -159,6 +159,14 @@ public function testEsiDisabled()
        $this->assertFalse($container->hasDefinition('esi'));
    }

+    /**
+     * @expectedException \LogicException
+     */
+    public function testAmbiguousWhenBothTemplatingAndFragments()
+    {
+        $this->createContainerFromFile('template_and_fragments');
+    }
+
    public function testSsi()
    {
        $container = $this->createContainerFromFile('full');
-Original file line number
+Diff line change
@@ -487,6 +487,11 @@ private function registerFragmentsConfiguration(array $config, ContainerBuilder
                 return;
             }
+            if ($container->hasParameter('fragment.renderer.hinclude.global_template') && null !== $container->getParameter('fragment.renderer.hinclude.global_template') && null !== $config['hinclude_default_template']) {
+                throw new \LogicException('You cannot set both "templating.hinclude_default_template" and "fragments.hinclude_default_template", please only use "fragments.hinclude_default_template".');
+            }
+            $container->setParameter('fragment.renderer.hinclude.global_template', $config['hinclude_default_template']);
                   Simperfit marked this conversation as resolved.
              

          
            Show resolved
            Hide resolved
        

                
  
            
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.
             $loader->load('fragment_listener.xml');
             $container->setParameter('fragment.path', $config['path']);
-          Expand Down