silverstripe/userforms

UserForms enables CMS users to create dynamic forms via a drag and drop interface and without getting involved in any PHP code

6.3.0 2024-10-16 08:44 UTC

Requires

• php: ^8.1
• silverstripe/cms: ^5
• silverstripe/framework: ^5
• silverstripe/mimevalidator: ^3
• silverstripe/segment-field: ^3
• silverstripe/versioned: ^2
• symbiote/silverstripe-gridfieldextensions: ^4

Requires (Dev)

• phpstan/extension-installer: ^1.3
• phpunit/phpunit: ^9.6
• silverstripe/documentation-lint: ^1
• silverstripe/standards: ^1
• squizlabs/php_codesniffer: ^3

Suggests

• colymba/gridfield-bulk-editing-tools: Allows for bulk management of form submissions
• silverstripe/gridfieldqueuedexport: Export large submission as CSV through queued jobs in the background
• silverstripe/spamprotection: Adds support for spam protection to your user forms

Conflicts

• egulias/email-validator: ^2

BSD-3-Clause

• Will Rossiter
• Damian Mooyman
• David Craig
• Scott Hutchinson
• Christopher Pitt

• silverstripe
• userforms

README

UserForms enables CMS users to create dynamic forms via a drag and drop interface and without getting involved in any PHP code.

Features

• Construct a form using all major form fields (text, email, dropdown, radio, checkbox..)
• Ability to extend userforms from other modules to provide extra fields.
• Ability to email multiple people the form submission
• View submitted submissions and export them to CSV
• Define custom error messages and validation settings
• Optionally display and hide fields using javascript based on users input
• Displays a confirmation message when navigating away from a partially completed form.

Installation

composer require silverstripe/userforms

Spam protection

This module does not include spam protection out of the box. Without it, it's likely that your submissions could contain a considerable amount of spam. For public facing forms it is encouraged you review and install the following module plus one of the recommended 'verification system' modules outlined in the README.

Read the SpamProtection Module README for details on how to configure this module.

Documentation

• Index
• Installation instructions
• Troubleshooting
• User Documentation

Thanks

I would like to thank everyone who has contributed to the module, bugfixers, testers, clients who use the module and everyone that submits new features.

A big thanks goes out to Jan Düsedau for drawing the custom icon set for the form fields.

Versioning

This library follows Semver. According to Semver, you will be able to upgrade to any minor or patch version of this library without any breaking changes to the public API. Semver also requires that we clearly define the public API for this library.

All methods, with public visibility, are part of the public API. All other methods are not part of the public API. Where possible, we'll try to keep protected methods backwards-compatible in minor/patch versions, but if you're overriding methods then please test your work before upgrading.

Reporting Issues

Please create an issue for any bugs you've found, or features you're missing.