PHP Class Neos\Neos\ViewHelpers\Link\ModuleViewHelper

= Examples = some link some link
Inheritance: extends Neos\FluidAdaptor\Core\ViewHelper\AbstractTagBasedViewHelper
Show file Open project: neos/neos-development-collection Class Usage Examples

Protected Properties

Property Type Description
$tagName string
$uriModuleViewHelper Neos\Neos\ViewHelpers\Uri\ModuleViewHelper

Public Methods

Method Description
initializeArguments ( ) : void Initialize arguments
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

Method Details

initializeArguments() public method

Initialize arguments
public initializeArguments ( ) : void
return void

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

Property Details

$tagName protected property

protected string $tagName
return string

$uriModuleViewHelper protected property

protected ModuleViewHelper,Neos\Neos\ViewHelpers\Uri $uriModuleViewHelper
return Neos\Neos\ViewHelpers\Uri\ModuleViewHelper