README

Form log for TYPO3

Installation

1. Via Composer:

   composer require pagemachine/typo3-formlog

   From the TYPO3 Extension Repository

2. Add the Site Set pagemachine/formlog as dependency to your site configuration:

   dependencies:
     - pagemachine/formlog

   Alternatively add the "Form Log" static TypoScript template or import the TypoScript setup:

   @import 'EXT:formlog/Configuration/TypoScript/setup.typoscript'
   

Purpose

One feature absent in the TYPO3 form extension is logging of form data. If you have ever used the now defunct Formhandler extension you know how valuable this can be. You can easily check if form submissions are working as they should, see internal values are generated correctly and perform some basic analysis thanks to exports to CSV or similar.

See our blog post about the TYPO3 form log extension.

Start logging

Logging can be enabled for any form by adding the LogFormData finisher to its form definition:

finishers:
  - ...

  - identifier: LogFormData

  - identifier: Redirect

The LogFormData finisher should be the last finisher or right before the Redirect finisher if used. Logging after a redirect is not possible.

Additional variables stored in the FinisherVariableProvider can also be logged by using the finisherVariables option:

  - identifier: LogFormData
    options:
      finisherVariables:
        MyCustomFinisher:
          - myCustomVariable

The keys within finisherVariables are identifiers of finishers used in a form, the value of each entry is a list of finisher variable names. In the example here the finisher variable myCustomVariable provided by the finisher MyCustomFinisher will be logged.

Form log module

By default the form log module displays a few basic fields like page, form identifier, language and date of form submission as columns.

Additional columns can be added with the list.columns setting in TypoScript loaded via ext_localconf.php:

ExtensionManagementUtility::addTypoScriptSetup(<<<TYPOSCRIPT
module.tx_formlog {
  settings {
    list {
      columns {
        100 {
          property = data.email
          label = LLL:EXT:my_site/Resources/Private/Language/Extensions/Form/locallang.xlf:element.email.properties.label
        }
      }
    }
  }
}
TYPOSCRIPT);

Within list.columns an arbitrary list of columns can be added where the property option refers to a property path in the FormLogEntry domain model. Simply speaking data.* provides access to form data by a form element identifier, e.g. data.email for the value of the form element email. The label option is used to retrieve a translatable label. Usually one can simply use the same label that is used for the field within the form itself.

Similarly finisherVariables.* does the same for additional finisher variables by utilizing the finisher identifier and variable name:

ExtensionManagementUtility::addTypoScriptSetup(<<<TYPOSCRIPT
module.tx_formlog {
  settings {
    list {
      columns {
        200 {
          property = finisherVariables.MyCustomFinisher.myCustomVariable
          label = LLL:EXT:my_site/Resources/Private/Language/Extensions/Formlog/locallang.xlf:formlog.entry.finisherVariables.MyCustomFinisher.myCustomVariable
        }
      }
    }
  }
}
TYPOSCRIPT);

Here myCustomVariable of MyCustomFinisher is added as column to the list.

Form log export

Out of the box form log entries can be exported to CSV and Excel (XLSX). Basic fields of form log entries are exported by default, additional columns can be added with the export.columns setting in TypoScript loaded via ext_localconf.php which is configured exactly the same as the list.columns setting:

ExtensionManagementUtility::addTypoScriptSetup(<<<TYPOSCRIPT
module.tx_formlog {
  settings {
    export {
      columns {
        100 {
          property = data.firstname
          label = LLL:EXT:my_site/Resources/Private/Language/Extensions/Form/locallang.xlf:element.firstname.properties.label
        }
        101 {
          property = data.lastname
          label = LLL:EXT:my_site/Resources/Private/Language/Extensions/Form/locallang.xlf:element.lastname.properties.label
        }
        102 {
          property = data.email
          label = LLL:EXT:my_site/Resources/Private/Language/Extensions/Form/locallang.xlf:element.email.properties.label
        }
        200 {
          property = finisherVariables.MyCustomFinisher.myCustomVariable
          label = LLL:EXT:my_site/Resources/Private/Language/Extensions/Formlog/locallang.xlf:formlog.entry.finisherVariables.MyCustomFinisher.myCustomVariable
        }
      }
    }
  }
}
TYPOSCRIPT);

Log entry cleanup

The Table garbage collection Scheduler task can be set up to automatically delete old form log entries. Select tx_formlog_entries as Table to clean up and a suitable value for Delete entries older than given number of days, 180 by default.

Testing

All tests can be executed with the shipped Docker Compose definition:

docker compose run --rm app composer build

Thanks

Development of this package was proudly sponsored by TÜV Hessen.