From 90b615c5b214bbbbf280bbfab193b6a1c1357cb9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Julien=20Fastr=C3=A9?= <julien.fastre@champs-libres.coop>
Date: Fri, 14 Jun 2024 13:58:48 +0200
Subject: [PATCH] Add data transformation interface for filters

Introduced a new DataTransformerFilterInterface that allows transforming filter's form data before it is processed. Updated the FilterType file to add a view transformer if the filter implements this new interface. This new transformation process caters to transforming existing data in saved exports and replacing it with default values.
---
 .../Export/DataTransformerFilterInterface.php | 25 +++++++++++++++++++
 .../Export/FilterInterface.php                |  3 +++
 .../Form/Type/Export/FilterType.php           | 11 ++++++++
 3 files changed, 39 insertions(+)
 create mode 100644 src/Bundle/ChillMainBundle/Export/DataTransformerFilterInterface.php

diff --git a/src/Bundle/ChillMainBundle/Export/DataTransformerFilterInterface.php b/src/Bundle/ChillMainBundle/Export/DataTransformerFilterInterface.php
new file mode 100644
index 000000000..055ee2edc
--- /dev/null
+++ b/src/Bundle/ChillMainBundle/Export/DataTransformerFilterInterface.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\MainBundle\Export;
+
+/**
+ * Transform data from filter.
+ *
+ * This interface defines a method for transforming filter's form data before it is processed.
+ *
+ * You can implement this interface on @see{FilterInterface}, to allow to transform existing data in saved exports
+ * and replace it with some default values.
+ */
+interface DataTransformerFilterInterface
+{
+    public function transformData(?array $before): array;
+}
diff --git a/src/Bundle/ChillMainBundle/Export/FilterInterface.php b/src/Bundle/ChillMainBundle/Export/FilterInterface.php
index d02b9843e..7786a5e23 100644
--- a/src/Bundle/ChillMainBundle/Export/FilterInterface.php
+++ b/src/Bundle/ChillMainBundle/Export/FilterInterface.php
@@ -32,6 +32,9 @@ interface FilterInterface extends ModifierInterface
 
     /**
      * Get the default data, that can be use as "data" for the form.
+     *
+     * In case of adding new parameters to a filter, you can implement a @see{DataTransformerFilterInterface} to
+     * transforme the filters's data saved in an export to the desired state.
      */
     public function getFormDefaultData(): array;
 
diff --git a/src/Bundle/ChillMainBundle/Form/Type/Export/FilterType.php b/src/Bundle/ChillMainBundle/Form/Type/Export/FilterType.php
index 8491d8f6a..4e0976c12 100644
--- a/src/Bundle/ChillMainBundle/Form/Type/Export/FilterType.php
+++ b/src/Bundle/ChillMainBundle/Form/Type/Export/FilterType.php
@@ -11,8 +11,10 @@ declare(strict_types=1);
 
 namespace Chill\MainBundle\Form\Type\Export;
 
+use Chill\MainBundle\Export\DataTransformerFilterInterface;
 use Chill\MainBundle\Export\FilterInterface;
 use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\CallbackTransformer;
 use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
 use Symfony\Component\Form\Extension\Core\Type\FormType;
 use Symfony\Component\Form\FormBuilderInterface;
@@ -43,6 +45,15 @@ class FilterType extends AbstractType
         ]);
         $filter->buildForm($filterFormBuilder);
 
+        if ($filter instanceof DataTransformerFilterInterface) {
+            $filterFormBuilder->addViewTransformer(new CallbackTransformer(
+                fn (?array $data) => $data,
+                function (?array $data) use ($filter) {
+                    return $filter->transformData($data);
+                },
+            ));
+        }
+
         $builder->add($filterFormBuilder);
     }