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

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