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

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