README

License: GNU GPL, Version 2

Repository: https://gitlab.sgalinski.de/typo3/sg_forms

Please report bugs here: https://gitlab.sgalinski.de/typo3/sg_forms

About

This extension provides additional functionality for the forms extension

Setup

Setup custom forms storage

All you need to be able to store the form yaml files in our project theme is to create the following folder: web/typo3conf/ext/project_theme/Resources/Private/Forms**

Don't forget to include the Typoscript in your template!

Invisible Recaptcha

You need to integrate lib.settings.reCaptchaSiteKey and lib.settings.reCaptchaSecretKey in your page template, to get the invisible recaptcha working.

Important

You also have to include the JavaScript of the FormRequiringAction JavaScript module introduced in V5. Check how to use it in its documentation.

ALTCHA Proof of work

ALTCHA PoW is automatically added when checking the "Use ALTCHA" checkbox inside the form settings. The widget fetches challenges via challengeurl from an uncached ajax endpoint, so cached form markup does not reuse expired challenge payloads.

ALTCHA Spam Filter

ALTCHA is automatically added if you have API key. You need to add API Key and API Url in your page template, to get the ALTCHA Spam Filter working. API Key and url can be set in

PDF Finisher

The PdfFinisher can fill an existing PDF form with submitted form values and optionally attach it to admin/user mails. Filling PDF forms requires mikehaertl/php-pdftk and a working pdftk binary on the server.

For local DDEV environments, make sure pdftk is installed in the web container via .ddev/config.yaml:

webimage_extra_packages: [ build-essential, python3, pdftk]

In the form editor:

1. Add the Fill PDF with form values finisher.
2. Select a PDF template file (sys_file with AcroForm fields).
3. Click Load PDF fields to import all PDF field names into the mapping table.
4. Map each imported PDF field to a TYPO3 form field identifier (Text, Textarea, Email, Checkbox, LinkedCheckbox, RadioButton, SingleSelect, MultiSelect, CountrySelect) or to a virtual value (CURRENT_DATE, CURRENT_TIME, CURRENT_DATETIME, CURRENT_TIMESTAMP).
5. Optionally enable Start generated PDF download on confirmation page (one-time, deletes file after first access) to automatically trigger the PDF download after submit.
6. Flatten generated PDF (make it non-editable) is enabled by default. Disable it if you want to keep output fields editable/highlighted.

For checkbox/radio/select mappings, the PDF field name and PDF export value definitions must match the TYPO3 values you submit (for example the selected radio option value). The editor currently does not enforce type compatibility, so integrators/editors need to ensure the mapping is semantically correct.

Generated PDFs are stored in fileadmin/sg_forms/Temp/PdfAttachments. The frontend download link uses a temporary token (default TTL: 1 hour) and is consumed on first valid access. On this first access, the generated PDF is streamed and then deleted. Integrators should still schedule cleanup for this directory, because generated PDFs can remain there when no frontend download is rendered/clicked, for example when PDFs are only attached to emails. The existing cleanup command can be used for this:

vendor/bin/typo3 sgforms:deleteOldUploads /fileadmin/sg_forms/Temp/PdfAttachments 1

Adjust the maximum age to the project's retention requirements.

Extension Configuration

Toggle Translation Grouping

By default, the backend module groups translated form definitions under their parent form. If you want to disable this behavior and see all form definitions as separate entries (e.g., in multi-site setups with separate language handling), you can toggle this behavior in the extension configuration of sg_forms in the TYPO3 Backend.

The setting groupTranslations can be found in the extension configuration under the "general" category.