heimrichhannot / contao-submissions
A generic module to store and handle submissions in contao.
Installs: 8 396
Dependents: 3
Suggesters: 0
Security: 0
Stars: 1
Watchers: 4
Forks: 1
Open Issues: 1
Type:contao-module
Requires
- php: ^8.2
- contao/core-bundle: ^4.13 || ^5.0
- heimrichhannot/contao-utils-bundle: ^3.6
- terminal42/notification_center: ^2.0
Suggests
- heimrichhannot/contao-cleaner: This module adds cleaner functionality for periodically removing arbitrary entities fulfilling a certain condition (using TL_CRON or your server's cron).
- heimrichhannot/contao-exporter: Offers exporter functionality.
- heimrichhannot/contao-frontendedit: Offers full CRUD (create, read, update, delete) functionality which could be used for submissions.
- dev-master
- v2.x-dev
- v2.0.0-beta.3
- v2.0.0-beta.2
- v2.0.0-beta.1
- 1.24.1
- 1.24.0
- 1.23.6
- 1.23.5
- 1.23.4
- 1.23.3
- 1.23.2
- 1.23.1
- 1.23.0
- 1.22.0
- 1.21.4
- 1.21.3
- 1.21.2
- 1.21.1
- 1.21.0
- 1.20.4
- 1.20.3
- 1.20.2
- 1.20.1
- 1.20.0
- 1.19.1
- 1.19.0
- 1.18.1
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.1
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.2
- 1.6.1
- 1.6.0
- 1.5.8
- 1.5.7
- 1.5.6
- 1.5.5
- 1.5.4
- 1.5.3
- 1.5.2
- 1.5.1
- 1.5.0
- 1.4.9
- 1.4.8
- 1.4.7
- 1.4.6
- 1.4.5
- 1.4.4
- 1.4.3
- 1.4.2
- 1.4.1
- 1.4.0
- 1.3.13
- 1.3.12
- 1.3.11
- 1.3.10
- 1.3.9
- 1.3.8
- 1.3.7
- 1.3.6
- 1.3.5
- 1.3.4
- 1.3.3
- 1.3.2
- 1.3.1
- 1.3.0
- 1.2.5
- 1.2.4
- 1.2.3
- 1.2.2
- 1.2.1
- 1.2.0
- 1.1.3
- 1.1.2
- 1.1.1
- 1.1.0
- 1.0.45
- 1.0.44
- 1.0.43
- 1.0.42
- 1.0.41
- 1.0.40
- 1.0.39
- 1.0.38
- 1.0.37
- 1.0.36
- 1.0.35
- 1.0.34
- 1.0.33
- 1.0.32
- 1.0.31
- 1.0.30
- 1.0.29
- 1.0.28
- 1.0.27
- 1.0.26
- 1.0.25
- 1.0.24
- 1.0.23
- 1.0.22
- 1.0.21
- 1.0.20
- 1.0.19
- 1.0.18
- 1.0.17
- 1.0.16
- 1.0.15
- 1.0.14
- 1.0.13
- 1.0.12
- 1.0.11
- 1.0.10
- 1.0.9
- 1.0.0
- dev-feature/opt-in-event
- dev-feature/formgenerator
- dev-feature/replace_haste
This package is auto-updated.
Last update: 2024-12-02 13:56:30 UTC
README
A generic module to store and handle submissions in Contao. You can use it with all of your modules to simplify submission handling. Works great with heimrichhannot/frontendedit, heimrichhannot/formhybrid_list and heimrichhannot/formhybrid.
Features
- a new submissions entity (organized in archives)
- opportunity to specify a parent entity for each archive (e.g. an event)
- submissions are highly customizable by defining new fields in your dca (palette is created with no code at all)
- every archive can specify its own submission field list
- rich interfaces (e.g. SubmissionModel)
- handling for notification center messages (terminal42/contao-notification_center)
- easily export submissions as CSV and Excel file (using heimrichhannot/contao-exporter)
- optional cleaner support for periodically removing unpublished (aka inactive) submissions (using TL_CRON or your server's cron, using heimrichhannot/contao-entity_cleaner)
- specify a member (frontend) or a user (backend) to be the author of the submission
- Form generator support including opt-in process (contao 4.7+ only)
Install
-
Install with composer or contao manager
composer require heimrichhannot/contao-submissions
-
Update database
Usage
You will find a new backend menu entry named "Submissions". Create a new archive with a title and select the fields, your submissions should contain.
Form generator
You can store your form generator submissions directly as submission. Just active "store as submission" and select the submission archive. Form field names must be the same as the fields names of the submission entity.
For submitted files form_attachment_*-Notification-Center-Tokens are generated.
If you on contao 4.7 or higher, you can also set up an double opt-in process for your submission. Create an opt-in notification in notification center and select it in the form configuration. You can also choose a jump to page to which the user is redirected when the opt-in-url is called and the opt-in was successful. If you want to check a property on successful opt-ins, you can set the confirmation field property (e.g. set the publish field to true).
You can use following notification tokens in the opt-in-notification:
Formhybrid
To use this bundle with formhybrid, we recommend to install Submissions Creator.
Further information
Fields
tl_submission:
Add custom fields
After adding new fields, run
\HeimrichHannot\Submissions\Backend\SubmissionBackend::addFieldsToPalette();
in your dca in order to add the new fields to the default palette.
tl_submission_archive
Developers
Events
These events are implemented as symfony events and only usable in contao 4+.