src/Core/Framework/Adapter/Twig/TemplateFinder.php line 56

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