FormBuilderForm class

Located in file /site/modules/FormBuilder/FormBuilderForm.php

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the FormBuilderForm class also inherits all the methods and properties of: FormBuilderField and FormBuilderData.

Common

Name	Return	Summary
FormBuilderForm::_styles	`string`	Runtime property for frameworks to populate inline styles.
FormBuilderForm::action	`string`
FormBuilderForm::action2	`string`	Duplicate submission URL
FormBuilderForm::action2_add	`string`	Add fields to duplicate submission (textarea format string)
FormBuilderForm::action2_remove	`string`	Newline separated field names to remove from duplicate submission
FormBuilderForm::action2_rename	`string`	Key=value format string of fields to rename in duplicate submission, one per line.
FormBuilderForm::add() FormBuilderForm::add(FormBuilderField $child) FormBuilderForm::add(FormBuilderField $child)	`FormBuilderForm` `FormBuilderField`	Add a new child to this form/field
FormBuilderForm::addFlag() FormBuilderForm::addFlag($flag) FormBuilderForm::addFlag($flag, string $property = 'flags')	(nothing)	Add flag to form
FormBuilderForm::akismet	`string`	CSV data for Akismet
FormBuilderForm::allowPreset	`bool` `int`	Preset field values from GET variables?
FormBuilderForm::backText	`string`	Default “back” button text
FormBuilderForm::emailFrom	`string`	Email reply-to address (also used as from address if emailFrom2 not specified)
FormBuilderForm::emailFrom2	`string`	Email from address (if different from emailFrom)
FormBuilderForm::emailSubject	`string`	Email subject line
FormBuilderForm::emailTo	`string`	Email address, addresses, or format string to send form results to
FormBuilderForm::entries() FormBuilderForm::entries() FormBuilderForm::entries()	`FormBuilderEntries`	Get this form's FormBuilderEntries instance
FormBuilderForm::entryDays	`int`	Maximum days an entry is allowed to be saved in the system
FormBuilderForm::errorMessage	`string`
FormBuilderForm::fbRender	`FormBuilderRender` `null`
FormBuilderForm::firstEntryDate	`string`
FormBuilderForm::flags	`int`	Form flags (see FormBuilderProcessor::formFlag* constants)
FormBuilderForm::formFlags	`int`	Alias of $flags
FormBuilderForm::forms	`FormBuilderMain`
FormBuilderForm::framework	`string`
FormBuilderForm::get() FormBuilderForm::get(string $key) FormBuilderForm::get(string $key)	`mixed`	Ensure that direct access to 'processor' or 'entries' goes to the right place
FormBuilderForm::getErrors() FormBuilderForm::getErrors() FormBuilderForm::getErrors()	`array`	Return a list of errors that occurred, if submitted.
FormBuilderForm::getFbRender() FormBuilderForm::getFbRender() FormBuilderForm::getFbRender()	`FormBuilderRender` `null`	Get the FormBuilderRender used by this form (when available)
FormBuilderForm::getFramework() FormBuilderForm::getFramework() FormBuilderForm::getFramework()	`null` `FormBuilderFramework`	Get form Framework
FormBuilderForm::getInputfield() FormBuilderForm::getInputfield() FormBuilderForm::getInputfield(array $options = [])	`InputfieldForm` `Inputfield`	Get new InputfieldForm for this FormBuilderForm
FormBuilderForm::getNumPaginations() FormBuilderForm::getNumPaginations() FormBuilderForm::getNumPaginations()	`int`	Return quantity of paginations found in form
FormBuilderForm::getPageBreakFields() FormBuilderForm::getPageBreakFields() FormBuilderForm::getPageBreakFields()	`array`	Get array of fields having type FormBuilderPageBreak, indexed by page number
FormBuilderForm::googleSheetsResponseField	`string`
FormBuilderForm::googleSpreadsheetFields	`array` `null`
FormBuilderForm::googleSpreadsheetUrl	`string` `null`
FormBuilderForm::hLevel	`int`	Headline level (used above forms with pagination, 0=off)
FormBuilderForm::hasField() FormBuilderForm::hasField(string $name) FormBuilderForm::hasField(string $name)	`bool`	Does form having a field with given nane?
FormBuilderForm::hasFlag() FormBuilderForm::hasFlag(int $flag) FormBuilderForm::hasFlag(int $flag, string $property = 'flags')	`int`	Does this form have the given flag?
FormBuilderForm::hasPermission() FormBuilderForm::hasPermission(string $name) FormBuilderForm::hasPermission(string $name)	`bool`	Does current user have requested permission to this form?
FormBuilderForm::honeypot	`string`	Name of honeypot field
FormBuilderForm::id	`int`
FormBuilderForm::isSubmitted() FormBuilderForm::isSubmitted() FormBuilderForm::isSubmitted()	`bool`	Was the form submitted?
FormBuilderForm::lastEntryDate	`string`
FormBuilderForm::listFields	`array`	Field names to show in entries list
FormBuilderForm::method	`string`
FormBuilderForm::mobilePx	`int`	Mobile responsive breakpoint.
FormBuilderForm::name	`string`
FormBuilderForm::nextText	`string`	Default “next” button text
FormBuilderForm::numEntries	`int`
FormBuilderForm::numFields	`int`
FormBuilderForm::partialEntryDays	`int`	Maximum days to allow an incomplete/partial entry to exist in the system (default=14)
FormBuilderForm::partialEntryType	`int`	Storage type to use for partial entries (0=session, 1=database)
FormBuilderForm::pluginActions	`array`
FormBuilderForm::processor() FormBuilderForm::processor() FormBuilderForm::processor($options = [])	`FormBuilderProcessor`	Get processor for this form
FormBuilderForm::removeFlag() FormBuilderForm::removeFlag($flag) FormBuilderForm::removeFlag($flag, string $property = 'flags')	(nothing)	Remove flag from form
FormBuilderForm::render() FormBuilderForm::render() FormBuilderForm::render()	`string`	Render this form's output and/or process if it has been posted.
FormBuilderForm::responderBody	`string`	Body of auto-responder
FormBuilderForm::responderFrom	`string`	Responder from address
FormBuilderForm::responderFromName	`string`	Responder from "name"
FormBuilderForm::responderReplyTo	`string`	Reply-to email address for auto-responder
FormBuilderForm::responderSubject	`string`	Subject of auto-responder
FormBuilderForm::responderTo	`string`	Field that will contain submitters email address (CSV string for multiple)
FormBuilderForm::roles	`array`
FormBuilderForm::save() FormBuilderForm::save() FormBuilderForm::save()	(nothing)	Save this form
FormBuilderForm::saveFlags	`int`	Bitwise flags for save actions (see FormBuilderProcessor::saveFlag* constants)
FormBuilderForm::savePageFields	`array`
FormBuilderForm::savePageParent	`int`
FormBuilderForm::savePageStatus	`int`
FormBuilderForm::savePageSubfields	`string`	Textarea with "form_field=page_field" or "form_field=page_field.subfield" one per line.
FormBuilderForm::savePageTemplate	`int`
FormBuilderForm::set() FormBuilderForm::set(string $key, mixed $value) FormBuilderForm::set(string $key, mixed $value)	`FormBuilderData` `FormBuilderField`	Set property value
FormBuilderForm::setFbRender() FormBuilderForm::setFbRender(FormBuilderRender $fbRender) FormBuilderForm::setFbRender(FormBuilderRender $fbRender)	(nothing)	Set the FormBuilderRender
FormBuilderForm::setName() FormBuilderForm::setName(string $name) FormBuilderForm::setName(string $name)	`FormBuilderData`	Set form name
FormBuilderForm::showNav	`int`	Use select nav above paginations? 0=off, 1=before headline, 2=after healdline, 3=after description
FormBuilderForm::skipSessionKey	`bool` `int`	Disable session tracking and CSRF protection?
FormBuilderForm::spamEntryDays	`int`	Maximum days a spam entry is allowed to be saved in the system
FormBuilderForm::spamFlags	`int` `null`	Spam flags (0=none, 2=silent, 4=verbose, 8=spam entry)
FormBuilderForm::spamWords	`array` `null`
FormBuilderForm::submitText	`string`	Default submit button text
FormBuilderForm::successMessage	`string`
FormBuilderForm::target	`string`
FormBuilderForm::theme	`string`
FormBuilderForm::turingTest	`string`
FormBuilderForm::type	`string`
FormBuilderForm::useCookies	`bool` `int`	Remember form values in cookies?

Additional methods and properties

In addition to the methods and properties above, FormBuilderForm also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.236

Located in file /site/modules/FormBuilder/FormBuilderForm.php

Common

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news