implement input transformer (#369)

* implement input transformer
* translate funnel action label in backend view

Author: solverat

UPGRADE.md

@@ -1,5 +1,9 @@
 # Upgrade Notes
 
+## Version 4.2.1
+- **[ENHANCEMENT]**: Input Transformer [#7bde83b](https://github.com/dachcom-digital/pimcore-formbuilder/pull/369/commits/7bde83b015d242f2ce2f93fcd0b4feb78431587c)
+- **[BUGFIX]**: Translate Funnel Action Label in Backend [#b4966a2](https://github.com/dachcom-digital/pimcore-formbuilder/pull/369/commits/b4966a2f23c0aa55e1df214632984ff0164aa945)
+
 ## Version 4.2.0
 - **[NEW FEATURE]**: Funnel Feature [#362](https://github.com/dachcom-digital/pimcore-formbuilder/issues/362)
 - **[FEATURE]**: PIMCORE 10.5 Support only!

docs/40_CustomFormType.md

@@ -14,6 +14,12 @@ form_builder:
 
             # define the class
             class: Symfony\Component\Form\Extension\Core\Type\ChoiceType
+            
+            # If you need some custom transformers, uncomment these lines:
+            #
+            #output_transformer: my_custom_output_transformer
+            #input_transformer: my_custom_input_transformer
+            
             backend:
 
                 # you either use one of those fields 

docs/OutputWorkflow/09_ApiChannel.md

@@ -15,10 +15,10 @@ it's quite easy to integrate your own api provider, read more about it [here](./
 
 ## Available Options
 
-| Name | Type        | Description |
-|------|-------------|-------------|
-| Api Provider| `ApiProviderInterface` | Select your API Provider. |
-| Options | `mixed` | If available, various provider configuration fields |
+| Name         | Type                   | Description                                         |
+|--------------|------------------------|-----------------------------------------------------|
+| Api Provider | `ApiProviderInterface` | Select your API Provider.                           |
+| Options      | `mixed`                | If available, various provider configuration fields |
 
 ## Mapping
 ![image](https://user-images.githubusercontent.com/700119/145618709-686d5022-1ed9-4722-9600-0d41eccf55a3.png)

docs/OutputWorkflow/0_Usage.md

@@ -38,6 +38,7 @@ Want to learn more? Let's start with the [Email Channel](./10_EmailChannel.md).
   - [Email Channel](./10_EmailChannel.md)
   - [Object Channel](./11_ObjectChannel.md)
   - [Custom Channel](./12_CustomChannel.md)
+  - [Input Transformer](./14_InputTransformer.md)
   - [Output Transformer](./15_OutputTransformer.md)
   - [Success Management](./20_SuccessManagement.md)
   - [Events](./30_Events.md)

docs/OutputWorkflow/12_CustomChannel.md

@@ -4,18 +4,16 @@ To create a custom output workflow channel, you need to create some configuratio
 ## Service Definition
 
 ```yaml
-
 services:
     App\FormBuilder\MyChannel:
         tags:
             - { name: form_builder.output_workflow.channel, type: myChannel }
-
 ```
+
 ## Output Transformer
 Read [here](./15_OutputTransformer.md#custom-output-transformer) how to add a single output transformer to your new custom channel.
 
 ## PHP Configuration Form Type Class
-
 ```php
 <?php
 

docs/OutputWorkflow/14_InputTransformer.md

@@ -0,0 +1,81 @@
+# Input Transformer
+
+Input Transformers will be applied, before a form gets pre-populated with given data.
+
+Mostly this happens, if you're using a funnel output workflow.
+There, the form data gets normalized and needs to be transformed back, before we can populate a form with data.
+
+## Available Core Input Transformer
+
+| Available Transformer | Field                                  | Service                                                           |
+|-----------------------|----------------------------------------|-------------------------------------------------------------------|
+| `date_transformer`    | `date`, `datetime`, `time`, `birthday` | `@FormBuilderBundle\Transformer\Output\DateDataObjectTransformer` |
+
+> **Don't get confused!**   
+> Some core output transformers also supports input transformation.
+> Since we won't the namespace that because of BC reasons, we'll keep it that way (for now).  
+
+## Override default Input Transformer
+
+If you want to transform the text field value for example, you need to add your own transformer.
+First, let FormBuilder know about your transformer.
+
+> You're also able to set up your custom input transform for your dynamic fields via the `input_transformer` configuration node.
+
+ ```yaml
+form_builder:
+    types:
+        text:
+            input_transformer: text_input_transformer
+```
+
+Now you need to register your new transformer:
+
+```yaml
+    App\OutputTransformer\TextInputTransformer:
+        autowire: true
+        tags:
+            - { name: form_builder.transformer.input, type: text_input_transformer }
+```
+
+*** 
+
+After that, you have to set up a PHP-Service:
+
+```php
+<?php
+
+namespace App\InputTransformer;
+
+use FormBuilderBundle\Model\FieldDefinitionInterface;
+use FormBuilderBundle\Transformer\Input\InputTransformerInterface;
+
+class TextInputTransformer implements InputTransformerInterface
+{
+     public function getValueReverse(FieldDefinitionInterface $fieldDefinition, mixed $formValue): string
+    {
+        // manipulate or change the value
+        return $rawValue;
+    }
+}
+```
+
+***
+
+## Custom input transformer
+
+After you've created a [custom form type](./../40_CustomFormType.md) (and/or you need it in a funnel output chanel),
+you may want to control the input values too. Configure your PHP Service same as explained above.
+
+```yaml
+form_builder:
+    types:
+        your_custom_type:
+            input_transformer: custom_input_transformer
+
+services:
+    App\OutputTransformer\MyCustomInputTransformer:
+        autowire: true
+        tags:
+            - { name: form_builder.transformer.input, type: custom_input_transformer }
+```

docs/OutputWorkflow/15_OutputTransformer.md

@@ -16,7 +16,7 @@ If no transformer has been found, the `fallback_transformer` will be used.
 If you want to transform the text field value for example, you need to add your own transformer.
 First, let FormBuilder know about your transformer. 
 
-> You're also able to set up your custom output transform for your dynamic fields via `output_transformer` in the optional option configuration node.
+> You're also able to set up your custom input transform for your dynamic fields via the `input_transformer` configuration node.
 
  ```yaml
 form_builder:
@@ -60,31 +60,19 @@ use FormBuilderBundle\Transformer\Output\OutputTransformerInterface;
 
 class TextInputTransformer implements OutputTransformerInterface
 {
-    /**
-     * @var Translator
-     */
-    protected $translator;
+    protected Translator $translator;
 
-    /**
-     * @param Translator $translator
-     */
     public function __construct(Translator $translator)
     {
         $this->translator = $translator;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public function getValue(FieldDefinitionInterface $field, FormInterface $formField, $rawValue, $locale)
     {
         // manipulate or change the value
         return $rawValue;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public function getLabel(FieldDefinitionInterface $field, FormInterface $formField, $rawValue, $locale)
     {
         // manipulate or change the label
@@ -99,10 +87,10 @@ class TextInputTransformer implements OutputTransformerInterface
 
 After you've created a [custom output channel](./12_CustomChannel.md), you may want to control the output values too.
 It is possible to use one transformer for all available fields, like we'll show you below.
-If you want to add a fallback to all the other fields in your channel, you need to add an additional tag with type `fallback_transformer`.
+If you want to add a fallback to all the other fields in your channel, you need to add a tag with type `fallback_transformer`.
+
+> **Note:** If you don't add any transformer, the `fallback_transformer` will be used again.  
 
-> **Note:** If you don't add any transformer, the `fallback_transformer` will be used again.
->
 ```yaml
 App\OutputTransformer\MyChannelOutputTransformer:
     autowire: true

docs/OutputWorkflow/40_Funnels.md

@@ -32,6 +32,7 @@ Below you'll find a brief walk through to get the idea behind this powerful feat
 - Every funnel layer receives the `SubmissionEvent` object, so you're able to process users data which has been collected via form builders root form
 - Every funnel layer will be submitted as a form. If a funnel layer provides some additional form data, it will be stored within the storage provider via `FunnelRuntimeData`
 - After the last channel has been called OR an exception raised, a `funnel_finished` flag will be added to the url. This indicates, that the workflow is done and the current storage will be flushed
+- If you're using some custom form fields, make sure you've also defined an [Input Transformer](./14_InputTransformer.md)!
 
 ***
 

src/FormBuilderBundle/Assembler/FormAssembler.php

@@ -41,9 +41,6 @@ public function assembleViewVars(FormOptionsResolver $optionsResolver): array
         $exceptionMessage = null;
         $formDefinition = null;
 
-        $formAssembleEvent = new FormAssembleEvent($optionsResolver);
-        $this->eventDispatcher->dispatch($formAssembleEvent, FormBuilderEvents::FORM_ASSEMBLE_PRE);
-
         $formId = $optionsResolver->getFormId();
 
         if ($formId !== null) {
@@ -73,6 +70,9 @@ public function assembleViewVars(FormOptionsResolver $optionsResolver): array
             return $viewVars;
         }
 
+        $formAssembleEvent = new FormAssembleEvent($optionsResolver, $formDefinition);
+        $this->eventDispatcher->dispatch($formAssembleEvent, FormBuilderEvents::FORM_ASSEMBLE_PRE);
+
         $systemRuntimeData = [
             'form_preset'             => $optionsResolver->getFormPreset(),
             'form_output_workflow'    => $optionsResolver->getOutputWorkflow(),
@@ -93,7 +93,7 @@ public function assembleViewVars(FormOptionsResolver $optionsResolver): array
 
         $form = $this->frontendFormBuilder->buildForm($formDefinition, $formRuntimeData, $formAssembleEvent->getFormData());
 
-        $formAssembleEvent = new FormAssembleEvent($optionsResolver, $form);
+        $formAssembleEvent = new FormAssembleEvent($optionsResolver, $formDefinition, $form);
         $this->eventDispatcher->dispatch($formAssembleEvent, FormBuilderEvents::FORM_ASSEMBLE_POST);
 
         $viewVars['form'] = $form->createView();

src/FormBuilderBundle/Controller/Admin/OutputWorkflowFunnelController.php

@@ -9,6 +9,7 @@
 use Pimcore\Bundle\AdminBundle\Controller\AdminController;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 use Symfony\Component\Serializer\SerializerInterface;
 
@@ -51,7 +52,18 @@ public function getFunnelLayersAction(Request $request): JsonResponse
                 'configuration' => [
                     'dynamicFunnelActionAware' => $service->dynamicFunnelActionAware(),
                     'funnelActionDefinitions'  => $this->serializer instanceof NormalizerInterface
-                        ? $this->serializer->normalize($funnelActionDefinitions, 'array', ['groups' => ['ExtJs']])
+                        ? $this->serializer->normalize(
+                            $funnelActionDefinitions,
+                            'array',
+                            [
+                                'groups'                      => ['ExtJs'],
+                                AbstractNormalizer::CALLBACKS => [
+                                    'label' => function ($data) {
+                                        return $this->trans($data, [], 'messages');
+                                    }
+                                ]
+                            ]
+                        )
                         : []
                 ]
             ];