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

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 Shopware\Core\Framework\Feature;
  9. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  10. use Symfony\Contracts\Service\ResetInterface;
  11. use Twig\Error\LoaderError;
  12. use Twig\Loader\LoaderInterface;
  13. use Twig\Source;
  15. class EntityTemplateLoader implements LoaderInterface, EventSubscriberInterface, ResetInterface
  16. {
  17.     private array $databaseTemplateCache = [];
  19.     private Connection $connection;
  21.     private string $environment;
  23.     /**
  24.      * @internal
  25.      */
  26.     public function __construct(Connection $connection, string $environment)
  27.     {
  28.         $this->connection = $connection;
  29.         $this->environment = $environment;
  30.     }
  32.     public static function getSubscribedEvents(): array
  33.     {
  34.         return ['app_template.written' => 'reset'];
  35.     }
  37.     /**
  38.      * @deprecated tag:v6.5.0 will be removed, use `reset()` instead
  39.      */
  40.     public function clearInternalCache(): void
  41.     {
  42.         Feature::triggerDeprecationOrThrow(
  43.             'v6.5.0.0',
  44.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'reset()')
  45.         );
  47.         $this->reset();
  48.     }
  50.     public function reset(): void
  51.     {
  52.         $this->databaseTemplateCache = [];
  53.     }
  55.     public function getSourceContext(string $name): Source
  56.     {
  57.         $template = $this->findDatabaseTemplate($name);
  59.         if (!$template) {
  60.             throw new LoaderError(sprintf('Template "%s" is not defined.', $name));
  61.         }
  63.         return new Source($template['template'], $name);
  64.     }
  66.     public function getCacheKey(string $name): string
  67.     {
  68.         return $name;
  69.     }
  71.     public function isFresh(string $name, int $time): bool
  72.     {
  73.         $template = $this->findDatabaseTemplate($name);
  74.         if (!$template) {
  75.             return false;
  76.         }
  78.         return $template['updatedAt'] === null || $template['updatedAt']->getTimestamp() < $time;
  79.     }
  81.     /**
  82.      * @return bool
  83.      */
  84.     public function exists(string $name)
  85.     {
  86.         $template = $this->findDatabaseTemplate($name);
  87.         if (!$template) {
  88.             return false;
  89.         }
  91.         return true;
  92.     }
  94.     private function findDatabaseTemplate(string $name): ?array
  95.     {
  96.         if (EnvironmentHelper::getVariable('DISABLE_EXTENSIONS', false)) {
  97.             return null;
  98.         }
  100.         /*
  101.          * In dev env app templates are directly loaded over the filesystem
  102.          * @see TwigLoaderConfigCompilerPass::addAppTemplatePaths()
  103.          */
  104.         if ($this->environment === 'dev') {
  105.             return null;
  106.         }
  108.         $templateName = $this->splitTemplateName($name);
  109.         $namespace = $templateName['namespace'];
  110.         $path = $templateName['path'];
  112.         if (empty($this->databaseTemplateCache)) {
  113.             $templates = $this->connection->fetchAll('
  114.                 SELECT
  115.                     `app_template`.`path` AS `path`,
  116.                     `app_template`.`template` AS `template`,
  117.                     `app_template`.`updated_at` AS `updatedAt`,
  118.                     `app`.`name` AS `namespace`
  119.                 FROM `app_template`
  120.                 INNER JOIN `app` ON `app_template`.`app_id` = `app`.`id`
  121.                 WHERE `app_template`.`active` = 1 AND `app`.`active` = 1
  122.             ');
  124.             /** @var array $template */
  125.             foreach ($templates as $template) {
  126.                 $this->databaseTemplateCache[$template['path']][$template['namespace']] = [
  127.                     'template' => $template['template'],
  128.                     'updatedAt' => $template['updatedAt'] ? new \DateTimeImmutable($template['updatedAt']) : null,
  129.                 ];
  130.             }
  131.         }
  133.         if (\array_key_exists($path, $this->databaseTemplateCache) && \array_key_exists($namespace, $this->databaseTemplateCache[$path])) {
  134.             return $this->databaseTemplateCache[$path][$namespace];
  135.         }
  137.         /** @deprecated tag:v6.5.0 - only for intermediate backwards compatibility */
  138.         if (
  139.             \array_key_exists('../' . $path, $this->databaseTemplateCache)
  140.             && \array_key_exists($namespace, $this->databaseTemplateCache['../' . $path])
  141.         ) {
  142.             return $this->databaseTemplateCache['../' . $path][$namespace];
  143.         }
  145.         // we have already loaded all DB templates
  146.         // if the namespace is not included return null
  147.         return $this->databaseTemplateCache[$path][$namespace] = null;
  148.     }
  150.     private function splitTemplateName(string $template): array
  151.     {
  152.         // remove static template inheritance prefix
  153.         if (mb_strpos($template, '@') !== 0) {
  154.             return ['path' => $template, 'namespace' => ''];
  155.         }
  157.         // remove "@"
  158.         $template = mb_substr($template, 1);
  160.         $template = explode('/', $template);
  161.         $namespace = array_shift($template);
  162.         $template = implode('/', $template);
  164.         return ['path' => $template, 'namespace' => $namespace];
  165.     }
  166. }