class HIncludeFragmentRenderer extends RoutableFragmentRenderer

Implements the Hinclude rendering strategy.

Methods

setFragmentPath(string $path)

Sets the fragment path that triggers the fragment listener.

__construct(EngineInterface|Twig_Environment $templating = null, UriSigner $signer = null, string $globalDefaultTemplate = null, string $charset = 'utf-8')

Constructor.

setTemplating(EngineInterface|Twig_Environment|null $templating)

Sets the templating engine to use to render the default content.

bool
hasTemplating()

Checks if a templating engine has been set.

render(string|ControllerReference $uri, Request $request, array $options = array())

Renders a URI and returns the Response content.

string
getName()

Gets the name of the strategy.

Details

in RoutableFragmentRenderer at line line 34
setFragmentPath(string $path)

Sets the fragment path that triggers the fragment listener.

Parameters

string $path The path

See also

FragmentListener

at line line 40
__construct(EngineInterface|Twig_Environment $templating = null, UriSigner $signer = null, string $globalDefaultTemplate = null, string $charset = 'utf-8')

Constructor.

Parameters

EngineInterface|Twig_Environment $templating An EngineInterface or a \Twig_Environment instance
UriSigner $signer A UriSigner instance
string $globalDefaultTemplate The global default content (it can be a template name or the content)
string $charset

at line line 55
setTemplating(EngineInterface|Twig_Environment|null $templating)

Sets the templating engine to use to render the default content.

Parameters

EngineInterface|Twig_Environment|null $templating An EngineInterface or a \Twig_Environment instance

Exceptions

InvalidArgumentException

at line line 69
bool hasTemplating()

Checks if a templating engine has been set.

Return Value

bool true if the templating engine has been set, false otherwise

at line line 83
Response render(string|ControllerReference $uri, Request $request, array $options = array())

Renders a URI and returns the Response content.

Parameters

string|ControllerReference $uri A URI as a string or a ControllerReference instance
Request $request A Request instance
array $options An array of options

Return Value

Response A Response instance

at line line 156
string getName()

Gets the name of the strategy.

Return Value

string The strategy name