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

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 Shopware\Core\Framework\Log\Package;
  10. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  11. use Symfony\Contracts\Service\ResetInterface;
  12. use Twig\Error\LoaderError;
  13. use Twig\Loader\LoaderInterface;
  14. use Twig\Source;
  16. /**
  17. * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  18. */
  19. #[Package('core')]
  20. class EntityTemplateLoader implements LoaderInterface, EventSubscriberInterface, ResetInterface
  21. {
  22. /**
  23. * @var array<string, array<string, array{template: string, updatedAt: \DateTimeInterface|null}|null>>
  24. */
  25. private array $databaseTemplateCache = [];
  27. private Connection $connection;
  29. private string $environment;
  31. /**
  32. * @internal
  33. */
  34. public function __construct(Connection $connection, string $environment)
  35. {
  36. $this->connection = $connection;
  37. $this->environment = $environment;
  38. }
  40. public static function getSubscribedEvents(): array
  41. {
  42. return ['app_template.written' => 'reset'];
  43. }
  45. /**
  46. * @deprecated tag:v6.5.0 will be removed, use `reset()` instead
  47. */
  48. public function clearInternalCache(): void
  49. {
  50. Feature::triggerDeprecationOrThrow(
  51. 'v6.5.0.0',
  52. Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'reset()')
  53. );
  55. $this->reset();
  56. }
  58. public function reset(): void
  59. {
  60. $this->databaseTemplateCache = [];
  61. }
  63. public function getSourceContext(string $name): Source
  64. {
  65. $template = $this->findDatabaseTemplate($name);
  67. if (!$template) {
  68. throw new LoaderError(sprintf('Template "%s" is not defined.', $name));
  69. }
  71. return new Source($template['template'], $name);
  72. }
  74. public function getCacheKey(string $name): string
  75. {
  76. return $name;
  77. }
  79. public function isFresh(string $name, int $time): bool
  80. {
  81. $template = $this->findDatabaseTemplate($name);
  82. if (!$template) {
  83. return false;
  84. }
  86. return $template['updatedAt'] === null || $template['updatedAt']->getTimestamp() < $time;
  87. }
  89. /**
  90. * @return bool
  91. */
  92. public function exists(string $name)
  93. {
  94. $template = $this->findDatabaseTemplate($name);
  95. if (!$template) {
  96. return false;
  97. }
  99. return true;
  100. }
  102. /**
  103. * @return array{template: string, updatedAt: \DateTimeInterface|null}|null
  104. */
  105. private function findDatabaseTemplate(string $name): ?array
  106. {
  107. if (EnvironmentHelper::getVariable('DISABLE_EXTENSIONS', false)) {
  108. return null;
  109. }
  111. /*
  112. * In dev env app templates are directly loaded over the filesystem
  113. * @see TwigLoaderConfigCompilerPass::addAppTemplatePaths()
  114. */
  115. if ($this->environment === 'dev') {
  116. return null;
  117. }
  119. $templateName = $this->splitTemplateName($name);
  120. $namespace = $templateName['namespace'];
  121. $path = $templateName['path'];
  123. if (empty($this->databaseTemplateCache)) {
  124. /** @var array<array{path: string, template: string, updatedAt: string|null, namespace: string}> $templates */
  125. $templates = $this->connection->fetchAllAssociative('
  126. SELECT
  127. `app_template`.`path` AS `path`,
  128. `app_template`.`template` AS `template`,
  129. `app_template`.`updated_at` AS `updatedAt`,
  130. `app`.`name` AS `namespace`
  131. FROM `app_template`
  132. INNER JOIN `app` ON `app_template`.`app_id` = `app`.`id`
  133. WHERE `app_template`.`active` = 1 AND `app`.`active` = 1
  134. ');
  136. foreach ($templates as $template) {
  137. $this->databaseTemplateCache[$template['path']][$template['namespace']] = [
  138. 'template' => $template['template'],
  139. 'updatedAt' => $template['updatedAt'] ? new \DateTimeImmutable($template['updatedAt']) : null,
  140. ];
  141. }
  142. }
  144. if (\array_key_exists($path, $this->databaseTemplateCache) && \array_key_exists($namespace, $this->databaseTemplateCache[$path])) {
  145. return $this->databaseTemplateCache[$path][$namespace];
  146. }
  148. /** @deprecated tag:v6.5.0 - only for intermediate backwards compatibility */
  149. if (
  150. \array_key_exists('../' . $path, $this->databaseTemplateCache)
  151. && \array_key_exists($namespace, $this->databaseTemplateCache['../' . $path])
  152. ) {
  153. return $this->databaseTemplateCache['../' . $path][$namespace];
  154. }
  156. // we have already loaded all DB templates
  157. // if the namespace is not included return null
  158. return $this->databaseTemplateCache[$path][$namespace] = null;
  159. }
  161. /**
  162. * @return array{namespace: string, path: string}
  163. */
  164. private function splitTemplateName(string $template): array
  165. {
  166. // remove static template inheritance prefix
  167. if (mb_strpos($template, '@') !== 0) {
  168. return ['path' => $template, 'namespace' => ''];
  169. }
  171. // remove "@"
  172. $template = mb_substr($template, 1);
  174. $template = explode('/', $template);
  175. $namespace = array_shift($template);
  176. $template = implode('/', $template);
  178. return ['path' => $template, 'namespace' => $namespace];
  179. }
  180. }