vendor/symfony/http-kernel/Fragment/FragmentHandler.php line 85

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the Symfony package.
  5. *
  6. * (c) Fabien Potencier <fabien@symfony.com>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. namespace Symfony\Component\HttpKernel\Fragment;
  14. use Symfony\Component\HttpFoundation\RequestStack;
  15. use Symfony\Component\HttpFoundation\Response;
  16. use Symfony\Component\HttpFoundation\StreamedResponse;
  17. use Symfony\Component\HttpKernel\Controller\ControllerReference;
  18. use Symfony\Component\HttpKernel\Exception\HttpException;
  20. /**
  21. * Renders a URI that represents a resource fragment.
  22. *
  23. * This class handles the rendering of resource fragments that are included into
  24. * a main resource. The handling of the rendering is managed by specialized renderers.
  25. *
  26. * @author Fabien Potencier <fabien@symfony.com>
  27. *
  28. * @see FragmentRendererInterface
  29. */
  30. class FragmentHandler
  31. {
  32. private $debug;
  33. private $renderers = [];
  34. private $requestStack;
  36. /**
  37. * @param FragmentRendererInterface[] $renderers An array of FragmentRendererInterface instances
  38. * @param bool $debug Whether the debug mode is enabled or not
  39. */
  40. public function __construct(RequestStack $requestStack, array $renderers = [], bool $debug = false)
  41. {
  42. $this->requestStack = $requestStack;
  43. foreach ($renderers as $renderer) {
  44. $this->addRenderer($renderer);
  45. }
  46. $this->debug = $debug;
  47. }
  49. /**
  50. * Adds a renderer.
  51. */
  52. public function addRenderer(FragmentRendererInterface $renderer)
  53. {
  54. $this->renderers[$renderer->getName()] = $renderer;
  55. }
  57. /**
  58. * Renders a URI and returns the Response content.
  59. *
  60. * Available options:
  61. *
  62. * * ignore_errors: true to return an empty string in case of an error
  63. *
  64. * @param string|ControllerReference $uri A URI as a string or a ControllerReference instance
  65. *
  66. * @return string|null
  67. *
  68. * @throws \InvalidArgumentException when the renderer does not exist
  69. * @throws \LogicException when no main request is being handled
  70. */
  71. public function render($uri, string $renderer = 'inline', array $options = [])
  72. {
  73. if (!isset($options['ignore_errors'])) {
  74. $options['ignore_errors'] = !$this->debug;
  75. }
  77. if (!isset($this->renderers[$renderer])) {
  78. throw new \InvalidArgumentException(sprintf('The "%s" renderer does not exist.', $renderer));
  79. }
  81. if (!$request = $this->requestStack->getCurrentRequest()) {
  82. throw new \LogicException('Rendering a fragment can only be done when handling a Request.');
  83. }
  85. return $this->deliver($this->renderers[$renderer]->render($uri, $request, $options));
  86. }
  88. /**
  89. * Delivers the Response as a string.
  90. *
  91. * When the Response is a StreamedResponse, the content is streamed immediately
  92. * instead of being returned.
  93. *
  94. * @return string|null The Response content or null when the Response is streamed
  95. *
  96. * @throws \RuntimeException when the Response is not successful
  97. */
  98. protected function deliver(Response $response)
  99. {
  100. if (!$response->isSuccessful()) {
  101. $responseStatusCode = $response->getStatusCode();
  102. throw new \RuntimeException(sprintf('Error when rendering "%s" (Status code is %d).', $this->requestStack->getCurrentRequest()->getUri(), $responseStatusCode), 0, new HttpException($responseStatusCode));
  103. }
  105. if (!$response instanceof StreamedResponse) {
  106. return $response->getContent();
  107. }
  109. $response->sendContent();
  111. return null;
  112. }
  113. }