vendor/shopware/core/Framework/Adapter/Twig/EntityTemplateLoader.php line 40

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\Adapter\Twig;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Framework\DependencyInjection\CompilerPass\TwigLoaderConfigCompilerPass;
  7. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  8. use Symfony\Contracts\Service\ResetInterface;
  9. use Twig\Error\LoaderError;
  10. use Twig\Loader\LoaderInterface;
  11. use Twig\Source;
  13. class EntityTemplateLoader implements LoaderInterface, EventSubscriberInterface, ResetInterface
  14. {
  15.     private array $databaseTemplateCache = [];
  17.     private Connection $connection;
  19.     private string $environment;
  21.     public function __construct(Connection $connection, string $environment)
  22.     {
  23.         $this->connection = $connection;
  24.         $this->environment = $environment;
  25.     }
  27.     public static function getSubscribedEvents(): array
  28.     {
  29.         return ['app_template.written' => 'reset'];
  30.     }
  32.     /**
  33.      * @deprecated tag:v6.5.0 will be removed, use `reset()` instead
  34.      */
  35.     public function clearInternalCache(): void
  36.     {
  37.         $this->reset();
  38.     }
  40.     public function reset(): void
  41.     {
  42.         $this->databaseTemplateCache = [];
  43.     }
  45.     public function getSourceContext(string $name): Source
  46.     {
  47.         $template = $this->findDatabaseTemplate($name);
  49.         if (!$template) {
  50.             throw new LoaderError(sprintf('Template "%s" is not defined.', $name));
  51.         }
  53.         return new Source($template['template'], $name);
  54.     }
  56.     public function getCacheKey(string $name): string
  57.     {
  58.         return $name;
  59.     }
  61.     public function isFresh(string $name, int $time): bool
  62.     {
  63.         $template = $this->findDatabaseTemplate($name);
  64.         if (!$template) {
  65.             return false;
  66.         }
  68.         return $template['updatedAt'] === null || $template['updatedAt']->getTimestamp() < $time;
  69.     }
  71.     /**
  72.      * @return bool
  73.      */
  74.     public function exists(string $name)
  75.     {
  76.         $template = $this->findDatabaseTemplate($name);
  77.         if (!$template) {
  78.             return false;
  79.         }
  81.         return true;
  82.     }
  84.     private function findDatabaseTemplate(string $name): ?array
  85.     {
  86.         /*
  87.          * In dev env app templates are directly loaded over the filesystem
  88.          * @see TwigLoaderConfigCompilerPass::addAppTemplatePaths()
  89.          */
  90.         if ($this->environment === 'dev') {
  91.             return null;
  92.         }
  94.         $templateName = $this->splitTemplateName($name);
  95.         $namespace = $templateName['namespace'];
  96.         $path = $templateName['path'];
  98.         if (empty($this->databaseTemplateCache)) {
  99.             $templates = $this->connection->fetchAll('
  100.                 SELECT
  101.                     `app_template`.`path` AS `path`,
  102.                     `app_template`.`template` AS `template`,
  103.                     `app_template`.`updated_at` AS `updatedAt`,
  104.                     `app`.`name` AS `namespace`
  105.                 FROM `app_template`
  106.                 INNER JOIN `app` ON `app_template`.`app_id` = `app`.`id`
  107.                 WHERE `app_template`.`active` = 1 AND `app`.`active` = 1
  108.             ');
  110.             /** @var array $template */
  111.             foreach ($templates as $template) {
  112.                 $this->databaseTemplateCache[$template['path']][$template['namespace']] = [
  113.                     'template' => $template['template'],
  114.                     'updatedAt' => $template['updatedAt'] ? new \DateTimeImmutable($template['updatedAt']) : null,
  115.                 ];
  116.             }
  117.         }
  119.         if (\array_key_exists($path, $this->databaseTemplateCache) && \array_key_exists($namespace, $this->databaseTemplateCache[$path])) {
  120.             return $this->databaseTemplateCache[$path][$namespace];
  121.         }
  123.         // we have already loaded all DB templates
  124.         // if the namespace is not included return null
  125.         return $this->databaseTemplateCache[$path][$namespace] = null;
  126.     }
  128.     private function splitTemplateName(string $template): array
  129.     {
  130.         // remove static template inheritance prefix
  131.         if (mb_strpos($template, '@') !== 0) {
  132.             return ['path' => $template, 'namespace' => ''];
  133.         }
  135.         // remove "@"
  136.         $template = mb_substr($template, 1);
  138.         $template = explode('/', $template);
  139.         $namespace = array_shift($template);
  140.         $template = implode('/', $template);
  142.         return ['path' => $template, 'namespace' => $namespace];
  143.     }
  144. }