Repository navigation
Configuration
Written against v0.1.0.
The add-on has one switch per feature, all in features of config/aether-form-settings.php. Each defaults to true except submission_data, so installing the add-on changes nothing until a form is configured. Publish the file with php artisan vendor:publish --tag=aether-form-settings-config.
| Key | Environment variable | Default | Effect when false
|
|---|---|---|---|
features.control_panel |
FORM_SETTINGS_CONTROL_PANEL |
true |
Statamic's own form settings screen returns: the added sections, the email grid's routing, conditions and sender name, and saving them go away. |
features.notifications |
FORM_SETTINGS_NOTIFICATIONS |
true |
Notifications send the way Statamic's own job sends them: no Active toggle, conditional notifications, recipient routing, sender name or email body view. |
features.confirmations |
FORM_SETTINGS_CONFIRMATIONS |
true |
Statamic's own response after a submission returns. |
features.restrictions |
FORM_SETTINGS_RESTRICTIONS |
true |
No submission is refused, and the form_restriction tag reports every form open. |
features.submission_data |
FORM_SETTINGS_SUBMISSION_DATA |
false |
Opt-in. Off, a submission is saved without the _* metadata (form, page, site, user agent, IP, referrer, time) and queued notification emails get no captured request context. On, both are added. |
// config/aether-form-settings.php
return [
'features' => [
'control_panel' => true,
'notifications' => true,
'confirmations' => true,
'restrictions' => false,
],
];With notifications on, the add-on points statamic.forms.send_email_job at its own job. A host that has set that option to a job of its own keeps it.
Four more keys, at the top level of the same file, adapt the add-on to a host.
| Key | Environment variable | Default | Effect |
|---|---|---|---|
confirmation_page_collections |
none | ['pages'] |
The collections the confirmation page pickers offer. An empty list falls back to pages. |
article_bard_extra_buttons |
none | [] |
Buttons added to the Article Bard field's toolbar after the heading buttons, for a button from another package such as bts_attributes. |
quiz_scoring |
FORM_SETTINGS_QUIZ_SCORING |
true |
Quiz and survey scoring. On, the quiz and survey tags render a submission's results, the Quiz Settings section appears and the notification email help lists those tags. Off, the tags render nothing and the section and help are absent; the quiz and likert_scale fieldtypes still render on public forms. A missing key counts as on. |
quiz_tags_in_user_content |
FORM_SETTINGS_QUIZ_TAGS_IN_USER_CONTENT |
true |
While quiz scoring is on, adds quiz, quiz:*, survey and survey:* to statamic.antlers.allowedContentTags after the host's entries, so the tags resolve in confirmation messages and notification emails. Off, the host's allowlist is left exactly as it is. |
Home | Getting started | Guides | Troubleshooting | Reference | README | Repository
Written against v0.1.0. Edit these pages in docs/wiki/ through a pull request; edits made in the wiki are overwritten by the next publish.
Getting started
Guides
Troubleshooting
Reference
Project