$forms->addNew() $forms->addNew(string $formName) $forms->addNew(string $formName) | FormBuilderForm | Add a new form with the given name | |
| $forms->akismetKey | string | | |
$forms->count() $forms->count() $forms->count() | int | Return number of forms here, per Countable interface | |
$forms->countEntries() $forms->countEntries($id) $forms->countEntries($id) | int | Return the number of entries for the given form ID | |
| $forms->csvDelimiter | string | Delimeter to use for CSV files | |
| $forms->csvUseBOM | bool | Include a UTF-8 BOM at the beginning of CSV files? | |
$forms->delete() $forms->delete(FormBuilderForm $form) $forms->delete(FormBuilderForm $form) | bool | Delete the given $form | |
$forms->embed() $forms->embed($formName) $forms->embed($formName, array $vars = null) | string | Get the embed code for a given form | |
| $forms->embedCode | string | | |
| $forms->embedFields | array | Fields allowed for easy-embed | |
| $forms->embedTag | string | Easy embed tag | |
$forms->entryToForm() $forms->entryToForm($entry) $forms->entryToForm($entry) | bool FormBuilderForm | Given an entry array or ID return the FormBuilderForm object that it belongs to | |
$forms->exportJSON() $forms->exportJSON($form) $forms->exportJSON($form) | string | Return the JSON schema for the given form ID | |
| $forms->filesPath | string | Path for file attachments | |
$forms->findEntries() $forms->findEntries(string $keywords) $forms->findEntries(string $keywords, string $operator = '*=', $form = 0) | array | Find form entries across all forms (or on specific form if specified) | |
$forms->finished() $forms->finished() $forms->finished() | (nothing) | Called when request has finished | |
$forms->form() $forms->form($form) $forms->form($form, bool $throw = true) | FormBuilderForm | Convert given value to FormBuilderForm if it isn’t already | |
$forms->formID() $forms->formID($formID) $forms->formID($formID, bool $throw = true) | int | Convert given value to form ID if is isn’t already | |
$forms->formLog() $forms->formLog($form, string $str) $forms->formLog($form, string $str) | WireLog | Record a log entry for FormBuilder | |
$forms->formName() $forms->formName($formName) $forms->formName($formName, bool $throw = true) | int | Convert given value to form name if is isn’t already | |
$forms->forms() $forms->forms() $forms->forms() | FormBuilderMain | Placeholder function for FormBuilderMain variable to ensure it's only instantiated when needed | |
$forms->frameworksPath() $forms->frameworksPath() $forms->frameworksPath() | string | Return the path where frameworks are stored | |
$forms->frameworksURL() $forms->frameworksURL() $forms->frameworksURL() | string | Return the URL where frameworks are stored | |
| $forms->fromEmail | string | Default from email for sent emails | |
$forms->get() $forms->get(string $key) $forms->get(string $key) | mixed | Retrieve a config variable or a form, depending on the key | |
$forms->getEmbedVersion() $forms->getEmbedVersion() $forms->getEmbedVersion($v = '') | string | Returns a form embed key for matching request to response | |
$forms->getEntry() $forms->getEntry(int $entryID) $forms->getEntry(int $entryID, $form = 0) | array bool | Get a form entry by ID | |
$forms->getFileFromKey() $forms->getFileFromKey(string $key) $forms->getFileFromKey(string $key) | bool string | Retrieve a filename from a transportable key | |
$forms->getFileKey() $forms->getFileKey($formID, int $entryID, string $filename) $forms->getFileKey($formID, int $entryID, string $filename) | bool string | Generate a transportable key for the given filename within a form and entry | |
$forms->getFileURL() $forms->getFileURL($formID, int $entryID, string $filename) $forms->getFileURL($formID, int $entryID, string $filename) | bool string | Return a URL where the given file can be viewed | |
$forms->getFilesPath() $forms->getFilesPath() $forms->getFilesPath(bool $tmp = false, bool $create = true) | string | Return path that FormBuilder uses for storing files | |
$forms->getFormName() $forms->getFormName($id) $forms->getFormName($id) | string | Get the name of a form | |
$forms->getFormNames() $forms->getFormNames() $forms->getFormNames(int $id = 0) | array string | Get names of all forms (indexed by form ID) | |
$forms->getFramework() $forms->getFramework(FormBuilderForm $form) $forms->getFramework(FormBuilderForm $form) | FormBuilderFramework null | Get the framework used by the given $form | |
$forms->getFromURL() $forms->getFromURL() $forms->getFromURL(bool $render = false) | FormBuilderForm FormBuilderRender string | Load form from URL (for embed method a or b) | |
$forms->getHelpers() $forms->getHelpers(string $for) $forms->getHelpers(string $for, bool $getDirs = true) | array | Retrieve all themes or frameworks files | |
$forms->getIterator() $forms->getIterator() $forms->getIterator() | ArrayObject | Make this module iterable, as required by the IteratorAggregate interface | |
$forms->getTemplateVersion() $forms->getTemplateVersion() $forms->getTemplateVersion() | int | Get the template version set from form-builder.php | |
$forms->hasPermission() $forms->hasPermission(string $name, $form) $forms->hasPermission(string $name, $form) | bool | Check if the current user has the permission name for the given $form | |
$forms->helperPath() $forms->helperPath(string $for) $forms->helperPath(string $for, string $item = '') | string | Get path for 'themes' or 'frameworks' helpers | |
$forms->importJSON() $forms->importJSON($form, string $json) $forms->importJSON($form, string $json) | bool | Import to form ID the given JSON schema | |
| $forms->inputfieldClasses | array | Inputfield classes allowed for form fields | |
$forms->installer() $forms->installer() $forms->installer() | FormBuilderInstall | @return FormBuilderInstall | |
$forms->isForm() $forms->isForm($id) $forms->isForm($id) | bool | Given a form ID or name, returns true if is used by a form, false if not | |
$forms->isReservedName() $forms->isReservedName(string $name) $forms->isReservedName(string $name) | bool | Returns whether or not the given $name may be used or a form or field name | |
$forms->isValidLicense() $forms->isValidLicense() $forms->isValidLicense($k = '') | (nothing) | | |
| $forms->lastMaint | int | Timestamp of the last time maintenance was performed | |
| $forms->licenseKey | string | | |
$forms->load() $forms->load($id) $forms->load($id) | FormBuilderForm array null | Retrieve a form by $id, $name or specify boolean true to return all forms | |
$forms->loadAll() $forms->loadAll() $forms->loadAll() | array | Load all forms | |
$forms->loadHooksFile() $forms->loadHooksFile() $forms->loadHooksFile() | (nothing) | Load the optional /site/templates/form-builder.inc hooks file | |
| $forms->mailer | string | WireMail mailer to use for sending email, 'WireMail' to force native PHP mail(), or blank for auto-detect. | |
$forms->maintenance() $forms->maintenance() $forms->maintenance($form = null) | Number | Perform form maintenance on all forms (or a specific form, if given) | |
$forms->render() $forms->render($form) $forms->render($form, $vars = []) | FormBuilderRender | Render a form directly (embed method C) | |
$forms->save() $forms->save(FormBuilderForm $form) $forms->save(FormBuilderForm $form) | bool | Save the given $form | |
$forms->saveEntry() $forms->saveEntry(array $entry) $forms->saveEntry(array $entry, $form = 0) | bool int | Save a form entry | |
$forms->setTemplateVersion() $forms->setTemplateVersion(int $version) $forms->setTemplateVersion(int $version) | (nothing) | Set the form-builder.php template version, to be called from form-builder.php | |
$forms->themesPath() $forms->themesPath() $forms->themesPath(string $theme = '') | string | Return the path where themes are stored | |
$forms->themesURL() $forms->themesURL() $forms->themesURL(string $theme = '') | string | Return the URL where themes are stored | |
$forms->upgrade() $forms->upgrade($fromVersion, $toVersion) $forms->upgrade($fromVersion, $toVersion) | (nothing) | Upgrade the module | |
| $forms->useRoles | int bool | Enable access control? | |
$forms->viewFile() $forms->viewFile(string $key) $forms->viewFile(string $key) | (nothing) | Outputs the given file, must be located under getFilesPath() | |
$forms->wired() $forms->wired() $forms->wired() | (nothing) | Wired to API | |