ValidForm Builder API Documentation

Text extends Element

in package

• ValidForm

Text Class is the most used.

$objForm->addField(
    "first-name",
    "First name",
    ValidForm::VFORM_STRING,
    array(
        // Make this field required
        "required" => true,
        // It should have a maximum of 10 characters
        "maxLength" => 10,
        // It should have a minimum of 3 characters
        "minLength" => 3
    ),
    array(
        // Error message when required state isn't met
        "required" => "This is a required field",
        // Error message when input length is larger than 10 characters
        "maxLength" => "Maximum of %s characters allowed.",
        // Error message when input length is shorter than 3 characters
        "minLength" => "Minimum of %s characters required."
    ),
    array(
        // Add a custom class to the input element
        // This results in something like
        // <input type='text' class='vf__text custom-class'>
        "fieldclass" => "custom-class",
        // Add a custom class to the field container
        // This results in
        // <div class='vf__required container-class'>
        //     <input type='text'>
        // </div>
        "class" => "container-class"

    )
);

Tags

author

Felix Langfeldt [email protected]

author

Robin van Baalen [email protected]

version

5.3.0

Table of Contents

Methods

addField()  : Element

getDynamicLabelMate()  : array<string|int, mixed>

getDynamicRemoveLabelMate()  : array<string|int, mixed>

getHint()  : string

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>

getTip()  : string

getTipMeta()  : array<string|int, mixed>

getType()  : int

getValidator()  : FieldValidator

setConditions()  : void

setHint()  : void

setId()  : void

setLabel()  : void

setName()  : void

setParent()  : void

setRequiredStyle()  : void

setTip()  : void

setType()  : void

setValidator()  : void