vendor/contao/core-bundle/src/Fragment/FragmentHandler.php line 44

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6. * This file is part of Contao.
  7. *
  8. * (c) Leo Feyer
  9. *
  10. * @license LGPL-3.0-or-later
  11. */
  13. namespace Contao\CoreBundle\Fragment;
  15. use Contao\CoreBundle\Exception\ResponseException;
  16. use Contao\CoreBundle\Fragment\Reference\FragmentReference;
  17. use Contao\PageModel;
  18. use Psr\Container\ContainerInterface;
  19. use Symfony\Component\HttpFoundation\RequestStack;
  20. use Symfony\Component\HttpFoundation\Response;
  21. use Symfony\Component\HttpKernel\Fragment\FragmentHandler as BaseFragmentHandler;
  23. class FragmentHandler extends BaseFragmentHandler
  24. {
  25. private ContainerInterface $renderers;
  26. private BaseFragmentHandler $fragmentHandler;
  27. private FragmentRegistryInterface $fragmentRegistry;
  28. private ContainerInterface $preHandlers;
  29. private array $initialized = [];
  31. /**
  32. * @internal
  33. */
  34. public function __construct(ContainerInterface $renderers, BaseFragmentHandler $fragmentHandler, RequestStack $requestStack, FragmentRegistryInterface $fragmentRegistry, ContainerInterface $preHandlers, bool $debug = false)
  35. {
  36. $this->renderers = $renderers;
  37. $this->fragmentHandler = $fragmentHandler;
  38. $this->fragmentRegistry = $fragmentRegistry;
  39. $this->preHandlers = $preHandlers;
  41. parent::__construct($requestStack, [], $debug);
  42. }
  44. public function render($uri, string $renderer = 'inline', array $options = []): ?string
  45. {
  46. if (!$uri instanceof FragmentReference) {
  47. return $this->fragmentHandler->render($uri, $renderer, $options);
  48. }
  50. $config = $this->fragmentRegistry->get($uri->controller);
  52. if (null === $config) {
  53. throw new UnknownFragmentException(sprintf('Invalid fragment identifier "%s"', $uri->controller));
  54. }
  56. $this->preHandleFragment($uri, $config);
  58. $renderer = $config->getRenderer();
  60. if ('inline' !== $renderer && $this->containsNonScalars($uri->attributes)) {
  61. $renderer = 'forward';
  62. }
  64. if (!isset($this->initialized[$renderer]) && $this->renderers->has($renderer)) {
  65. $this->addRenderer($this->renderers->get($renderer));
  66. $this->initialized[$renderer] = true;
  67. }
  69. return parent::render($uri, $renderer, $config->getOptions());
  70. }
  72. protected function deliver(Response $response): ?string
  73. {
  74. try {
  75. return parent::deliver($response);
  76. } catch (\RuntimeException $e) {
  77. throw new ResponseException($response, $e);
  78. }
  79. }
  81. /**
  82. * Adds generic attributes and query parameters before rendering.
  83. */
  84. private function preHandleFragment(FragmentReference $uri, FragmentConfig $config): void
  85. {
  86. if (!isset($uri->attributes['pageModel']) && $this->hasGlobalPageObject()) {
  87. $uri->attributes['pageModel'] = $GLOBALS['objPage']->id;
  88. }
  90. if ($this->preHandlers->has($uri->controller)) {
  91. /** @var FragmentPreHandlerInterface $preHandler */
  92. $preHandler = $this->preHandlers->get($uri->controller);
  93. $preHandler->preHandleFragment($uri, $config);
  94. }
  95. }
  97. private function hasGlobalPageObject(): bool
  98. {
  99. return isset($GLOBALS['objPage']) && $GLOBALS['objPage'] instanceof PageModel;
  100. }
  102. private function containsNonScalars(array $values): bool
  103. {
  104. foreach ($values as $value) {
  105. if (\is_array($value)) {
  106. return $this->containsNonScalars($value);
  107. }
  109. if (!\is_scalar($value) && null !== $value) {
  110. return true;
  111. }
  112. }
  114. return false;
  115. }
  116. }