2012-12-19 07:54:53 +00:00
< ? php
/*
* This file is part of the Symfony package .
*
* ( c ) Fabien Potencier < fabien @ symfony . com >
*
* For the full copyright and license information , please view the LICENSE
* file that was distributed with this source code .
*/
2013-01-31 09:37:27 +00:00
namespace Symfony\Component\HttpKernel\Fragment ;
2012-12-19 07:54:53 +00:00
2018-07-26 10:03:18 +01:00
use Symfony\Component\HttpFoundation\RequestStack ;
2013-01-20 09:04:47 +00:00
use Symfony\Component\HttpFoundation\Response ;
use Symfony\Component\HttpFoundation\StreamedResponse ;
2012-12-19 07:54:53 +00:00
use Symfony\Component\HttpKernel\Controller\ControllerReference ;
/**
2013-01-31 09:37:27 +00:00
* Renders a URI that represents a resource fragment .
2012-12-19 07:54:53 +00:00
*
2013-01-31 09:37:27 +00:00
* This class handles the rendering of resource fragments that are included into
* a main resource . The handling of the rendering is managed by specialized renderers .
2013-01-22 08:06:13 +00:00
*
2012-12-19 07:54:53 +00:00
* @ author Fabien Potencier < fabien @ symfony . com >
2013-01-22 08:06:13 +00:00
*
2013-01-31 09:37:27 +00:00
* @ see FragmentRendererInterface
2012-12-19 07:54:53 +00:00
*/
2013-02-06 21:23:26 +00:00
class FragmentHandler
2012-12-19 07:54:53 +00:00
{
private $debug ;
2019-01-16 18:24:45 +00:00
private $renderers = [];
2013-09-07 21:38:41 +01:00
private $requestStack ;
2012-12-19 07:54:53 +00:00
2013-01-04 17:38:08 +00:00
/**
2015-09-08 09:31:52 +01:00
* @ param RequestStack $requestStack The Request stack that controls the lifecycle of requests
2013-09-19 11:09:58 +01:00
* @ param FragmentRendererInterface [] $renderers An array of FragmentRendererInterface instances
2014-04-16 09:02:57 +01:00
* @ param bool $debug Whether the debug mode is enabled or not
2013-01-04 17:38:08 +00:00
*/
2019-01-16 18:24:45 +00:00
public function __construct ( RequestStack $requestStack , array $renderers = [], bool $debug = false )
2012-12-19 07:54:53 +00:00
{
2013-09-07 21:38:41 +01:00
$this -> requestStack = $requestStack ;
2013-01-31 09:37:27 +00:00
foreach ( $renderers as $renderer ) {
$this -> addRenderer ( $renderer );
2012-12-19 07:54:53 +00:00
}
$this -> debug = $debug ;
}
2013-01-04 17:38:08 +00:00
/**
2013-01-31 09:37:27 +00:00
* Adds a renderer .
2013-01-04 17:38:08 +00:00
*/
2013-01-31 09:37:27 +00:00
public function addRenderer ( FragmentRendererInterface $renderer )
2012-12-19 07:54:53 +00:00
{
2013-01-31 09:37:27 +00:00
$this -> renderers [ $renderer -> getName ()] = $renderer ;
2012-12-19 07:54:53 +00:00
}
/**
* Renders a URI and returns the Response content .
*
2013-01-06 08:31:07 +00:00
* Available options :
*
2012-12-19 07:54:53 +00:00
* * ignore_errors : true to return an empty string in case of an error
*
2013-01-06 08:31:07 +00:00
* @ param string | ControllerReference $uri A URI as a string or a ControllerReference instance
2013-01-31 09:37:27 +00:00
* @ param string $renderer The renderer name
2013-01-06 08:31:07 +00:00
* @ param array $options An array of options
2012-12-19 07:54:53 +00:00
*
2013-01-04 17:38:08 +00:00
* @ return string | null The Response content or null when the Response is streamed
2013-01-10 15:08:44 +00:00
*
2013-01-31 09:37:27 +00:00
* @ throws \InvalidArgumentException when the renderer does not exist
2014-07-26 13:09:47 +01:00
* @ throws \LogicException when no master request is being handled
2012-12-19 07:54:53 +00:00
*/
2019-01-16 18:24:45 +00:00
public function render ( $uri , $renderer = 'inline' , array $options = [])
2012-12-19 07:54:53 +00:00
{
if ( ! isset ( $options [ 'ignore_errors' ])) {
$options [ 'ignore_errors' ] = ! $this -> debug ;
}
2013-01-31 09:37:27 +00:00
if ( ! isset ( $this -> renderers [ $renderer ])) {
throw new \InvalidArgumentException ( sprintf ( 'The "%s" renderer does not exist.' , $renderer ));
2012-12-19 07:54:53 +00:00
}
2015-07-03 17:45:43 +01:00
if ( ! $request = $this -> requestStack -> getCurrentRequest ()) {
2013-08-31 21:10:38 +01:00
throw new \LogicException ( 'Rendering a fragment can only be done when handling a Request.' );
}
2013-09-07 19:20:07 +01:00
return $this -> deliver ( $this -> renderers [ $renderer ] -> render ( $uri , $request , $options ));
2013-01-20 09:04:47 +00:00
}
/**
* Delivers the Response as a string .
*
* When the Response is a StreamedResponse , the content is streamed immediately
* instead of being returned .
*
* @ return string | null The Response content or null when the Response is streamed
*
* @ throws \RuntimeException when the Response is not successful
*/
protected function deliver ( Response $response )
{
if ( ! $response -> isSuccessful ()) {
2015-07-03 17:45:43 +01:00
throw new \RuntimeException ( sprintf ( 'Error when rendering "%s" (Status code is %s).' , $this -> requestStack -> getCurrentRequest () -> getUri (), $response -> getStatusCode ()));
2013-01-20 09:04:47 +00:00
}
if ( ! $response instanceof StreamedResponse ) {
return $response -> getContent ();
}
$response -> sendContent ();
2012-12-19 07:54:53 +00:00
}
}