ValidForm Builder API Documentation

ValidForm extends ClassDynamic

in package

• ValidForm

ValidForm Builder main class - all the magic starts here.

$objForm = new ValidForm("cool_new_form", "Please fill out my cool form", "/awesome-submits");

$objForm->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"
    )
);

//*** Add a checklist
$objCheck = $objForm->addField("cool", "Cool checklist", ValidForm::VFORM_CHECK_LIST);
$objCheck->addField("Option 1", "option1");
$objCheck->addField("Option 2", "option2");
$objCheck->addField("Option 3", "option3");

// Add a standard string field
$objCheck = $objForm->addField("cool-text", "Coolest PHP Library", ValidForm::VFORM_STRING);

$objForm->setDefaults([
    // Set value of field 'cool text' to 'ValidForm Builder'
    "cool-text" => "ValidForm Builder",
    // Check options 2 and 3
    "cool" => ["option2", "option3"]
]);

Tags

author

Felix Langfeldt [email protected]

author

Robin van Baalen [email protected]

version

5.3.0

Table of Contents

Methods

getAction()  : string

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

getDescription()  : string

getDisplayErrors()  : bool

getElements()  : Collection

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

getMainAlert()  : string

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

getName()  : string

getNoValuesMessage()  : string

getRequiredStyle()  : string

getSubmitLabel()  : string

setAction()  : void

setCachedFields()  : void

setDescription()  : void

setDisplayErrors()  : void

setElements()  : void

setJsEvents()  : void

setMainAlert()  : void

setMeta()  : void

setName()  : void

setNoValuesMessage()  : void

setRequiredStyle()  : void

setSubmitLabel()  : void

setUniqueId()  : void

setUseCsrfProtection()  : void