FormIt

Last updated Oct 27th, 2020 | Page history | Improve this page | Report an issue

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.

Backers

Budget

$301 per month—let's make that $500!

Learn more

What is FormIt?¶

FormIt is a dynamic form processing Snippet for MODX Revolution. It handles a form after submission, performing validation and followup actions like sending an email. It does not generate the form, but it can repopulate it if it fails validation.

History¶

FormIt was written by Shaun McCormick as a form processing Extra, and first released on October 19th, 2009. It is currently maintained by the team at Sterc.

Download¶

It can be downloaded from within the MODX Revolution manager via Package Management, or from the MODX Extras Repository, here: https://modx.com/extras/package/formit

Development and Bug Reporting¶

FormIt is stored and developed in GitHub, and can be found here: https://github.com/Sterc/FormIt

Bugs can be filed here: https://github.com/Sterc/FormIt/issues

API Documentation can also be found here: http://api.modx.com/formit/

Important changes¶

FormIt 3.0 introduces an update to the encryption methods used for encrypting form submissions. Prior to 3.0 mcrypt was used, which in 3.0 is replaced with openssl, due to mcrypt being deprecated as of PHP 7.2. FormIt 3.0 comes with a migration page which is accessible from the manager.

As of FormIt 2.2.9, all fields will automatically have html_entities applied. To allow HTML tags to be saved/stored, you will need to use the allowSpecialChars validator on each field, that should save raw html tags.

As of FormIt 1.1.4, all fields will automatically have stripTags applied. To allow HTML tags to be saved/stored, you will need to use the allowTags validator on each field, stipulating which tags are permitted.

How to Use¶

Simply place the FormIt snippet call into the Resource that contains the form you want to use. Unlike similar predecessors (most notably eForm in MODX Evolution), you do not put the form into a Chunk and reference the Chunk in the FormIt snippet call: you literally put the snippet call along side the form you want it to process. Specify the "hooks" (or post-validation processing scripts) in the snippet call. Then add validation via the &validate and &customValidators parameters in the snippet tag.

If you have multiple forms on a page, set the &submitVar property on your Snippet call to a name of a form element within the form (ie, &submitVar=`form1-submit` ). This tells FormIt to only process form requests with that POST variable. Multiple forms should be used with INPUT type="submit" name="form1-submit", button elements have been reported not working.

Available Properties¶

These are the available general properties for the FormIt call (not including hook-specific properties):

Name	Description	Default Value
preHooks	What scripts to fire, if any, once the form loads. This can be a comma-separated list of hooks, and if the first fails, the proceeding ones will not fire. A hook can also be a Snippet name that will execute that Snippet.
renderHooks	What scripts to fire, if any, once the form loads, preHooks are finished and all fields & errors has been set. This can be a comma-separated list of hooks used for manipulating all the fields of the form before everything is set based on given data from other packages or preHooks. A hook can also be a Snippet name that will execute that Snippet.
hooks	What scripts to fire, if any, after the form passes validation. This can be a comma-separated list of hooks, and if the first fails, the proceeding ones will not fire. A hook can also be a Snippet name that will execute that Snippet.
submitVar	If set, will not begin form processing if this POST variable is not passed. Notice: Needed if you use `&store` property (+ set submit var in input="submit"!).
validate	A comma-separated list of fields to validate, with each field name as name:validator (eg: `username:required,email:required`). Validators can also be chained, like `email:email:required`. This property can be specified on multiple lines.
validationErrorMessage	A general error message to set to a placeholder `[[!+fi.validation_error_message]]` if validation fails. Can contain `[[+errors]]` if you want to display a list of all errors at the top.	A form validation error occurred. Please check the values you have entered.
validationErrorBulkTpl	HTML tpl that is used for each individual error in the generic validation error message value.	`[[+error]]`
errTpl	The wrapper html for error messages. Note: not a chunk, just straight HTML.	`[[+error]]`
customValidators	A comma-separated list of custom validator names (snippets) you plan to use in this form. They must be explicitly stated here, or they will not be run.
clearFieldsOnSuccess	If true, will clear the fields on a successful form submission that does not redirect.	1
store	If true, will store the data in the cache for retrieval using the FormItRetriever snippet.	0
storeTime	If 'store' is set to true, this specifies the number of seconds to store the data from the form submission. Defaults to five minutes.	300
storeLocation	When using store, this defines where the form is stored after submit. Possible options are 'cache' and 'session'. Defaults to 'cache'.	cache
placeholderPrefix	The prefix to use for all placeholders set by FormIt for fields. Make sure to include the '.' separator in your prefix.	fi.
successMessage	If not using the redirect hook, display this success message after a successful submission.
successMessagePlaceholder	The name of the placeholder to set the success message to.	fi.successMessage
redirectTo	page ID of a "Thank You" page, where the visitor can be sent after successfully submitting the form, but this parameter is read ONLY if you include "redirect" in the list of &hooks.
allowFiles	Specify if files are allowed to be posted. Submitted files are stored in a temporary directory to prevent files getting lost in multistep forms.	true
attachFilesToEmail	Attaches uploaded files in email, form needs to be set as enctype="multipart/form-data"	true

Validation¶

Validation in FormIt is done via the &validate property, and can be used to automatically handle validation on any of the fields in your form.

For more information on validation in FormIt, see the Validators page.

Hooks¶

Hooks are basically scripts that run during FormIt processing. The hooks always execute in the order they appear in the property. If, for example, you have an email hook followed by a validation hook, the email will be sent before the validation occurs.

If any hook fails, the ones following it will not execute.

For more information on hooks, see the Hooks page.