feat: remove legacy code and cleanup

Release 1.1.0

Author: peratoner-louis

.editorconfig

@@ -66,4 +66,4 @@ indent_size = 2
 
 # .htaccess
 [{_.htaccess,.htaccess}]
-indent_style = tab
+indent_style = tab

Classes/Hooks/FormRuntimeHooks.php

@@ -9,10 +9,6 @@
 
 namespace LIA\LiaForm\Hooks;
 
-use LIA\LiaForm\Services\TypoScriptReaderService;
-use TYPO3\CMS\Core\Site\Entity\Site;
-use TYPO3\CMS\Extbase\Mvc\RequestInterface;
-use TYPO3\CMS\Form\Domain\Model\FormElements\Page;
 use TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface;
 use TYPO3\CMS\Form\Domain\Runtime\FormRuntime;
 
@@ -21,67 +17,31 @@
  */
 class FormRuntimeHooks
 {
-    /**
-     * Hook the initializeCurrentPageFromRequest of the FormRuntime.
-     */
-    public function afterInitializeCurrentPage(FormRuntime $formRuntime, ?Page $currentPage, ?Page $lastDisplayedPage = null, ?array $arguments = []): ?Page
-    {
-        // if ajax is disabled for this extension the hook returns the given value.
-        if (!TypoScriptReaderService::isAjaxActive()) {
-            return $currentPage;
-        }
-
-        // Check if the form is submitted and if it was submitted by ajax.
-        if ($formRuntime->getFormState()->isFormSubmitted() && $this->comparePageType($formRuntime->getRequest())) {
-            // return null to invoke the finisher on ajax.
-            return null;
-        }
-
-        // check if currentPage is null and return lastDisplayedPage
-        if (!$currentPage instanceof Page && !$formRuntime->getFormState()->isFormSubmitted()) {
-            return $lastDisplayedPage;
-        }
-
-        // Return currentPage otherwise form will not work.
-        return $currentPage;
-    }
-
     /**
      * This hook is used to modify form values.
      */
     public function afterSubmit(FormRuntime $formRuntime, RenderableInterface $renderable, $elementValue, array $requestArguments = [])
     {
-        if ($renderable->getType() === 'PhoneAndAreaCode') {
-            $areaCode = $formRuntime->getRequest()->getParsedBody()['tx_form_formframework'][$renderable->getIdentifier() . '-areaCode'];
-            $elementValue = $areaCode . ' ' . $elementValue;
+        if ($renderable->getType() !== 'PhoneAndAreaCode') {
+            return $elementValue;
         }
 
-        return $elementValue;
-    }
-
-    /**
-     * Compare pageType integer from request and configuration.
-     */
-    private function comparePageType(RequestInterface $request): bool
-    {
-        $routing = $request->getAttribute('routing');
-        $site = $request->getAttribute('site');
+        $parsedBody = $formRuntime->getRequest()->getParsedBody();
+        $areaCodeIdentifier = $renderable->getIdentifier() . '-areaCode';
 
-        return (int)$routing->getPageType() === $this->getPageTypeFromConfiguration($site);
-    }
+        // Validate and sanitize area code input to prevent injection attacks
+        $rawAreaCode = '';
+        if (is_array($parsedBody) && isset($parsedBody['tx_form_formframework'][$areaCodeIdentifier])) {
+            $rawAreaCode = $parsedBody['tx_form_formframework'][$areaCodeIdentifier];
+        }
 
-    /**
-     * Extract the page type for get-content/ from site configuration.
-     */
-    private function getPageTypeFromConfiguration(Site $site): int
-    {
-        $fallback = TypoScriptReaderService::getContentPageTypeFallback();
-        $pageType = $site->getConfiguration()['routeEnhancers']['PageTypeSuffix']['map']['get-content/'];
+        // Limit length to prevent abuse
+        $areaCode = substr(preg_replace('/[^0-9+\-() ]/', '', (string)$rawAreaCode), 0, 20);
 
-        if (empty($pageType)) {
-            return $fallback ?? 0;
+        if ($areaCode === '') {
+            return $elementValue;
         }
 
-        return $pageType;
+        return $areaCode . ' ' . $elementValue;
     }
 }

Classes/Services/TypoScriptReaderService.php

@@ -1,17 +1,18 @@
 :navigation-title: Configuration
+
 ..  _configuration:
 
 =============
 Configuration
 =============
 
-.. attention::
+..  attention::
     First load the typoscript of this extension in your static template.
 
 This extension provides also an :ref:`example configuration <exampleConfig>`.
 
 
-.. contents::
+..  contents::
     :local:
     :depth: 1
 
@@ -23,7 +24,7 @@ To override the default typoscript and yaml configuration create a `Setup.typosc
 Now copy this snippet in this file and adjust the path to your `CustomFormSetup.yaml` if you already have on otherwise create it in the set path and adjust the
 extension name in this path.
 
-.. code-block:: typoscript
+..  code-block:: typoscript
     :caption: EXT:my_extension/Configuration/TypoScript/Extensions/LiaForm
 
     @import 'EXT:form/Configuration/TypoScript/'
@@ -71,8 +72,9 @@ Yaml Configuration
 If you do not have a `CustomFormSetup.yaml` then create it in the path of the settings and past the following snippet.
 Here you have to adjust the path to your extension.
 
-.. code-block:: yaml
+..  code-block:: yaml
     :caption: EXT:my_extension/Configuration/Yaml/CustomFormSetup.yaml
+
     imports:
       - { resource: "./Form/Elements.yaml" }
 

Classes/XClass/FormRuntime.php

@@ -1,4 +1,4 @@
-.. _exampleConfig:
+..  _exampleConfig:
 
 =====================
 Example configuration
@@ -32,7 +32,7 @@ in the same directory where you pasted the CustomFormSetup.yaml in.
 
 If you do not need them you can delete this part of code out this file.
 
-.. code-block:: yaml
+..  code-block:: yaml
     :caption: Prototype registration
 
     formManager:

Documentation/Configuration/Configuration.rst

@@ -1,4 +1,4 @@
-.. _EventListener
+..  _EventListener:
 
 =============
 EventListener
@@ -7,7 +7,7 @@ EventListener
 This extension listen to some events to modify the core functionality.
 Here you see a list of EventListeners that are subscribed by this extension.
 
-.. contents::
+..  contents::
     :local:
     :depth: 1
 
@@ -18,8 +18,8 @@ AfterFlexFormDataStructureParsedEvent
 This event extends the default FlexForm of the core with a custom css field.
 Here you can set a custom css class on the current form. Please register your
 EventListener if you have also extend this FlexForm. This Subscriber
-is registered by the `lia-form/flex-form-extension`. You can aline your EventListener
-after this event by adding the following tag `after: 'lia-form/flex-form-extension'` 
+is registered by the `lia-form/flex-form-extension`. You can align your EventListener
+after this event by adding the following tag `after: 'lia-form/flex-form-extension'`
 
 
 

Documentation/Configuration/ExampleConfig.rst

@@ -1,4 +1,4 @@
-.. _allInOneEventListenerClass:
+..  _allInOneEventListenerClass:
 
 ==============================
 All in one EventListener Class
@@ -7,13 +7,13 @@ All in one EventListener Class
 You can also listen to all events in one class. Here you have to use your own functions.
 In this example you see a class containing all Events at once.
 
-.. code-block:: php
-    :caption: EXT:my_extension/Classes/EventListeners/LiaFormEventListeners.php
+..  code-block:: php
+    :caption: EXT:my_extension/Classes/EventListener/LiaFormEventListeners.php
 
     <?php
     declare(strict_types=1);
 
-    namespace MY\MyExtension\EventListener\Finisher;
+    namespace MY\MyExtension\EventListener;
 
     use LIA\LiaForm\Event\ApplyCustomSettingsToViewEvent;
     use LIA\LiaForm\Event\BeforeFormDefinitionCreatesEvent;
@@ -29,9 +29,20 @@ In this example you see a class containing all Events at once.
         */
         public function finisherSetDefaultValueEventListener(SetDefaultValueEvent $event): void
         {
-            // do some crazy stuff ...
+            $formRuntime = $event->getFormRuntime();
+            $formState = $formRuntime->getFormState();
+            if ($formState === null) {
+                return;
+            }
 
-            $event->setFormRuntime($formRuntime);
+            // The FormState is shared by all finishers of this submission, so this
+            // default applies to every mail and cannot be scoped to one of them.
+            // Compare against null and '' explicitly: empty() would also match a
+            // legitimately submitted '0'.
+            $salutation = $formRuntime->getElementValue('salutation');
+            if ($salutation === null || $salutation === '') {
+                $formState->setFormValue('salutation', 'Sir or Madam');
+            }
         }
 
         /**
@@ -42,9 +53,9 @@ In this example you see a class containing all Events at once.
         */
         public function applyCustomSettingsToViewEventListener(ApplyCustomSettingsToViewEvent $event): void
         {
-            // do some crazy stuff ...
-
-            $event->setEmailView($emailView);
+            // The view is an object, so assigning to it is enough. Call
+            // setEmailView() only to swap in a different FluidEmail instance.
+            $event->getEmailView()->assign('myCustomVariable', 'someValue');
         }
 
         /**
@@ -55,18 +66,22 @@ In this example you see a class containing all Events at once.
         */
         public function beforeFormDefinitionCreatesEventListener(BeforeFormDefinitionCreatesEvent $event): void
         {
-            // do some crazy stuff ...
+            $formConfiguration = $event->getFormDefinitionConfigArray();
+
+            $formConfiguration['renderingOptions']['submitButtonLabel'] = 'Send';
 
-            $event->setFormDefinitionConfigArray($formconfiguration);
+            // The configuration is an array, so it is copied on read: the setter
+            // is what makes the change take effect.
+            $event->setFormDefinitionConfigArray($formConfiguration);
         }
     }
 
 Your event registration would look like this.
 
-.. code-block:: yaml
+..  code-block:: yaml
     :caption: EXT:my_extension/Configuration/Services.yaml
 
-    MY\MyExtension\EventListener\Finisher\SetDefaultValueEventListener:
+    MY\MyExtension\EventListener\LiaFormEventListeners:
       tags:
         - name: event.listener
           identifier: 'my-extension/finisher-set-default-values-event'