Documentation · ViewHelper reference

FormViewHelper

FlexForm configuration container ViewHelper /

  • Tag usage example

    <flux:form id="NULL" label="NULL" description="NULL" enabled="1" compact="1" variables="{foo: 'bar'}" options="{foo: 'bar'}" localLanguageFileRelativePath="'/Resources/Private/Language/locallang.xlf'" extensionName="NULL">
    	<!-- tag content - may be ignored! -->
    </flux:form>
  • Inline usage example

    {flux:form(id: 'NULL', label: 'NULL', description: 'NULL', enabled: 1, compact: 1, variables: {foo: 'bar'}, options: {foo: 'bar'}, localLanguageFileRelativePath: ''/Resources/Private/Language/locallang.xlf'', extensionName: 'NULL')}

Arguments

Argument Description Type
compact

If TRUE, disables sheet usage in the form. WARNING! AVOID DYNAMIC VALUES AT ALL COSTS! Toggling this option is DESTRUCTIVE to variables currently saved in the database!

boolean
description

Short description of the purpose/function of this form

string
enabled

If FALSE, features which use this form can elect to skip it. Respect for this flag depends on the feature using the form.

boolean
extensionName

If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

string
id

Identifier of this Flexible Content Element, /[a-z0-9]/i allowed

string
label

Label for the form, can be LLL: value. Optional - if not specified, Flux tries to detect an LLL label named "flux.fluxFormId", in scope of extension rendering the Flux form.

string
localLanguageFileRelativePath

Relative (from extension) path to locallang file containing labels for the LLL values used in this form.

string
options

Custom options to be assigned to Form object - valid values depends on the. See docs of extension in which you use this feature. Can also be set using flux:form.option as child of flux:form.

array
variables

Freestyle variables which become assigned to the resulting Component - can then be read from that Component outside this Fluid template and in other templates using the Form object from this template

array
Required attribute

Revision history

commit 3390bd05f546bccfc9ca5cb012d291f7bdd63512
Author: Claus Due <*****@namelesscoder.net>
Date:   Mon Dec 2 23:26:43 2013 +0100

    [TASK] Rename ViewHelpers
    
    Renames:
    
    flux:flexform -> flux:form
    flux:flexform.field.* -> flux:field.*
    flux:flexform.field.wizard -> flux:wizard.*
    flux:flexform.* -> flux:form.*

commit 3878c943a6eb0924bb6db2e5ed8461580896431f
Author: Claus Due <*****@namelesscoder.net>
Date:   Tue Dec 10 01:59:34 2013 +0100

    [TASK] Update copyright and author tags
    
    Assumes "Claus Due" as author whenever no author is specified.

commit 774bc8704b02e3a8b08561b24aa7c58a4cb79a92
Author: Claus Due <*****@namelesscoder.net>
Date:   Wed Dec 11 22:41:37 2013 +0100

    [TASK] Support form variable stored in template variables

commit b37dbbd83d210d12d1f0b2517b06818225ea3608
Author: Claus Due <*****@namelesscoder.net>
Date:   Tue Dec 17 17:30:12 2013 +0100

    [FEATURE] Storage of custom variables on FormComponents
    
    This allows a "variables" property to be used on every Form component and ViewHelper. Setting an array of variables here, makes those variables available anywhere the Form object is available.
    
    Can, for example, be used to store custom rendering instructions for the Preview section as described in #411

commit 8bf2b5beb89c7d72a41230f152d9a5a3d308ba84
Author: Claus Due <*****@namelesscoder.net>
Date:   Tue Dec 31 23:11:00 2013 +0100

    [TASK] Happy new year!

commit f0ee440ea328f84e22770b1c99a449305a91412c
Author: Claus Due <*****@namelesscoder.net>
Date:   Wed Apr 2 00:30:06 2014 +0200

    [TASK] Support missing "options" argument on flux:form

commit 593885343f601d17d642b4480b88c17d029435d4
Author: Danilo Bürger <*****@hmspl.de>
Date:   Sun May 18 22:08:45 2014 +0200

    [TASK] Add localLanguageFileRelativePath to flux:form

commit 9de10c5eb9479802cda2440d2cbb30a4bfe294d6
Author: Claus Due <*****@namelesscoder.net>
Date:   Tue Jul 29 15:15:30 2014 +0200

    [TASK] Deprecate wizardTab and icon attributes on Form
    
    This change:
    
    * Marks as deprecated in code and rendered documentation, the arguments `wizardTab` and `icon` on `flux:form` in favour of the `options` attribute which is an array that can contain a `group` (equivalent of `wizardTab`) and an `icon` member.
    * Removes properties on `FluidTYPO3\Flux\Form` but leaves in place getter and setter with deprecation logging, redirects storage to `options` class member.
    * Introduces `OPTION_*` constants on `FluidTYPO3\Flux\Form` which define supported options. Other extensions are expected to either use what is provided here or introduce own constants (as constants in their own extension's namespace).

commit 6f5a3094e448fb38a3cad85712160d5be16dae50
Author: Claus Due <*****@namelesscoder.net>
Date:   Mon Oct 6 21:51:21 2014 +0200

    [TASK] Coverage, ViewHelper scope
    
    One noteworthy refactoring: introduce constant for LLL relative path on Form/FormViewHelper.