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.

Show class?             Show args?        

Common

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

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH