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 | |
| __construct(EngineInterface|Environment $templating = null, UriSigner $signer = null, string $globalDefaultTemplate = null, string $charset = 'utf-8') | ||
| 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
| FragmentListener |
__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 |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/HttpKernel/Fragment/HIncludeFragmentRenderer.html