vendor/sylius/theme-bundle/src/Twig/Loader/ThemedTemplateLoader.php line 66

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Sylius package.
  5.  *
  6.  * (c) Paweł Jędrzejewski
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. declare(strict_types=1);
  14. namespace Sylius\Bundle\ThemeBundle\Twig\Loader;
  16. use Sylius\Bundle\ThemeBundle\Context\ThemeContextInterface;
  17. use Sylius\Bundle\ThemeBundle\Twig\Locator\TemplateLocatorInterface;
  18. use Sylius\Bundle\ThemeBundle\Twig\Locator\TemplateNotFoundException;
  19. use Symfony\Component\Templating\TemplateReferenceInterface;
  20. use Twig\Loader\LoaderInterface as TwigLoaderInterface;
  21. use Twig\Source;
  23. final class ThemedTemplateLoader implements LoaderInterface
  24. {
  25.     private TwigLoaderInterface $decoratedLoader;
  27.     private TemplateLocatorInterface $templateLocator;
  29.     private ThemeContextInterface $themeContext;
  31.     public function __construct(
  32.         TwigLoaderInterface $decoratedLoader,
  33.         TemplateLocatorInterface $templateLocator,
  34.         ThemeContextInterface $themeContext,
  35.     ) {
  36.         $this->decoratedLoader = $decoratedLoader;
  37.         $this->templateLocator = $templateLocator;
  38.         $this->themeContext = $themeContext;
  39.     }
  41.     /**
  42.      * @param string|TemplateReferenceInterface $name
  43.      */
  44.     public function getSourceContext($name): Source
  45.     {
  46.         try {
  47.             $path = $this->locateTemplate($name);
  49.             /** @psalm-suppress RedundantCastGivenDocblockType */
  50.             return new Source((string) file_get_contents($path), (string) $name, $path);
  51.         } catch (TemplateNotFoundException | \InvalidArgumentException $exception) {
  52.             /** @psalm-suppress PossiblyInvalidArgument */
  53.             return $this->decoratedLoader->getSourceContext($name);
  54.         }
  55.     }
  57.     /**
  58.      * @param string|TemplateReferenceInterface $name
  59.      */
  60.     public function getCacheKey($name): string
  61.     {
  62.         try {
  63.             return $this->locateTemplate($name);
  64.         } catch (TemplateNotFoundException | \InvalidArgumentException $exception) {
  65.             /** @psalm-suppress PossiblyInvalidArgument */
  66.             return $this->decoratedLoader->getCacheKey($name);
  67.         }
  68.     }
  70.     /**
  71.      * @param string|TemplateReferenceInterface $name
  72.      * @param int $time
  73.      */
  74.     public function isFresh($name, $time): bool
  75.     {
  76.         try {
  77.             return filemtime($this->locateTemplate($name)) <= $time;
  78.         } catch (TemplateNotFoundException | \InvalidArgumentException $exception) {
  79.             /** @psalm-suppress PossiblyInvalidArgument */
  80.             return $this->decoratedLoader->isFresh($name, $time);
  81.         }
  82.     }
  84.     /**
  85.      * @param string|TemplateReferenceInterface $name
  86.      */
  87.     public function exists($name): bool
  88.     {
  89.         try {
  90.             return stat($this->locateTemplate($name)) !== false;
  91.         } catch (TemplateNotFoundException | \InvalidArgumentException $exception) {
  92.             /** @psalm-suppress PossiblyInvalidArgument */
  93.             return $this->decoratedLoader->exists($name);
  94.         }
  95.     }
  97.     /**
  98.      * @psalm-assert string $template
  99.      *
  100.      * @param string|TemplateReferenceInterface $template
  101.      *
  102.      * @throws TemplateNotFoundException|\InvalidArgumentException
  103.      */
  104.     private function locateTemplate($template): string
  105.     {
  106.         if ($template instanceof TemplateReferenceInterface) {
  107.             // Symfony 4.x still pushes TemplateReferenceInterface to Twig loader (especially when warming up cache)
  108.             throw new \InvalidArgumentException(sprintf('Instances of "%s" are not supported.', TemplateReferenceInterface::class));
  109.         }
  111.         $theme = $this->themeContext->getTheme();
  113.         if ($theme === null) {
  114.             throw new TemplateNotFoundException($template, []);
  115.         }
  117.         return $this->templateLocator->locate($template, $theme);
  118.     }
  119. }