Documentation · ViewHelper reference

Form / ObjectViewHelper

FlexForm field section object ViewHelper

Use this inside flux:form.section to name and divide the fields into individual objects that can be inserted into the section. /

  • Tag usage example

    <flux:form.object name="NULL" label="NULL" variables="{foo: 'bar'}" extensionName="NULL" inherit="1" inheritEmpty="1">
    	<!-- tag content - may be ignored! -->
    </flux:form.object>
  • Inline usage example

    {flux:form.object(name: 'NULL', label: 'NULL', variables: {foo: 'bar'}, extensionName: 'NULL', inherit: 1, inheritEmpty: 1)}

Arguments

Argument Description Type
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
inherit

If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

boolean
inheritEmpty

If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

boolean
label

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

string
name

Name of the section object, FlexForm XML-valid tag name string

string
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 b368d625c642eb1b7baf01935234f54e3df5e2b7
Author: Danilo Bürger <*****@hmspl.de>
Date:   Mon Dec 9 12:33:26 2013 +0100

    [BUGFIX] Namespaces

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 821a3ddf1ee06a6110f0c0e2381297d9958f8bb3
Author: Claus Due <*****@namelesscoder.net>
Date:   Mon Dec 16 22:00:13 2013 +0100

    [TASK] Replace author annotations still using old email

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 86ac75f1af751580438553cedc17ef0989fe872e
Author: Claus Due <*****@namelesscoder.net>
Date:   Sun Dec 22 00:16:04 2013 +0100

    [TASK] Fix an import in ObjectViewHelper
    
    Not a bug fix since the import only affected a variable type annotation.

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

    [TASK] Happy new year!

commit b9f2002bf6eda3fb28558b5dd8c875464e8b3c25
Author: G. Bodenschatz <*****@46halbe.de>
Date:   Wed Sep 17 00:43:56 2014 +0200

    [TASK] Remove unnecessary and unused aliases

commit daca275962f23143cffb90b92f9d7be5fedbc4bd
Author: Claus Due <*****@namelesscoder.net>
Date:   Sun Oct 5 21:01:09 2014 +0200

    [TASK] Fix a couple hundred CGL and declaration issues

commit 09dbb94ff9bd6fe1772b958c7b4b1d523d8e5587
Author: Claus Due <*****@namelesscoder.net>
Date:   Thu Oct 9 01:14:49 2014 +0200

    [TASK] Optimise and sort imports