Uri.action ViewHelper <f:uri.action>
¶
A ViewHelper for creating URIs to extbase actions. Tailored for extbase plugins, uses extbase Request and extbase UriBuilder.
Examples¶
URI to the show-action of the current controller:
<f:uri.action action="show" />
Copied!
/page/path/name.html?tx_myextension_plugin[action]=show&tx_myextension_plugin[controller]=Standard&cHash=xyz
Depending on current page, routing and page path configuration.
Source code
Go to the source code of this ViewHelper: Uri\ActionViewHelper.php (GitHub).
Arguments
The following arguments are available for the uri.action ViewHelper:
-
absolute
¶ -
- Type
- bool
- Default
- false
If set, an absolute URI is rendered
-
action
¶ -
- Type
- string
Target action
-
addQueryString
¶ -
- Type
- string
- Default
- false
If set, the current query parameters will be kept in the URL. If set to "untrusted", then ALL query parameters will be added. Be aware, that this might lead to problems when the generated link is cached.
-
additionalParams
¶ -
- Type
- array
- Default
- array ( )
additional query parameters that won't be prefixed like $arguments (overrule $arguments)
-
arguments
¶ -
- Type
- array
- Default
- array ( )
Arguments (do not use reserved keywords "action", "controller" or "format" if not referring to these internal variables specifically)
-
argumentsToBeExcludedFromQueryString
¶ -
- Type
- array
- Default
- array ( )
arguments to be removed from the URI. Only active if $addQueryString = TRUE
-
controller
¶ -
- Type
- string
Target controller. If NULL current controllerName is used
-
extensionName
¶ -
- Type
- string
Target Extension Name (without `tx_` prefix and no underscores). If NULL the current extension name is used
-
format
¶ -
- Type
- string
- Default
- ''
The requested format, e.g. ".html
-
language
¶ -
- Type
- string
link to a specific language - defaults to the current language, use a language ID or "current" to enforce a specific language
-
linkAccessRestrictedPages
¶ -
- Type
- bool
- Default
- false
If set, links pointing to access restricted pages will still link to the page even though the page cannot be accessed.
-
noCache
¶ -
- Type
- bool
Set this to disable caching for the target page. You should not need this.
-
pageType
¶ -
- Type
- int
- Default
- 0
Type of the target page. See typolink.parameter
-
pageUid
¶ -
- Type
- int
Target page. See TypoLink destination
-
pluginName
¶ -
- Type
- string
Target plugin. If empty, the current plugin name is used
-
section
¶ -
- Type
- string
- Default
- ''
The anchor to be added to the URI