1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. HttpKernel
  7. \
  8. Fragment
  9. \
  10. HIncludeFragmentRenderer

HIncludeFragmentRenderer

class HIncludeFragmentRenderer extends RoutableFragmentRenderer

Implements the Hinclude rendering strategy.

Methods

setFragmentPath(string $path)

Sets the fragment path that triggers the fragment listener.

from RoutableFragmentRenderer
string
generateFragmentUri(ControllerReference $reference, Request $request, bool $absolute = false, bool $strict = true)

Generates a fragment URI for a given controller.

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

No description

setTemplating(EngineInterface|Environment|null $templating)

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

bool
hasTemplating()

Checks if a templating engine has been set.

Response
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

setFragmentPath(string $path)

Sets the fragment path that triggers the fragment listener.

Parameters

string $path The path

See also

protected string generateFragmentUri(ControllerReference $reference, Request $request, bool $absolute = false, bool $strict = true)

Generates a fragment URI for a given controller.

Parameters

ControllerReference $reference A ControllerReference instance
Request $request A Request instance
bool $absolute Whether to generate an absolute URL or not
bool $strict Whether to allow non-scalar attributes or not

Return Value

string A fragment URI

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

Parameters

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

setTemplating(EngineInterface|Environment|null $templating)

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

Parameters

EngineInterface|Environment|null $templating An EngineInterface or an Environment instance

Exceptions

InvalidArgumentException

bool hasTemplating()

Checks if a templating engine has been set.

Return Value

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

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

string getName()

Gets the name of the strategy.

Return Value

string The strategy name