ViewHelper Documentation
flux:outlet.form
Outlet Form Renderer
Specialised version of f:form
which adds three vital behaviors:
- Automatic resolving of the correct extension name and plugin name
- Automatic use of "outletAction" on controller
- Addition of table name and UID as to prevent calling "outletAction" on any other instance than the one which rendered the form.
Together these specialised behaviors mean that the form data will only be processed by the exact instance from which the form was rendered, and will always target the correct plugin namespace for the arguments to be recognised.
To customise handling of this form, add an "outletAction" to your Flux controller with which your template is associated, e.g. your "ContentController", "PageController" etc.
Arguments
- additionalAttributes
- data
- action
- arguments
- controller
- extensionName
- pluginName
- pageUid
- object
- pageType
- noCache
- noCacheHash
- section
- format
- additionalParams
- absolute
- addQueryString
- argumentsToBeExcludedFromQueryString
- addQueryStringMethod
- fieldNamePrefix
- actionUri
- objectName
- hiddenFieldClassName
- enctype
- method
- name
- onreset
- onsubmit
- target
- novalidate
- class
- dir
- id
- lang
- style
- title
- accesskey
- tabindex
- onclick
additionalAttributes anySimpleType
Additional tag attributes. They will be added directly to the resulting HTML tag.
data anySimpleType
Additional data-* attributes. They will each be added with a "data-" prefix.
action string
Target action
arguments anySimpleType
Arguments
controller string
Target controller
extensionName string
Target Extension Name (without "tx_" prefix and no underscores). If NULL the current extension name is used
pluginName string
Target plugin. If empty, the current plugin name is used
pageUid anySimpleType
Target page uid
object anySimpleType
Object to use for the form. Use in conjunction with the "property" attribute on the sub tags
pageType anySimpleType
Target page type
noCache anySimpleType
set this to disable caching for the target page. You should not need this.
noCacheHash anySimpleType
set this to suppress the cHash query parameter created by TypoLink. You should not need this.
section string
The anchor to be added to the action URI (only active if $actionUri is not set)
format string
The requested format (e.g. ".html") of the target page (only active if $actionUri is not set)
additionalParams anySimpleType
additional action URI query parameters that won't be prefixed like $arguments (overrule $arguments) (only active if $actionUri is not set)
absolute anySimpleType
If set, an absolute action URI is rendered (only active if $actionUri is not set)
addQueryString anySimpleType
If set, the current query parameters will be kept in the action URI (only active if $actionUri is not set)
argumentsToBeExcludedFromQueryString anySimpleType
arguments to be removed from the action URI. Only active if $addQueryString = TRUE and $actionUri is not set
addQueryStringMethod string
Method to use when keeping query parameters (GET or POST, only active if $actionUri is not set
fieldNamePrefix string
Prefix that will be added to all field names within this form. If not set the prefix will be tx_yourExtension_plugin
actionUri string
can be used to overwrite the "action" attribute of the form tag
objectName string
name of the object that is bound to this form. If this argument is not specified, the name attribute of this form is used to determine the FormObjectName
hiddenFieldClassName string
hiddenFieldClassName
enctype string
MIME type with which the form is submitted
method string
Transfer type (GET or POST)
name string
Name of form
onreset string
JavaScript: On reset of the form
onsubmit string
JavaScript: On submit of the form
target string
Target attribute of the form
novalidate anySimpleType
Indicate that the form is not to be validated on submit.
class string
CSS class(es) for this element
dir string
Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left)
id string
Unique (in this file) identifier for this HTML element.
lang string
Language for this element. Use short names specified in RFC 1766
style string
Individual CSS styles for this element
title string
Tooltip text of element
accesskey string
Keyboard shortcut to access this element
tabindex integer
Specifies the tab order of this element
onclick string
JavaScript evaluated for the onclick event