platform/src/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 Twig\Error\LoaderError;
  9. use Twig\Loader\LoaderInterface;
  10. use Twig\Source;
  12. class EntityTemplateLoader implements LoaderInterface, EventSubscriberInterface
  13. {
  14.     /**
  15.      * @var array
  16.      */
  17.     private $databaseTemplateCache = [];
  19.     /**
  20.      * @var Connection
  21.      */
  22.     private $connection;
  24.     /**
  25.      * @var string
  26.      */
  27.     private $environment;
  29.     public function __construct(Connection $connection, string $environment)
  30.     {
  31.         $this->connection = $connection;
  32.         $this->environment = $environment;
  33.     }
  35.     public static function getSubscribedEvents(): array
  36.     {
  37.         return ['app_template.written' => 'clearInternalCache'];
  38.     }
  40.     public function clearInternalCache(): 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.     public function exists(string $name)
  72.     {
  73.         $template = $this->findDatabaseTemplate($name);
  74.         if (!$template) {
  75.             return false;
  76.         }
  78.         return true;
  79.     }
  81.     private function findDatabaseTemplate(string $name): ?array
  82.     {
  83.         /*
  84.          * In dev env app templates are directly loaded over the filesystem
  85.          * @see TwigLoaderConfigCompilerPass::addAppTemplatePaths()
  86.          */
  87.         if ($this->environment === 'dev') {
  88.             return null;
  89.         }
  91.         $templateName = $this->splitTemplateName($name);
  92.         $namespace = $templateName['namespace'];
  93.         $path = $templateName['path'];
  95.         if (empty($this->databaseTemplateCache)) {
  96.             $templates = $this->connection->fetchAll('
  97.                 SELECT
  98.                     `app_template`.`path` AS `path`,
  99.                     `app_template`.`template` AS `template`,
  100.                     `app_template`.`updated_at` AS `updatedAt`,
  101.                     `app`.`name` AS `namespace`
  102.                 FROM `app_template`
  103.                 INNER JOIN `app` ON `app_template`.`app_id` = `app`.`id`
  104.                 WHERE `app_template`.`active` = 1 AND `app`.`active` = 1
  105.             ');
  107.             /** @var array $template */
  108.             foreach ($templates as $template) {
  109.                 $this->databaseTemplateCache[$template['path']][$template['namespace']] = [
  110.                     'template' => $template['template'],
  111.                     'updatedAt' => $template['updatedAt'] ? new \DateTimeImmutable($template['updatedAt']) : null,
  112.                 ];
  113.             }
  114.         }
  116.         if (\array_key_exists($path, $this->databaseTemplateCache) && \array_key_exists($namespace, $this->databaseTemplateCache[$path])) {
  117.             return $this->databaseTemplateCache[$path][$namespace];
  118.         }
  120.         // we have already loaded all DB templates
  121.         // if the namespace is not included return null
  122.         return $this->databaseTemplateCache[$path][$namespace] = null;
  123.     }
  125.     private function splitTemplateName(string $template): array
  126.     {
  127.         // remove static template inheritance prefix
  128.         if (mb_strpos($template, '@') !== 0) {
  129.             return ['path' => $template, 'namespace' => ''];
  130.         }
  132.         // remove "@"
  133.         $template = mb_substr($template, 1);
  135.         $template = explode('/', $template);
  136.         $namespace = array_shift($template);
  137.         $template = implode('/', $template);
  139.         return ['path' => $template, 'namespace' => $namespace];
  140.     }
  141. }