vendor/symfony/twig-bundle/CacheWarmer/TemplateCacheWarmer.php line 43

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Bundle\TwigBundle\CacheWarmer;
  14. use Psr\Container\ContainerInterface;
  15. use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
  16. use Symfony\Contracts\Service\ServiceSubscriberInterface;
  17. use Twig\Environment;
  18. use Twig\Error\Error;
  20. /**
  21.  * Generates the Twig cache for all templates.
  22.  *
  23.  * @author Fabien Potencier <fabien@symfony.com>
  24.  */
  25. class TemplateCacheWarmer implements CacheWarmerInterface, ServiceSubscriberInterface
  26. {
  27.     private $container;
  28.     private $twig;
  29.     private $iterator;
  31.     public function __construct(ContainerInterface $container, iterable $iterator)
  32.     {
  33.         // As this cache warmer is optional, dependencies should be lazy-loaded, that's why a container should be injected.
  34.         $this->container = $container;
  35.         $this->iterator = $iterator;
  36.     }
  38.     /**
  39.      * {@inheritdoc}
  40.      *
  41.      * @return string[] A list of template files to preload on PHP 7.4+
  42.      */
  43.     public function warmUp(string $cacheDir)
  44.     {
  45.         if (null === $this->twig) {
  46.             $this->twig = $this->container->get('twig');
  47.         }
  49.         $files = [];
  51.         foreach ($this->iterator as $template) {
  52.             try {
  53.                 $template = $this->twig->load($template);
  55.                 if (\is_callable([$template, 'unwrap'])) {
  56.                     $files[] = (new \ReflectionClass($template->unwrap()))->getFileName();
  57.                 }
  58.             } catch (Error $e) {
  59.                 /*
  60.                  * Problem during compilation, give up for this template (e.g. syntax errors).
  61.                  * Failing silently here allows to ignore templates that rely on functions that aren't available in
  62.                  * the current environment. For example, the WebProfilerBundle shouldn't be available in the prod
  63.                  * environment, but some templates that are never used in prod might rely on functions the bundle provides.
  64.                  * As we can't detect which templates are "really" important, we try to load all of them and ignore
  65.                  * errors. Error checks may be performed by calling the lint:twig command.
  66.                  */
  67.             }
  68.         }
  70.         return $files;
  71.     }
  73.     /**
  74.      * {@inheritdoc}
  75.      */
  76.     public function isOptional()
  77.     {
  78.         return true;
  79.     }
  81.     /**
  82.      * {@inheritdoc}
  83.      */
  84.     public static function getSubscribedServices()
  85.     {
  86.         return [
  87.             'twig' => Environment::class,
  88.         ];
  89.     }
  90. }