vendor/shopware/core/Framework/Adapter/Twig/TemplateFinder.php line 59

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\Adapter\Twig;
  5. use Shopware\Core\Framework\Adapter\Twig\NamespaceHierarchy\NamespaceHierarchyBuilder;
  6. use Symfony\Contracts\Service\ResetInterface;
  7. use Twig\Cache\FilesystemCache;
  8. use Twig\Environment;
  9. use Twig\Error\LoaderError;
  10. use Twig\Loader\LoaderInterface;
  12. class TemplateFinder implements TemplateFinderInterface, ResetInterface
  13. {
  14.     private Environment $twig;
  16.     private LoaderInterface $loader;
  18.     /**
  19.      * @var string[]
  20.      */
  21.     private array $namespaceHierarchy = [];
  23.     private string $cacheDir;
  25.     private NamespaceHierarchyBuilder $namespaceHierarchyBuilder;
  27.     /**
  28.      * @internal
  29.      */
  30.     public function __construct(
  31.         Environment $twig,
  32.         LoaderInterface $loader,
  33.         string $cacheDir,
  34.         NamespaceHierarchyBuilder $namespaceHierarchyBuilder
  35.     ) {
  36.         $this->twig = $twig;
  37.         $this->loader = $loader;
  38.         $this->cacheDir = $cacheDir . '/twig';
  39.         $this->namespaceHierarchyBuilder = $namespaceHierarchyBuilder;
  40.     }
  42.     public function getTemplateName(string $template): string
  43.     {
  44.         //remove static template inheritance prefix
  45.         if (mb_strpos($template, '@') !== 0) {
  46.             return $template;
  47.         }
  49.         $template = explode('/', $template);
  50.         array_shift($template);
  51.         $template = implode('/', $template);
  53.         return $template;
  54.     }
  56.     /**
  57.      * {@inheritdoc}
  58.      */
  59.     public function find(string $template, $ignoreMissing = false, ?string $source = null): string
  60.     {
  61.         $templatePath = $this->getTemplateName($template);
  62.         $sourcePath = $source ? $this->getTemplateName($source) : null;
  63.         $sourceBundleName = $source ? $this->getSourceBundleName($source) : null;
  64.         $originalTemplate = $source ? null : $template;
  66.         $queue = $this->getNamespaceHierarchy();
  67.         $modifiedQueue = $queue;
  69.         // If we are trying to load the same file as the template, we do are not allowed to search the hierarchy
  70.         // up to the source file as that has already been searched and that would lead to an endless template inheritance.
  72.         if ($sourceBundleName !== null && $sourcePath === $templatePath) {
  73.             $index = \array_search($sourceBundleName, $modifiedQueue, true);
  75.             if (\is_int($index)) {
  76.                 $modifiedQueue = \array_merge(\array_slice($modifiedQueue, $index + 1), \array_slice($queue, 0, $index));
  77.             }
  78.         }
  80.         // iterate over all bundles but exclude the originally requested bundle
  81.         // example: if @Storefront/storefront/index.html.twig is requested, all bundles except Storefront will be checked first
  82.         foreach ($modifiedQueue as $prefix) {
  83.             $name = '@' . $prefix . '/' . $templatePath;
  85.             // original template is loaded last
  86.             if ($name === $originalTemplate) {
  87.                 continue;
  88.             }
  90.             if (!$this->loader->exists($name)) {
  91.                 continue;
  92.             }
  94.             return $name;
  95.         }
  97.         // Throw a useful error when the template cannot be found
  98.         if ($originalTemplate === null) {
  99.             if ($ignoreMissing === true) {
  100.                 return $templatePath;
  101.             }
  103.             throw new LoaderError(sprintf('Unable to load template "%s". (Looked into: %s)', $templatePath, implode(', ', array_values($modifiedQueue))));
  104.         }
  106.         // if no other bundle extends the requested template, load the original template
  107.         if ($this->loader->exists($originalTemplate)) {
  108.             return $originalTemplate;
  109.         }
  111.         if ($ignoreMissing === true) {
  112.             return $templatePath;
  113.         }
  115.         throw new LoaderError(sprintf('Unable to load template "%s". (Looked into: %s)', $templatePath, implode(', ', array_values($modifiedQueue))));
  116.     }
  118.     public function reset(): void
  119.     {
  120.         $this->namespaceHierarchy = [];
  121.     }
  123.     private function getSourceBundleName(string $source): ?string
  124.     {
  125.         if (mb_strpos($source, '@') !== 0) {
  126.             return null;
  127.         }
  129.         $source = explode('/', $source);
  130.         $source = array_shift($source);
  131.         $source = $source ? ltrim($source, '@') : null;
  133.         return $source ?: null;
  134.     }
  136.     /**
  137.      * @return string[]
  138.      */
  139.     private function getNamespaceHierarchy(): array
  140.     {
  141.         if ($this->namespaceHierarchy) {
  142.             return $this->namespaceHierarchy;
  143.         }
  145.         $namespaceHierarchy = $this->namespaceHierarchyBuilder->buildHierarchy();
  146.         $this->defineCache($namespaceHierarchy);
  148.         return $this->namespaceHierarchy = array_keys($namespaceHierarchy);
  149.     }
  151.     /**
  152.      * @param string[] $queue
  153.      */
  154.     private function defineCache(array $queue): void
  155.     {
  156.         if ($this->twig->getCache(false) instanceof FilesystemCache) {
  157.             $configHash = md5((string) json_encode($queue));
  159.             $fileSystemCache = new ConfigurableFilesystemCache($this->cacheDir);
  160.             $fileSystemCache->setConfigHash($configHash);
  161.             // Set individual twig cache for different configurations
  162.             $this->twig->setCache($fileSystemCache);
  163.         }
  164.     }
  165. }