Area
        
        extends Base
    
    
            
            in package
            
        
    
    
    
Group fields together in an Area
An area is about the same as a fieldset but an Area has more interactive options like the 'active' property or even the 'dynamic' meta.
An Area can be used to group form fields together. When an Area is active, it can toggle the disabled state on all it's child form fields using the auto-generated checkbox in the Area's legend.
Example; Active area
$objArea = $objForm->addArea("Disable fields", true, "fields-disabled");
$objArea->addField(
    "first-name",
    "First name",
    ValidForm::VFORM_STRING,
    array(
        // Make this field required
        "required" => true
    ),
    array(
        // Show this error to indicate this is an required field if no value is submitted
        "required" => "This field is required"
    )
);
$objArea->addField(
    "last-name",
    "Last name",
    ValidForm::VFORM_STRING,
    array(
        // Make this field required
        "required" => true
    ),
    array(
        // Show this error to indicate this is an required field if no value is submitted
        "required" => "This field is required"
    )
);
Example 2; Adding a string field to the area
$objArea = $objForm->addArea("Cool area");
$objArea->addField("first-name", "First name", ValidForm::VFORM_STRING);
Example 3; Addding a paragraph to the Area
$objArea->addParagraph(
    "Cool paragraph with lots of text in it. It's an absolute must-read.",
    "You must read this"
);
Tags
Table of Contents
Methods
- getDynamicLabelMate() : array<string|int, mixed>
- getDynamicRemoveLabelMate() : array<string|int, mixed>
- getId() : string
- getLabel() : string
- getMagicMeta() : array<string|int, mixed>
- getMagicReservedMeta() : array<string|int, mixed>
- getParent() : Base
- getRequiredStyle() : string
- getReservedFieldMeta() : array<string|int, mixed>
- getReservedLabelMeta() : array<string|int, mixed>
- getReservedMeta() : array<string|int, mixed>
- getTipMeta() : array<string|int, mixed>
- setConditions() : void
- setId() : void
- setLabel() : void
- setName() : void
- setParent() : void
- setRequiredStyle() : void
Methods
getDynamicLabelMate()
    public
                    getDynamicLabelMate() : array<string|int, mixed>
    getDynamicLabelMate() Returns the value of $__dynamiclabelmeta
Return values
array<string|int, mixed>getDynamicRemoveLabelMate()
    public
                    getDynamicRemoveLabelMate() : array<string|int, mixed>
    getDynamicRemoveLabelMate() Returns the value of $__dynamicremovelabelmeta
Return values
array<string|int, mixed>getId()
    public
                    getId() : string
    getId() Returns the value of $__id
Return values
stringgetLabel()
    public
                    getLabel() : string
    getLabel() Returns the value of $__label
Return values
stringgetMagicMeta()
    public
                    getMagicMeta() : array<string|int, mixed>
    getMagicMeta() Returns the value of $__magicmeta
Return values
array<string|int, mixed>getMagicReservedMeta()
    public
                    getMagicReservedMeta() : array<string|int, mixed>
    getMagicReservedMeta() Returns the value of $__magicreservedmeta
Return values
array<string|int, mixed>getParent()
    public
                    getParent() : Base
    getParent() Returns the value of $__parent
Return values
BasegetRequiredStyle()
    public
                    getRequiredStyle() : string
    getRequiredStyle() Returns the value of $__requiredstyle
Return values
stringgetReservedFieldMeta()
    public
                    getReservedFieldMeta() : array<string|int, mixed>
    getReservedFieldMeta() Returns the value of $__reservedfieldmeta
Return values
array<string|int, mixed>getReservedLabelMeta()
    public
                    getReservedLabelMeta() : array<string|int, mixed>
    getReservedLabelMeta() Returns the value of $__reservedlabelmeta
Return values
array<string|int, mixed>getReservedMeta()
    public
                    getReservedMeta() : array<string|int, mixed>
    getReservedMeta() Returns the value of $__reservedmeta
Return values
array<string|int, mixed>getTipMeta()
    public
                    getTipMeta() : array<string|int, mixed>
    getTipMeta() Returns the value of $__tipmeta
Return values
array<string|int, mixed>setConditions()
    public
                    setConditions() : void
    setConditions(array $value) Overwrites the value of $__conditions
setId()
    public
                    setId() : void
    setId(string $value) Overwrites the value of $__id
setLabel()
    public
                    setLabel() : void
    setLabel(string $value) Overwrites the value of $__label
setName()
    public
                    setName() : void
    setName(string $value) Overwrites the value of $__name
setParent()
    public
                    setParent() : void
    setParent(Base $value) Overwrites the value of $__parent
setRequiredStyle()
    public
                    setRequiredStyle() : void
    setRequiredStyle(string $value) Overwrites the value of $__requiredstyle