class RenderChildrenViewHelper extends AbstractViewHelper (View source)

Render the inner parts of a Widget.

This ViewHelper can only be used in a template which belongs to a Widget Controller.

It renders everything inside the Widget ViewHelper, and you can pass additional arguments.

= Examples =

Header

Footer

<-- in the outer template, using the widget -->

Foo: {foo} ``` Header Foo: bar Footer

Properties

protected ControllerContext $controllerContext

Controller Context to use

from  AbstractViewHelper
protected ObjectManagerInterface $objectManager from  AbstractViewHelper
protected LoggerInterface $logger from  AbstractViewHelper
protected bool $escapeOutput

Methods

void
setRenderingContext(RenderingContextInterface $renderingContext)

No description

void
injectObjectManager(ObjectManagerInterface $objectManager)

No description

void
injectLogger(LoggerInterface $logger)

Injects the (system) logger based on PSR-3.

AbstractViewHelper
registerArgument(string $name, string $type, string $description, bool $required = false, mixed $defaultValue = null, bool|null $escape = null)

Register a new argument. Call this method from your ViewHelper subclass inside the initializeArguments() method.

AbstractViewHelper
overrideArgument(string $name, string $type, string $description, bool $required = false, mixed $defaultValue = null, bool|null $escape = null)

Overrides a registered argument. Call this method from your ViewHelper subclass inside the initializeArguments() method if you want to override a previously registered argument.

void
initializeArguments()

Initialize the arguments.

string
render()

No description

RenderingContextInterface
getWidgetRenderingContext()

Get the widget rendering context, or throw an exception if it cannot be found.

RootNode
getWidgetChildNodes()

No description

getWidgetContext()

No description

void
addArgumentsToTemplateVariableContainer(array $arguments)

Add the given arguments to the TemplateVariableContainer of the widget.

void
removeArgumentsFromTemplateVariableContainer(array $arguments)

Remove the given arguments from the TemplateVariableContainer of the widget.

Details

void setRenderingContext(RenderingContextInterface $renderingContext)

No description

Parameters

RenderingContextInterface $renderingContext

Return Value

void

void injectObjectManager(ObjectManagerInterface $objectManager)

No description

Parameters

ObjectManagerInterface $objectManager

Return Value

void

void injectLogger(LoggerInterface $logger)

Injects the (system) logger based on PSR-3.

Parameters

LoggerInterface $logger

Return Value

void

protected AbstractViewHelper registerArgument(string $name, string $type, string $description, bool $required = false, mixed $defaultValue = null, bool|null $escape = null)

Register a new argument. Call this method from your ViewHelper subclass inside the initializeArguments() method.

This exists only to throw our own exception!

Parameters

string $name

Name of the argument

string $type

Type of the argument

string $description

Description of the argument

bool $required

If true, argument is required. Defaults to false.

mixed $defaultValue

Default value of argument

bool|null $escape

Can be toggled to TRUE to force escaping of variables and inline syntax passed as argument value.

Return Value

AbstractViewHelper

$this, to allow chaining.

Exceptions

Exception

protected AbstractViewHelper overrideArgument(string $name, string $type, string $description, bool $required = false, mixed $defaultValue = null, bool|null $escape = null)

Overrides a registered argument. Call this method from your ViewHelper subclass inside the initializeArguments() method if you want to override a previously registered argument.

This exists only to throw our own exception!

Parameters

string $name

Name of the argument

string $type

Type of the argument

string $description

Description of the argument

bool $required

If true, argument is required. Defaults to false.

mixed $defaultValue

Default value of argument

bool|null $escape

Can be toggled to TRUE to force escaping of variables and inline syntax passed as argument value.

Return Value

AbstractViewHelper

$this, to allow chaining.

Exceptions

Exception

See also

registerArgument()

bool isEscapingInterceptorEnabled()

No description

Return Value

bool

void initializeArguments()

Initialize the arguments.

Return Value

void

Exceptions

Exception

string render()

No description

protected RenderingContextInterface getWidgetRenderingContext()

Get the widget rendering context, or throw an exception if it cannot be found.

Return Value

RenderingContextInterface

Exceptions

RenderingContextNotFoundException
WidgetContextNotFoundException

protected RootNode getWidgetChildNodes()

No description

Return Value

RootNode

Exceptions

WidgetContextNotFoundException

protected WidgetContext getWidgetContext()

No description

protected void addArgumentsToTemplateVariableContainer(array $arguments)

Add the given arguments to the TemplateVariableContainer of the widget.

Parameters

array $arguments

Return Value

void

Exceptions

RenderingContextNotFoundException
WidgetContextNotFoundException

protected void removeArgumentsFromTemplateVariableContainer(array $arguments)

Remove the given arguments from the TemplateVariableContainer of the widget.

Parameters

array $arguments

Return Value

void

Exceptions

RenderingContextNotFoundException
WidgetContextNotFoundException