decoupled Twig from the Templating system

symfony · Jan 10, 2015 · 0d537c4 · 0d537c4
1 parent be5a208
commit 0d537c4
Show file tree

Hide file tree

Showing 7 changed files with 108 additions and 66 deletions.
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -458,7 +458,6 @@ private function registerRequestConfiguration(array $config, ContainerBuilder $c
     private function registerTemplatingConfiguration(array $config, $ide, ContainerBuilder $container, XmlFileLoader $loader)
     {
         $loader->load('templating.xml');
-        $loader->load('templating_php.xml');
 
         $links = array(
             'textmate' => 'txmt://open?url=file://%%f&line=%%l',
@@ -468,39 +467,36 @@ private function registerTemplatingConfiguration(array $config, $ide, ContainerB
         );
 
         $container->setParameter('templating.helper.code.file_link_format', isset($links[$ide]) ? $links[$ide] : $ide);
-        $container->setParameter('templating.helper.form.resources', $config['form']['resources']);
         $container->setParameter('fragment.renderer.hinclude.global_template', $config['hinclude_default_template']);
 
-        if ($container->getParameter('kernel.debug')) {
-            $loader->load('templating_debug.xml');
-
-            $logger = new Reference('logger', ContainerInterface::IGNORE_ON_INVALID_REFERENCE);
-
-            $container->getDefinition('templating.loader.cache')
-                ->addTag('monolog.logger', array('channel' => 'templating'))
-                ->addMethodCall('setLogger', array($logger));
-            $container->getDefinition('templating.loader.chain')
-                ->addTag('monolog.logger', array('channel' => 'templating'))
-                ->addMethodCall('setLogger', array($logger));
-
-            $container->setDefinition('templating.engine.php', $container->findDefinition('debug.templating.engine.php'));
-            $container->setAlias('debug.templating.engine.php', 'templating.engine.php');
-        }
+        $loader->load('old_assets.xml');
 
         // create package definitions and add them to the assets helper
-        $defaultPackage = $this->createPackageDefinition($container, $config['assets_base_urls']['http'], $config['assets_base_urls']['ssl'], $config['assets_version'], $config['assets_version_format']);
+        $defaultPackage = $this->createTemplatingPackageDefinition($container, $config['assets_base_urls']['http'], $config['assets_base_urls']['ssl'], $config['assets_version'], $config['assets_version_format']);
         $container->setDefinition('templating.asset.default_package', $defaultPackage);
         $namedPackages = array();
         foreach ($config['packages'] as $name => $package) {
-            $namedPackage = $this->createPackageDefinition($container, $package['base_urls']['http'], $package['base_urls']['ssl'], $package['version'], $package['version_format'], $name);
+            $namedPackage = $this->createTemplatingPackageDefinition($container, $package['base_urls']['http'], $package['base_urls']['ssl'], $package['version'], $package['version_format'], $name);
             $container->setDefinition('templating.asset.package.'.$name, $namedPackage);
             $namedPackages[$name] = new Reference('templating.asset.package.'.$name);
         }
+
         $container->getDefinition('templating.helper.assets')->setArguments(array(
             new Reference('templating.asset.default_package'),
             $namedPackages,
         ));
 
+        if ($container->getParameter('kernel.debug')) {
+            $logger = new Reference('logger', ContainerInterface::IGNORE_ON_INVALID_REFERENCE);
+
+            $container->getDefinition('templating.loader.cache')
+                ->addTag('monolog.logger', array('channel' => 'templating'))
+                ->addMethodCall('setLogger', array($logger));
+            $container->getDefinition('templating.loader.chain')
+                ->addTag('monolog.logger', array('channel' => 'templating'))
+                ->addMethodCall('setLogger', array($logger));
+        }
+
         if (!empty($config['loaders'])) {
             $loaders = array_map(function ($loader) { return new Reference($loader); }, $config['loaders']);
 
@@ -530,14 +526,6 @@ private function registerTemplatingConfiguration(array $config, $ide, ContainerB
             $container->findDefinition('templating.locator')->getClass(),
         ));
 
-        if (in_array('php', $config['engines'], true)) {
-            $this->addClassesToCompile(array(
-                'Symfony\\Component\\Templating\\Storage\\FileStorage',
-                'Symfony\\Bundle\\FrameworkBundle\\Templating\\PhpEngine',
-                'Symfony\\Bundle\\FrameworkBundle\\Templating\\Loader\\FilesystemLoader',
-            ));
-        }
-
         $container->setParameter('templating.engines', $config['engines']);
         $engines = array_map(function ($engine) { return new Reference('templating.engine.'.$engine); }, $config['engines']);
 
@@ -550,12 +538,32 @@ private function registerTemplatingConfiguration(array $config, $ide, ContainerB
             }
             $container->setAlias('templating', 'templating.engine.delegating');
         }
+
+        // configure the PHP engine if needed
+        if (in_array('php', $config['engines'], true)) {
+            $loader->load('templating_php.xml');
+
+            $container->setParameter('templating.helper.form.resources', $config['form']['resources']);
+
+            if ($container->getParameter('kernel.debug')) {
+                $loader->load('templating_debug.xml');
+
+                $container->setDefinition('templating.engine.php', $container->findDefinition('debug.templating.engine.php'));
+                $container->setAlias('debug.templating.engine.php', 'templating.engine.php');
+            }
+
+            $this->addClassesToCompile(array(
+                'Symfony\\Component\\Templating\\Storage\\FileStorage',
+                'Symfony\\Bundle\\FrameworkBundle\\Templating\\PhpEngine',
+                'Symfony\\Bundle\\FrameworkBundle\\Templating\\Loader\\FilesystemLoader',
+            ));
+        }
     }
 
     /**
      * Returns a definition for an asset package.
      */
-    private function createPackageDefinition(ContainerBuilder $container, array $httpUrls, array $sslUrls, $version, $format, $name = null)
+    private function createTemplatingPackageDefinition(ContainerBuilder $container, array $httpUrls, array $sslUrls, $version, $format, $name = null)
     {
         if (!$httpUrls) {
             $package = new DefinitionDecorator('templating.asset.path_package');

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/old_assets.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/old_assets.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <parameters>
+        <parameter key="templating.asset.path_package.class">Symfony\Bundle\FrameworkBundle\Templating\Asset\PathPackage</parameter>
+        <parameter key="templating.asset.url_package.class">Symfony\Component\Templating\Asset\UrlPackage</parameter>
+        <parameter key="templating.asset.package_factory.class">Symfony\Bundle\FrameworkBundle\Templating\Asset\PackageFactory</parameter>
+    </parameters>
+
+    <services>
+        <service id="templating.asset.path_package" class="%templating.asset.path_package.class%" abstract="true">
+            <argument type="service" id="request" />
+            <argument /> <!-- version -->
+            <argument /> <!-- version format -->
+        </service>
+
+        <service id="templating.asset.url_package" class="%templating.asset.url_package.class%" abstract="true">
+            <argument /> <!-- base urls -->
+            <argument /> <!-- version -->
+            <argument /> <!-- version format -->
+        </service>
+
+        <service id="templating.asset.request_aware_package" class="Symfony\Component\Templating\Asset\PackageInterface" abstract="true">
+            <factory service="templating.asset.package_factory" method="getPackage" />
+            <argument type="service" id="request" strict="false" />
+            <argument /> <!-- HTTP id -->
+            <argument /> <!-- SSL id -->
+        </service>
+
+        <service id="templating.asset.package_factory" class="%templating.asset.package_factory.class%">
+            <argument type="service" id="service_container" />
+        </service>
+    </services>
+</container>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/templating.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/templating.xml
@@ -14,6 +14,7 @@
         <parameter key="templating.loader.cache.class">Symfony\Component\Templating\Loader\CacheLoader</parameter>
         <parameter key="templating.loader.chain.class">Symfony\Component\Templating\Loader\ChainLoader</parameter>
         <parameter key="templating.finder.class">Symfony\Bundle\FrameworkBundle\CacheWarmer\TemplateFinder</parameter>
+        <parameter key="templating.helper.assets.class">Symfony\Component\Templating\Helper\CoreAssetsHelper</parameter>
     </parameters>
 
     <services>
@@ -58,5 +59,15 @@
         </service>
 
         <service id="templating.loader" alias="templating.loader.filesystem" />
+
+        <!--
+            This should be in templating_php.xml but unfortunately, Twig depends on this helper.
+            As the Twig extension depending on this service is deprecated, this will be removed in 3.0.
+        -->
+        <service id="templating.helper.assets" class="%templating.helper.assets.class%">
+            <tag name="templating.helper" alias="assets" />
+            <argument /> <!-- default package -->
+            <argument type="collection" /> <!-- named packages -->
+        </service>
     </services>
 </container>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/templating_php.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/templating_php.xml
@@ -7,7 +7,6 @@
     <parameters>
         <parameter key="templating.engine.php.class">Symfony\Bundle\FrameworkBundle\Templating\PhpEngine</parameter>
         <parameter key="templating.helper.slots.class">Symfony\Component\Templating\Helper\SlotsHelper</parameter>
-        <parameter key="templating.helper.assets.class">Symfony\Component\Templating\Helper\CoreAssetsHelper</parameter>
         <parameter key="templating.helper.actions.class">Symfony\Bundle\FrameworkBundle\Templating\Helper\ActionsHelper</parameter>
         <parameter key="templating.helper.router.class">Symfony\Bundle\FrameworkBundle\Templating\Helper\RouterHelper</parameter>
         <parameter key="templating.helper.request.class">Symfony\Bundle\FrameworkBundle\Templating\Helper\RequestHelper</parameter>
@@ -19,9 +18,6 @@
         <parameter key="templating.form.engine.class">Symfony\Component\Form\Extension\Templating\TemplatingRendererEngine</parameter>
         <parameter key="templating.form.renderer.class">Symfony\Component\Form\FormRenderer</parameter>
         <parameter key="templating.globals.class">Symfony\Bundle\FrameworkBundle\Templating\GlobalVariables</parameter>
-        <parameter key="templating.asset.path_package.class">Symfony\Bundle\FrameworkBundle\Templating\Asset\PathPackage</parameter>
-        <parameter key="templating.asset.url_package.class">Symfony\Component\Templating\Asset\UrlPackage</parameter>
-        <parameter key="templating.asset.package_factory.class">Symfony\Bundle\FrameworkBundle\Templating\Asset\PackageFactory</parameter>
     </parameters>
 
     <services>
@@ -37,35 +33,6 @@
             <tag name="templating.helper" alias="slots" />
         </service>
 
-        <service id="templating.helper.assets" class="%templating.helper.assets.class%">
-            <tag name="templating.helper" alias="assets" />
-            <argument /> <!-- default package -->
-            <argument type="collection" /> <!-- named packages -->
-        </service>
-
-        <service id="templating.asset.path_package" class="%templating.asset.path_package.class%" abstract="true">
-            <argument type="service" id="request" />
-            <argument /> <!-- version -->
-            <argument /> <!-- version format -->
-        </service>
-
-        <service id="templating.asset.url_package" class="%templating.asset.url_package.class%" abstract="true">
-            <argument /> <!-- base urls -->
-            <argument /> <!-- version -->
-            <argument /> <!-- version format -->
-        </service>
-
-        <service id="templating.asset.request_aware_package" class="Symfony\Component\Templating\Asset\PackageInterface" abstract="true">
-            <factory service="templating.asset.package_factory" method="getPackage" />
-            <argument type="service" id="request" strict="false" />
-            <argument /> <!-- HTTP id -->
-            <argument /> <!-- SSL id -->
-        </service>
-
-        <service id="templating.asset.package_factory" class="%templating.asset.package_factory.class%">
-            <argument type="service" id="service_container" />
-        </service>
-
         <service id="templating.helper.request" class="%templating.helper.request.class%">
             <tag name="templating.helper" alias="request" />
             <argument type="service" id="request_stack" />

diff --git a/src/Symfony/Bundle/TwigBundle/DependencyInjection/Compiler/ExtensionPass.php b/src/Symfony/Bundle/TwigBundle/DependencyInjection/Compiler/ExtensionPass.php
@@ -46,5 +46,24 @@ public function process(ContainerBuilder $container)
         if ($container->has('request_stack')) {
             $container->getDefinition('twig.extension.httpfoundation')->addTag('twig.extension');
         }
+
+        if ($container->hasParameter('templating.helper.code.file_link_format')) {
+            $container->getDefinition('twig.extension.code')->replaceArgument(0, $container->getParameter('templating.helper.code.file_link_format'));
+        }
+
+        if ($container->has('templating')) {
+            $container->getDefinition('twig.cache_warmer')->addTag('kernel.cache_warmer');
+
+            if ($container->getParameter('kernel.debug')) {
+                $container->setDefinition('templating.engine.twig', $container->findDefinition('debug.templating.engine.twig'));
+                $container->setAlias('debug.templating.engine.twig', 'templating.engine.twig');
+            }
+        } else {
+            $loader = $container->getDefinition('twig.loader.native_filesystem');
+            $loader->addTag('twig.loader');
+            $loader->setMethodCalls($container->getDefinition('twig.loader.filesystem')->getMethodCalls());
+
+            $container->setDefinition('twig.loader.filesystem', $loader);
+        }
     }
 }
diff --git a/src/Symfony/Bundle/TwigBundle/DependencyInjection/TwigExtension.php b/src/Symfony/Bundle/TwigBundle/DependencyInjection/TwigExtension.php
@@ -103,9 +103,6 @@ public function load(array $configs, ContainerBuilder $container)
 
         if ($container->getParameter('kernel.debug')) {
             $loader->load('debug.xml');
-
-            $container->setDefinition('templating.engine.twig', $container->findDefinition('debug.templating.engine.twig'));
-            $container->setAlias('debug.templating.engine.twig', 'templating.engine.twig');
         }
 
         if (isset($config['autoescape_service']) && isset($config['autoescape_service_method'])) {

diff --git a/src/Symfony/Bundle/TwigBundle/Resources/config/twig.xml b/src/Symfony/Bundle/TwigBundle/Resources/config/twig.xml
@@ -47,11 +47,14 @@
         </service>
 
         <service id="twig.cache_warmer" class="%twig.cache_warmer.class%" public="false">
-            <tag name="kernel.cache_warmer" />
             <argument type="service" id="service_container" />
             <argument type="service" id="templating.finder" />
         </service>
 
+        <service id="twig.loader.native_filesystem" class="Twig_Loader_Filesystem" public="false">
+            <argument type="collection" />
+        </service>
+
         <service id="twig.loader.filesystem" class="%twig.loader.filesystem.class%" public="false">
             <argument type="service" id="templating.locator" />
             <argument type="service" id="templating.name_parser" />
@@ -84,7 +87,7 @@
 
         <service id="twig.extension.code" class="%twig.extension.code.class%" public="false">
             <tag name="twig.extension" />
-            <argument>%templating.helper.code.file_link_format%</argument>
+            <argument /> <!-- %templating.helper.code.file_link_format% -->
             <argument>%kernel.root_dir%</argument>
             <argument>%kernel.charset%</argument>
         </service>