Warmup twig templates in non-standard paths (closes #12507)

symfony · webmozart · Apr 21, 2015 · Jun 14, 2015 · Jun 20, 2015 · Jun 22, 2015
commit 96cce38b00c7c2186f082584eb468688e2d873d9
diff --git a/src/Symfony/Bundle/TwigBundle/CacheWarmer/TemplateCacheCacheWarmer.php b/src/Symfony/Bundle/TwigBundle/CacheWarmer/TemplateCacheCacheWarmer.php
@@ -11,9 +11,11 @@

 namespace Symfony\Bundle\TwigBundle\CacheWarmer;

+use Symfony\Component\Finder\Finder;
 use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Bundle\FrameworkBundle\CacheWarmer\TemplateFinderInterface;
+use Symfony\Component\Templating\TemplateReference;

 /**
 * Generates the Twig cache for all templates.
@@ -27,21 +29,24 @@ class TemplateCacheCacheWarmer implements CacheWarmerInterface
 {
    protected $container;
    protected $finder;
+    private $paths;

    /**
     * Constructor.
     *
     * @param ContainerInterface      $container The dependency injection container
     * @param TemplateFinderInterface $finder    The template paths cache warmer
+     * @param array                   $paths     Additional twig paths to warm
     */
-    public function __construct(ContainerInterface $container, TemplateFinderInterface $finder)
+    public function __construct(ContainerInterface $container, TemplateFinderInterface $finder, array $paths = array())
    {
        // We don't inject the Twig environment directly as it depends on the
        // template locator (via the loader) which might be a cached one.
        // The cached template locator is available once the TemplatePathsCacheWarmer
        // has been warmed up
        $this->container = $container;
        $this->finder = $finder;
+        $this->paths = $paths;
    }

    /**
@@ -53,7 +58,13 @@ public function warmUp($cacheDir)
    {
        $twig = $this->container->get('twig');

-        foreach ($this->finder->findAllTemplates() as $template) {
+        $templates = $this->finder->findAllTemplates();
+
+        foreach ($this->paths as $path => $namespace) {
+            $templates = array_merge($templates, $this->findTemplatesInFolder($namespace, $path));
+        }
+
+        foreach ($templates as $template) {
            if ('twig' !== $template->get('engine')) {
                continue;
            }
@@ -75,4 +86,32 @@ public function isOptional()
    {
        return true;
    }
+
+    /**
+     * Find templates in the given directory.
+     *
+     * @param string $namespace The namespace for these templates
+     * @param string $dir       The folder where to look for templates
+     *
+     * @return array An array of templates of type TemplateReferenceInterface
+     */
+    private function findTemplatesInFolder($namespace, $dir)
+    {
+        if (!is_dir($dir)) {
+            return array();
+        }
+
+        $templates = array();
+        $finder = new Finder();
+
+        foreach ($finder->files()->followLinks()->in($dir) as $file) {
+            $name = $file->getRelativePathname();
+            $templates[] = new TemplateReference(
+                $namespace ? sprintf('@%s/%s', $namespace, $name) : $name,
+                'twig'
+            );
+        }
+
+        return $templates;
+    }
 }
diff --git a/src/Symfony/Bundle/TwigBundle/DependencyInjection/TwigExtension.php b/src/Symfony/Bundle/TwigBundle/DependencyInjection/TwigExtension.php
@@ -77,6 +77,8 @@ public function load(array $configs, ContainerBuilder $container)
            }
        }

+        $container->getDefinition('twig.cache_warmer')->replaceArgument(2, $config['paths']);
+
        // register bundles as Twig namespaces
        foreach ($container->getParameter('kernel.bundles') as $bundle => $class) {
            $dir = $container->getParameter('kernel.root_dir').'/Resources/'.$bundle.'/views';

diff --git a/src/Symfony/Bundle/TwigBundle/Resources/config/twig.xml b/src/Symfony/Bundle/TwigBundle/Resources/config/twig.xml
@@ -48,6 +48,7 @@
        <service id="twig.cache_warmer" class="%twig.cache_warmer.class%" public="false">
            <argument type="service" id="service_container" />
            <argument type="service" id="templating.finder" />
+            <argument type="collection" /> <!-- Twig paths -->
        </service>

        <service id="twig.loader.native_filesystem" class="Twig_Loader_Filesystem" public="false">