class UriBuilderImplementation extends AbstractFusionObject (View source)

A Fusion UriBuilder object

The following Fusion properties are evaluated:

  • package
  • subpackage
  • controller
  • action
  • arguments
  • format
  • section
  • additionalParams
  • addQueryString
  • argumentsToBeExcludedFromQueryString
  • absolute

See respective getters for descriptions

Properties

protected Runtime $runtime from  AbstractFusionObject
protected string $path

The Fusion path currently being rendered

from  AbstractFusionObject
protected string $fusionObjectName

Name of this Fusion object, like Neos.Neos:Text

from  AbstractFusionObject
protected array $fusionValueCache from  AbstractFusionObject

Methods

__construct(Runtime $runtime, string $path, string $fusionObjectName)

Constructor

mixed
evaluate()

No description

getRuntime()

Get the Fusion runtime this object was created in.

mixed
fusionValue(string $path)

Return the Fusion value relative to this Fusion object (with processors etc applied).

bool
offsetExists(mixed $offset)

Dummy implementation of ArrayAccess to allow this.XXX access in processors.

mixed
offsetGet(mixed $offset)

Dummy implementation of ArrayAccess to allow this.XXX access in processors.

void
offsetSet(mixed $offset, mixed $value)

Dummy implementation of ArrayAccess to allow this.XXX access in processors.

void
offsetUnset(mixed $offset)

Dummy implementation of ArrayAccess to allow this.XXX access in processors.

string
getPackage()

Key of the target package

string
getSubpackage()

Key of the target sub package

string
getController()

Target controller name

string
getAction()

Target controller action name

array
getArguments()

Controller arguments

string
getFormat()

The requested format, for example "html"

string
getSection()

The anchor to be appended to the URL

array
getAdditionalParams()

Additional query parameters that won't be prefixed like $arguments (overrule $arguments)

array
getArgumentsToBeExcludedFromQueryString()

Arguments to be removed from the URI. Only active if addQueryString = true

bool
isAddQueryString()

If true, the current query parameters will be kept in the URI

bool
isAbsolute()

If true, an absolute URI is rendered

Details

__construct(Runtime $runtime, string $path, string $fusionObjectName)

Constructor

Parameters

Runtime $runtime
string $path
string $fusionObjectName

mixed evaluate()

No description

Return Value

mixed

Runtime getRuntime()

Get the Fusion runtime this object was created in.

Return Value

Runtime

protected mixed fusionValue(string $path)

Return the Fusion value relative to this Fusion object (with processors etc applied).

Note that subsequent calls of fusionValue() with the same Fusion path will return the same values since the first evaluated value will be cached in memory.

Parameters

string $path

Return Value

mixed

bool offsetExists(mixed $offset)

Dummy implementation of ArrayAccess to allow this.XXX access in processors.

Parameters

mixed $offset

Return Value

bool

mixed offsetGet(mixed $offset)

Dummy implementation of ArrayAccess to allow this.XXX access in processors.

Parameters

mixed $offset

Return Value

mixed

void offsetSet(mixed $offset, mixed $value)

Dummy implementation of ArrayAccess to allow this.XXX access in processors.

Parameters

mixed $offset
mixed $value

Return Value

void

void offsetUnset(mixed $offset)

Dummy implementation of ArrayAccess to allow this.XXX access in processors.

Parameters

mixed $offset

Return Value

void

string getPackage()

Key of the target package

Return Value

string

string getSubpackage()

Key of the target sub package

Return Value

string

string getController()

Target controller name

Return Value

string

string getAction()

Target controller action name

Return Value

string

array getArguments()

Controller arguments

Return Value

array

string getFormat()

The requested format, for example "html"

Return Value

string

string getSection()

The anchor to be appended to the URL

Return Value

string

array getAdditionalParams()

Additional query parameters that won't be prefixed like $arguments (overrule $arguments)

Return Value

array

array getArgumentsToBeExcludedFromQueryString()

Arguments to be removed from the URI. Only active if addQueryString = true

Return Value

array

bool isAddQueryString()

If true, the current query parameters will be kept in the URI

Return Value

bool

bool isAbsolute()

If true, an absolute URI is rendered

Return Value

bool