vendor/contao/core-bundle/src/Twig/Loader/ContaoFilesystemLoaderWarmer.php line 92

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of Contao.
  7.  *
  8.  * (c) Leo Feyer
  9.  *
  10.  * @license LGPL-3.0-or-later
  11.  */
  13. namespace Contao\CoreBundle\Twig\Loader;
  15. use Contao\CoreBundle\Twig\ContaoTwigUtil;
  16. use Symfony\Component\Filesystem\Exception\IOException;
  17. use Symfony\Component\Filesystem\Filesystem;
  18. use Symfony\Component\Filesystem\Path;
  19. use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
  20. use Symfony\Component\HttpKernel\Event\RequestEvent;
  22. /**
  23.  * @experimental
  24.  */
  25. class ContaoFilesystemLoaderWarmer implements CacheWarmerInterface
  26. {
  27.     private ContaoFilesystemLoader $loader;
  28.     private TemplateLocator $templateLocator;
  29.     private string $projectDir;
  30.     private string $cacheDir;
  31.     private string $environment;
  32.     private ?Filesystem $filesystem;
  34.     public function __construct(ContaoFilesystemLoader $contaoFilesystemLoader, TemplateLocator $templateLocator, string $projectDir, string $cacheDir, string $environment, Filesystem $filesystem = null)
  35.     {
  36.         $this->loader = $contaoFilesystemLoader;
  37.         $this->templateLocator = $templateLocator;
  38.         $this->projectDir = $projectDir;
  39.         $this->cacheDir = $cacheDir;
  40.         $this->environment = $environment;
  41.         $this->filesystem = $filesystem;
  42.     }
  44.     public function warmUp(string $cacheDir = null): array
  45.     {
  46.         // Theme paths
  47.         $themePaths = $this->templateLocator->findThemeDirectories();
  49.         foreach ($themePaths as $slug => $path) {
  50.             $this->loader->addPath($path, "Contao_Theme_$slug", true);
  51.         }
  53.         // Global templates path
  54.         $globalTemplatesPath = Path::join($this->projectDir, 'templates');
  56.         $this->loader->addPath($globalTemplatesPath);
  57.         $this->loader->addPath($globalTemplatesPath, 'Contao_Global', true);
  59.         // Bundle paths (including App)
  60.         foreach ($this->templateLocator->findResourcesPaths() as $name => $resourcesPaths) {
  61.             foreach ($resourcesPaths as $path) {
  62.                 $this->loader->addPath($path);
  63.                 $this->loader->addPath($path, "Contao_$name", true);
  64.             }
  65.         }
  67.         $this->loader->buildInheritanceChains();
  68.         $this->loader->persist();
  70.         if ('dev' === $this->environment) {
  71.             $this->writeIdeAutoCompletionMapping($cacheDir ?? $this->cacheDir);
  72.         }
  74.         return [];
  75.     }
  77.     public function isOptional(): bool
  78.     {
  79.         return false;
  80.     }
  82.     public function refresh(): void
  83.     {
  84.         $this->loader->clear();
  86.         $this->warmUp();
  87.     }
  89.     /**
  90.      * Auto refresh in dev mode.
  91.      */
  92.     public function onKernelRequest(RequestEvent $event): void
  93.     {
  94.         if ('dev' === $this->environment && $event->isMainRequest()) {
  95.             $this->refresh();
  96.         }
  97.     }
  99.     /**
  100.      * Writes an "ide-twig.json" file with path mapping information that
  101.      * enables IDE auto-completion for all our dynamic namespaces.
  102.      */
  103.     private function writeIdeAutoCompletionMapping(string $cacheDir): void
  104.     {
  105.         $mappings = [];
  106.         $targetDir = Path::join($cacheDir, 'contao');
  108.         foreach ($this->loader->getInheritanceChains() as $chain) {
  109.             foreach ($chain as $path => $name) {
  110.                 $mappings[Path::getDirectory(Path::makeRelative($path, $targetDir))] = ContaoTwigUtil::parseContaoName($name)[0];
  111.             }
  112.         }
  114.         $data = [];
  116.         foreach ($mappings as $path => $namespace) {
  117.             $data['namespaces'][] = ['namespace' => 'Contao', 'path' => $path];
  118.             $data['namespaces'][] = compact('namespace', 'path');
  119.         }
  121.         if (null === $this->filesystem) {
  122.             $this->filesystem = new Filesystem();
  123.         }
  125.         try {
  126.             $this->filesystem->dumpFile(
  127.                 Path::join($targetDir, 'ide-twig.json'),
  128.                 json_encode($data, JSON_THROW_ON_ERROR | JSON_UNESCAPED_SLASHES)
  129.             );
  130.         } catch (IOException $e) {
  131.             // ignore
  132.         }
  133.     }
  134. }