vendor/symfony/twig-bundle/CacheWarmer/TemplateCacheCacheWarmer.php line 14

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. @trigger_error('The '.TemplateCacheCacheWarmer::class.' class is deprecated since version 4.4 and will be removed in 5.0; use Twig instead.', \E_USER_DEPRECATED);
  16. use Psr\Container\ContainerInterface;
  17. use Symfony\Bundle\FrameworkBundle\CacheWarmer\TemplateFinderInterface;
  18. use Symfony\Bundle\TwigBundle\DependencyInjection\CompatibilityServiceSubscriberInterface as ServiceSubscriberInterface;
  19. use Symfony\Component\Finder\Finder;
  20. use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
  21. use Twig\Environment;
  22. use Twig\Error\Error;
  24. /**
  25.  * Generates the Twig cache for all templates.
  26.  *
  27.  * This warmer must be registered after TemplatePathsCacheWarmer,
  28.  * as the Twig loader will need the cache generated by it.
  29.  *
  30.  * @author Fabien Potencier <fabien@symfony.com>
  31.  *
  32.  * @deprecated since version 4.4, to be removed in 5.0; use Twig instead.
  33.  */
  34. class TemplateCacheCacheWarmer implements CacheWarmerInterface, ServiceSubscriberInterface
  35. {
  36.     protected $container;
  37.     protected $finder;
  38.     private $paths;
  40.     /**
  41.      * @param array $paths Additional twig paths to warm
  42.      */
  43.     public function __construct(ContainerInterface $container, TemplateFinderInterface $finder = null, array $paths = [])
  44.     {
  45.         // We don't inject the Twig environment directly as it depends on the
  46.         // template locator (via the loader) which might be a cached one.
  47.         // The cached template locator is available once the TemplatePathsCacheWarmer
  48.         // has been warmed up.
  49.         // But it can also be null if templating has been disabled.
  50.         $this->container = $container;
  51.         $this->finder = $finder;
  52.         $this->paths = $paths;
  53.     }
  55.     /**
  56.      * Warms up the cache.
  57.      *
  58.      * @param string $cacheDir The cache directory
  59.      */
  60.     public function warmUp($cacheDir)
  61.     {
  62.         if (null === $this->finder) {
  63.             return;
  64.         }
  66.         $twig = $this->container->get('twig');
  68.         $templates = $this->finder->findAllTemplates();
  70.         foreach ($this->paths as $path => $namespace) {
  71.             $templates = array_merge($templates, $this->findTemplatesInFolder($namespace, $path));
  72.         }
  74.         foreach ($templates as $template) {
  75.             try {
  76.                 $twig->load($template);
  77.             } catch (Error $e) {
  78.                 // problem during compilation, give up
  79.             }
  80.         }
  81.     }
  83.     /**
  84.      * Checks whether this warmer is optional or not.
  85.      *
  86.      * @return bool always true
  87.      */
  88.     public function isOptional()
  89.     {
  90.         return true;
  91.     }
  93.     /**
  94.      * {@inheritdoc}
  95.      */
  96.     public static function getSubscribedServices()
  97.     {
  98.         return [
  99.             'twig' => Environment::class,
  100.         ];
  101.     }
  103.     /**
  104.      * Find templates in the given directory.
  105.      */
  106.     private function findTemplatesInFolder(?string $namespace, string $dir): array
  107.     {
  108.         if (!is_dir($dir)) {
  109.             return [];
  110.         }
  112.         $templates = [];
  113.         $finder = new Finder();
  115.         foreach ($finder->files()->followLinks()->in($dir) as $file) {
  116.             $name = $file->getRelativePathname();
  117.             $templates[] = $namespace ? sprintf('@%s/%s', $namespace, $name) : $name;
  118.         }
  120.         return $templates;
  121.     }
  122. }