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

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\DevOps\Environment\EnvironmentHelper;
  7. use Shopware\Core\Framework\DependencyInjection\CompilerPass\TwigLoaderConfigCompilerPass;
  8. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  9. use Symfony\Contracts\Service\ResetInterface;
  10. use Twig\Error\LoaderError;
  11. use Twig\Loader\LoaderInterface;
  12. use Twig\Source;
  14. class EntityTemplateLoader implements LoaderInterface, EventSubscriberInterface, ResetInterface
  15. {
  16.     private array $databaseTemplateCache = [];
  18.     private Connection $connection;
  20.     private string $environment;
  22.     public function __construct(Connection $connection, string $environment)
  23.     {
  24.         $this->connection = $connection;
  25.         $this->environment = $environment;
  26.     }
  28.     public static function getSubscribedEvents(): array
  29.     {
  30.         return ['app_template.written' => 'reset'];
  31.     }
  33.     /**
  34.      * @deprecated tag:v6.5.0 will be removed, use `reset()` instead
  35.      */
  36.     public function clearInternalCache(): void
  37.     {
  38.         $this->reset();
  39.     }
  41.     public function reset(): void
  42.     {
  43.         $this->databaseTemplateCache = [];
  44.     }
  46.     public function getSourceContext(string $name): Source
  47.     {
  48.         $template = $this->findDatabaseTemplate($name);
  50.         if (!$template) {
  51.             throw new LoaderError(sprintf('Template "%s" is not defined.', $name));
  52.         }
  54.         return new Source($template['template'], $name);
  55.     }
  57.     public function getCacheKey(string $name): string
  58.     {
  59.         return $name;
  60.     }
  62.     public function isFresh(string $name, int $time): bool
  63.     {
  64.         $template = $this->findDatabaseTemplate($name);
  65.         if (!$template) {
  66.             return false;
  67.         }
  69.         return $template['updatedAt'] === null || $template['updatedAt']->getTimestamp() < $time;
  70.     }
  72.     /**
  73.      * @return bool
  74.      */
  75.     public function exists(string $name)
  76.     {
  77.         $template = $this->findDatabaseTemplate($name);
  78.         if (!$template) {
  79.             return false;
  80.         }
  82.         return true;
  83.     }
  85.     private function findDatabaseTemplate(string $name): ?array
  86.     {
  87.         if (EnvironmentHelper::getVariable('DISABLE_EXTENSIONS', false)) {
  88.             return null;
  89.         }
  91.         /*
  92.          * In dev env app templates are directly loaded over the filesystem
  93.          * @see TwigLoaderConfigCompilerPass::addAppTemplatePaths()
  94.          */
  95.         if ($this->environment === 'dev') {
  96.             return null;
  97.         }
  99.         $templateName = $this->splitTemplateName($name);
  100.         $namespace = $templateName['namespace'];
  101.         $path = $templateName['path'];
  103.         if (empty($this->databaseTemplateCache)) {
  104.             $templates = $this->connection->fetchAll('
  105.                 SELECT
  106.                     `app_template`.`path` AS `path`,
  107.                     `app_template`.`template` AS `template`,
  108.                     `app_template`.`updated_at` AS `updatedAt`,
  109.                     `app`.`name` AS `namespace`
  110.                 FROM `app_template`
  111.                 INNER JOIN `app` ON `app_template`.`app_id` = `app`.`id`
  112.                 WHERE `app_template`.`active` = 1 AND `app`.`active` = 1
  113.             ');
  115.             /** @var array $template */
  116.             foreach ($templates as $template) {
  117.                 $this->databaseTemplateCache[$template['path']][$template['namespace']] = [
  118.                     'template' => $template['template'],
  119.                     'updatedAt' => $template['updatedAt'] ? new \DateTimeImmutable($template['updatedAt']) : null,
  120.                 ];
  121.             }
  122.         }
  124.         if (\array_key_exists($path, $this->databaseTemplateCache) && \array_key_exists($namespace, $this->databaseTemplateCache[$path])) {
  125.             return $this->databaseTemplateCache[$path][$namespace];
  126.         }
  128.         // we have already loaded all DB templates
  129.         // if the namespace is not included return null
  130.         return $this->databaseTemplateCache[$path][$namespace] = null;
  131.     }
  133.     private function splitTemplateName(string $template): array
  134.     {
  135.         // remove static template inheritance prefix
  136.         if (mb_strpos($template, '@') !== 0) {
  137.             return ['path' => $template, 'namespace' => ''];
  138.         }
  140.         // remove "@"
  141.         $template = mb_substr($template, 1);
  143.         $template = explode('/', $template);
  144.         $namespace = array_shift($template);
  145.         $template = implode('/', $template);
  147.         return ['path' => $template, 'namespace' => $namespace];
  148.     }
  149. }