1. class
  2. Neos
  3. \
  4. FluidAdaptor
  5. \
  6. Core
  7. \
  8. ViewHelper
  9. \
  10. AbstractViewHelper

AbstractViewHelper

abstract class AbstractViewHelper extends AbstractViewHelper (View source)

The abstract base class for all view helpers.

Properties

protected ControllerContext $controllerContext

Controller Context to use
protected ObjectManagerInterface $objectManager
protected LoggerInterface $logger

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.

bool
isEscapingInterceptorEnabled()

No description

Details

at line 52
void setRenderingContext(RenderingContextInterface $renderingContext)

No description

Parameters

RenderingContextInterface $renderingContext

Return Value

void

at line 65
void injectObjectManager(ObjectManagerInterface $objectManager)

No description

Parameters

ObjectManagerInterface $objectManager

Return Value

void

at line 76
void injectLogger(LoggerInterface $logger)

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

Parameters

LoggerInterface $logger

Return Value

void

at line 97
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

at line 123
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()

at line 134
bool isEscapingInterceptorEnabled()

No description

Return Value

bool