LazyLoadingFragmentHandler

class LazyLoadingFragmentHandler extends FragmentHandler

Lazily loads fragment renderers from the dependency injection container.

Methods

__construct(ContainerInterface $container, bool $debug = false, RequestStack $requestStack = null)

Constructor.

addRenderer(FragmentRendererInterface $renderer)

Adds a renderer.

from FragmentHandler
setRequest(Request $request = null) deprecated

Sets the current Request.

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

Renders a URI and returns the Response content.

addRendererService(string $name, string $renderer)

Adds a service as a fragment renderer.

Details

__construct(ContainerInterface $container, bool $debug = false, RequestStack $requestStack = null)

Constructor.

RequestStack will become required in 3.0.

Parameters

ContainerInterface $container
bool $debug Whether the debug mode is enabled or not
RequestStack $requestStack The Request stack that controls the lifecycle of requests

addRenderer(FragmentRendererInterface $renderer)

Adds a renderer.

Parameters

FragmentRendererInterface $renderer A FragmentRendererInterface instance

setRequest(Request $request = null) deprecated

deprecated

since version 2.4, to be removed in 3.0.

Sets the current Request.

This method was used to synchronize the Request, but as the HttpKernel is doing that automatically now, you should never call it directly. It is kept public for BC with the 2.3 version.

Parameters

Request $request A Request instance

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

addRendererService(string $name, string $renderer)

Adds a service as a fragment renderer.

Parameters

string $name The service name
string $renderer The render service id