1. class
  2. Neos
  3. \
  4. FluidAdaptor
  5. \
  6. ViewHelpers
  7. \
  8. Widget
  9. \
  10. UriViewHelper

UriViewHelper

class UriViewHelper extends AbstractViewHelper (View source)

widget.uri ViewHelper This ViewHelper can be used inside widget templates in order to render URIs pointing to widget actions

= Examples =

{f:widget.uri(action: 'widgetAction')}
--widget[@action]=widgetAction (depending on routing setup and current widget)

Properties

protected ControllerContext $controllerContext

Controller Context to use

 from  AbstractViewHelper
protected ObjectManagerInterface $objectManager from  AbstractViewHelper
protected LoggerInterface $logger from  AbstractViewHelper
protected HashService $hashService

Methods

void
setRenderingContext(RenderingContextInterface $renderingContext)

No description

from  AbstractViewHelper
void
injectObjectManager(ObjectManagerInterface $objectManager)

No description

from  AbstractViewHelper
void
injectLogger(LoggerInterface $logger)

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

from  AbstractViewHelper
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.

from  AbstractViewHelper
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.

from  AbstractViewHelper
bool
isEscapingInterceptorEnabled()

No description

from  AbstractViewHelper
void
initializeArguments()

Initialize the arguments.

string
render()

Render the Uri.

string
getAjaxUri()

Get the URI for an AJAX Request.

string
getWidgetUri()

Get the URI for a non-AJAX Request.

Details

in AbstractViewHelper at line 52
void setRenderingContext(RenderingContextInterface $renderingContext)

No description

Parameters

RenderingContextInterface $renderingContext

Return Value

void

in AbstractViewHelper at line 65
void injectObjectManager(ObjectManagerInterface $objectManager)

No description

Parameters

ObjectManagerInterface $objectManager

Return Value

void

in AbstractViewHelper at line 76
void injectLogger(LoggerInterface $logger)

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

Parameters

LoggerInterface $logger

Return Value

void

in AbstractViewHelper 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

in AbstractViewHelper 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()

in AbstractViewHelper at line 134
bool isEscapingInterceptorEnabled()

No description

Return Value

bool

at line 48
void initializeArguments()

Initialize the arguments.

Return Value

void

Exceptions

Exception

at line 67
string render()

Render the Uri.

Return Value

string

The rendered link

Exceptions

Exception
WidgetContextNotFoundException

at line 85
protected string getAjaxUri()

Get the URI for an AJAX Request.

Return Value

string

the AJAX URI

Exceptions

WidgetContextNotFoundException

at line 118
protected string getWidgetUri()

Get the URI for a non-AJAX Request.

argumentsToBeExcludedFromQueryString does not work yet, needs to be fixed.

Return Value

string

the Widget URI

Exceptions

Exception