PHP Class Neos\Neos\ViewHelpers\Uri\ModuleViewHelper

= Examples =

Inheritance: extends Neos\FluidAdaptor\Core\ViewHelper\AbstractViewHelper

Mostra file Open project: neos/neos-development-collection Class Usage Examples

Protected Properties

Property	Type	Description
$uriBuilder	Neos\Flow\Mvc\Routing\UriBuilder

Public Methods

Method	Description
render ( string $path, string $action = null, array $arguments = [], string $section = '', string $format = '', array $additionalParams = [], boolean $addQueryString = false, array $argumentsToBeExcludedFromQueryString = [] ) : string	Render a link to a specific module

Protected Methods

Method	Description
setMainRequestToUriBuilder ( ) : void	Extracted out to this method in order to be better unit-testable.

Method Details

render() public method

Render a link to a specific module

public render ( string $path, string $action = null, array $arguments = [], string $section = '', string $format = '', array $additionalParams = [], boolean $addQueryString = false, array $argumentsToBeExcludedFromQueryString = [] ) : string
$path	string	Target module path
$action	string	Target module action
$arguments	array	Arguments
$section	string	The anchor to be added to the URI
$format	string	The requested format, e.g. ".html"
$additionalParams	array	additional query parameters that won't be prefixed like $arguments (overrule $arguments)
$addQueryString	boolean	If set, the current query parameters will be kept in the URI
$argumentsToBeExcludedFromQueryString	array	arguments to be removed from the URI. Only active if $addQueryString = TRUE
return	string	The rendered link

setMainRequestToUriBuilder() protected method

Extracted out to this method in order to be better unit-testable.

protected setMainRequestToUriBuilder ( ) : void
return	void

Property Details

$uriBuilder protected_oe property

protected UriBuilder,Neos\Flow\Mvc\Routing $uriBuilder
return	Neos\Flow\Mvc\Routing\UriBuilder