Documentation · ViewHelper reference

Outlet / FormViewHelper

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. /

  • Tag usage example

    <flux:outlet.form additionalAttributes="{foo: 'bar'}" data="{foo: 'bar'}" action="NULL" arguments="{foo: 'bar'}" controller="NULL" extensionName="NULL" pluginName="NULL" pageUid="[anySimpleType]" object="[mixed]" pageType="[anySimpleType]" noCache="[anySimpleType]" noCacheHash="[anySimpleType]" section="''" format="''" additionalParams="{foo: 'bar'}" absolute="[anySimpleType]" addQueryString="[anySimpleType]" argumentsToBeExcludedFromQueryString="{foo: 'bar'}" addQueryStringMethod="'GET'" fieldNamePrefix="NULL" actionUri="NULL" objectName="NULL" hiddenFieldClassName="NULL" enctype="NULL" method="NULL" name="NULL" onreset="NULL" onsubmit="NULL" target="NULL" class="NULL" dir="NULL" id="NULL" lang="NULL" style="NULL" title="NULL" accesskey="NULL" tabindex="123" onclick="NULL">
    	<!-- tag content - may be ignored! -->
    </flux:outlet.form>
  • Inline usage example

    {flux:outlet.form(additionalAttributes: {foo: 'bar'}, data: {foo: 'bar'}, action: 'NULL', arguments: {foo: 'bar'}, controller: 'NULL', extensionName: 'NULL', pluginName: 'NULL', pageUid: [anySimpleType], object: [mixed], pageType: [anySimpleType], noCache: [anySimpleType], noCacheHash: [anySimpleType], section: '''', format: '''', additionalParams: {foo: 'bar'}, absolute: [anySimpleType], addQueryString: [anySimpleType], argumentsToBeExcludedFromQueryString: {foo: 'bar'}, addQueryStringMethod: ''GET'', fieldNamePrefix: 'NULL', actionUri: 'NULL', objectName: 'NULL', hiddenFieldClassName: 'NULL', enctype: 'NULL', method: 'NULL', name: 'NULL', onreset: 'NULL', onsubmit: 'NULL', target: 'NULL', class: 'NULL', dir: 'NULL', id: 'NULL', lang: 'NULL', style: 'NULL', title: 'NULL', accesskey: 'NULL', tabindex: 123, onclick: 'NULL')}

Arguments

Argument Description Type
absolute

If set, an absolute action URI is rendered (only active if $actionUri is not set)

anySimpleType
accesskey

Keyboard shortcut to access this element

string
action

Target action

string
actionUri

can be used to overwrite the "action" attribute of the form tag

string
addQueryString

If set, the current query parameters will be kept in the action URI (only active if $actionUri is not set)

anySimpleType
addQueryStringMethod

Method to use when keeping query parameters (GET or POST, only active if $actionUri is not set

string
additionalAttributes

Additional tag attributes. They will be added directly to the resulting HTML tag.

array
additionalParams

additional action URI query parameters that won't be prefixed like $arguments (overrule $arguments) (only active if $actionUri is not set)

array
arguments

Arguments

array
argumentsToBeExcludedFromQueryString

arguments to be removed from the action URI. Only active if $addQueryString = TRUE and $actionUri is not set

array
class

CSS class(es) for this element

string
controller

Target controller

string
data

Additional data-* attributes. They will each be added with a "data-" prefix.

array
dir

Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left)

string
enctype

MIME type with which the form is submitted

string
extensionName

Target Extension Name (without "tx_" prefix and no underscores). If NULL the current extension name is used

string
fieldNamePrefix

Prefix that will be added to all field names within this form. If not set the prefix will be txyourExtensionplugin

string
format

The requested format (e.g. ".html") of the target page (only active if $actionUri is not set)

string
hiddenFieldClassName

hiddenFieldClassName

string
id

Unique (in this file) identifier for this HTML element.

string
lang

Language for this element. Use short names specified in RFC 1766

string
method

Transfer type (GET or POST)

string
name

Name of form

string
noCache

set this to disable caching for the target page. You should not need this.

anySimpleType
noCacheHash

set this to suppress the cHash query parameter created by TypoLink. You should not need this.

anySimpleType
object

Object to use for the form. Use in conjunction with the "property" attribute on the sub tags

mixed
objectName

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

string
onclick

JavaScript evaluated for the onclick event

string
onreset

JavaScript: On reset of the form

string
onsubmit

JavaScript: On submit of the form

string
pageType

Target page type

anySimpleType
pageUid

Target page uid

anySimpleType
pluginName

Target plugin. If empty, the current plugin name is used

string
section

The anchor to be added to the action URI (only active if $actionUri is not set)

string
style

Individual CSS styles for this element

string
tabindex

Specifies the tab order of this element

integer
target

Target attribute of the form

string
title

Tooltip text of element

string
Required attribute

Revision history