vendor/pimcore/pimcore/lib/Templating/TwigDefaultDelegatingEngine.php line 63

Open in your IDE?
  1. <?php
  3. /**
  4. * Pimcore
  5. *
  6. * This source file is available under two different licenses:
  7. * - GNU General Public License version 3 (GPLv3)
  8. * - Pimcore Commercial License (PCL)
  9. * Full copyright and license information is available in
  10. * LICENSE.md which is distributed with this source code.
  11. *
  12. * @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13. * @license http://www.pimcore.org/license GPLv3 and PCL
  14. */
  16. namespace Pimcore\Templating;
  18. use Pimcore\Config;
  19. use Symfony\Component\HttpFoundation\Response;
  20. use Symfony\Component\Templating\DelegatingEngine as BaseDelegatingEngine;
  21. use Symfony\Component\Templating\EngineInterface;
  22. use Twig\Environment;
  23. use Twig\Extension\SandboxExtension;
  25. /**
  26. * @internal
  27. */
  28. class TwigDefaultDelegatingEngine extends BaseDelegatingEngine
  29. {
  30. /**
  31. * @var bool
  32. */
  33. protected $delegate = false;
  35. /**
  36. * @param EngineInterface[] $engines
  37. */
  38. public function __construct(protected Environment $twig, protected Config $config, array $engines = [])
  39. {
  40. parent::__construct($engines);
  41. }
  43. /**
  44. * {@inheritdoc}
  45. */
  46. public function exists($name): bool
  47. {
  48. if (!$this->delegate) {
  49. return $this->twig->getLoader()->exists($name);
  50. } else {
  51. return parent::exists($name);
  52. }
  53. }
  55. /**
  56. * {@inheritdoc}
  57. *
  58. * @throws \Exception
  59. */
  60. public function render($name, array $parameters = []): string
  61. {
  62. if (!$this->delegate) {
  63. return $this->twig->render($name, $parameters);
  64. } else {
  65. return parent::render($name, $parameters);
  66. }
  67. }
  69. /**
  70. * {@inheritdoc}
  71. */
  72. public function supports($name): bool
  73. {
  74. if (!$this->delegate) {
  75. return true;
  76. } else {
  77. return parent::supports($name);
  78. }
  79. }
  81. /**
  82. * @param bool $delegate
  83. */
  84. public function setDelegate(bool $delegate)
  85. {
  86. $this->delegate = $delegate;
  87. }
  89. /**
  90. * @return bool $delegate
  91. */
  92. public function isDelegate()
  93. {
  94. return $this->delegate;
  95. }
  97. public function getTwigEnvironment(bool $sandboxed = false): Environment
  98. {
  99. if ($sandboxed) {
  100. /** @var SandboxExtension $sandboxExtension */
  101. $sandboxExtension = $this->twig->getExtension(SandboxExtension::class);
  102. $sandboxExtension->enableSandbox();
  103. }
  105. return $this->twig;
  106. }
  108. public function disableSandboxExtensionFromTwigEnvironment(): void
  109. {
  110. /** @var SandboxExtension $sandboxExtension */
  111. $sandboxExtension = $this->twig->getExtension(SandboxExtension::class);
  112. $sandboxExtension->disableSandbox();
  113. }
  115. /**
  116. * @param string $view
  117. * @param array $parameters
  118. * @param Response|null $response
  119. *
  120. * @return Response
  121. *
  122. * @throws \Exception
  123. */
  124. public function renderResponse($view, array $parameters = [], Response $response = null)
  125. {
  126. if (null === $response) {
  127. $response = new Response();
  128. }
  130. $response->setContent($this->render($view, $parameters));
  132. return $response;
  133. }
  134. }