PHP Class Neos\Fusion\TypoScriptObjects\UriBuilderImplementation

The following TS properties are evaluated: * package * subpackage * controller * action * arguments * format * section * additionalParams * addQueryString * argumentsToBeExcludedFromQueryString * absolute See respective getters for descriptions
Inheritance: extends AbstractTypoScriptObject
Show file Open project: neos/neos-development-collection

Public Methods

Method Description
evaluate ( ) : string
getAction ( ) : string Target controller action name
getAdditionalParams ( ) : array Additional query parameters that won't be prefixed like $arguments (overrule $arguments)
getArguments ( ) : array Controller arguments
getArgumentsToBeExcludedFromQueryString ( ) : array Arguments to be removed from the URI. Only active if addQueryString = TRUE
getController ( ) : string Target controller name
getFormat ( ) : string The requested format, for example "html"
getPackage ( ) : string Key of the target package
getSection ( ) : string The anchor to be appended to the URL
getSubpackage ( ) : string Key of the target sub package
isAbsolute ( ) : boolean If TRUE, an absolute URI is rendered
isAddQueryString ( ) : boolean If TRUE, the current query parameters will be kept in the URI

Method Details

evaluate() public method

public evaluate ( ) : string
return string

getAction() public method

Target controller action name
public getAction ( ) : string
return string

getAdditionalParams() public method

Additional query parameters that won't be prefixed like $arguments (overrule $arguments)
public getAdditionalParams ( ) : array
return array

getArguments() public method

Controller arguments
public getArguments ( ) : array
return array

getArgumentsToBeExcludedFromQueryString() public method

Arguments to be removed from the URI. Only active if addQueryString = TRUE
public getArgumentsToBeExcludedFromQueryString ( ) : array
return array

getController() public method

Target controller name
public getController ( ) : string
return string

getFormat() public method

The requested format, for example "html"
public getFormat ( ) : string
return string

getPackage() public method

Key of the target package
public getPackage ( ) : string
return string

getSection() public method

The anchor to be appended to the URL
public getSection ( ) : string
return string

getSubpackage() public method

Key of the target sub package
public getSubpackage ( ) : string
return string

isAbsolute() public method

If TRUE, an absolute URI is rendered
public isAbsolute ( ) : boolean
return boolean

isAddQueryString() public method

If TRUE, the current query parameters will be kept in the URI
public isAddQueryString ( ) : boolean
return boolean