1. class
  2. Symfony
  3. Component
  4. HttpKernel
  5. Fragment
  6. FragmentHandler

FragmentHandler

class FragmentHandler

Renders a URI that represents a resource fragment.

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.

Methods

__construct(RequestStack $requestStack, array $renderers = array(), bool $debug = false)

Constructor.

addRenderer(FragmentRendererInterface $renderer)

Adds a renderer.

string|null
render(string|ControllerReference $uri, string $renderer = 'inline', array $options = array())

Renders a URI and returns the Response content.

Details

at line line 43
__construct(RequestStack $requestStack, array $renderers = array(), bool $debug = false)

Constructor.

Parameters

RequestStack $requestStack The Request stack that controls the lifecycle of requests
array $renderers An array of FragmentRendererInterface instances
bool $debug Whether the debug mode is enabled or not

at line line 57
addRenderer(FragmentRendererInterface $renderer)

Adds a renderer.

Parameters

FragmentRendererInterface $renderer A FragmentRendererInterface instance

at line line 78
string|null render(string|ControllerReference $uri, string $renderer = 'inline', array $options = array())

Renders a URI and returns the Response content.

Available options:

  • ignore_errors: true to return an empty string in case of an error

Parameters

string|ControllerReference $uri A URI as a string or a ControllerReference instance
string $renderer The renderer name
array $options An array of options

Return Value

string|null The Response content or null when the Response is streamed

Exceptions

InvalidArgumentException when the renderer does not exist
LogicException when no master request is being handled