Feature: [export][course] filter course by step, between two dates

.changes/unreleased/Feature-20230614-233107.yaml

@@ -0,0 +1,5 @@
+kind: Feature
+body: '[export] add a filter on accompanying period: filter by step between two dates'
+time: 2023-06-14T23:31:07.979389911+02:00
+custom:
+  Issue: "113"

src/Bundle/ChillPersonBundle/Export/Filter/AccompanyingCourseFilters/StepFilterBetweenDates.php

@@ -0,0 +1,125 @@
+<?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\PersonBundle\Export\Filter\AccompanyingCourseFilters;
+
+use Chill\MainBundle\Export\FilterInterface;
+use Chill\MainBundle\Form\Type\PickRollingDateType;
+use Chill\MainBundle\Service\RollingDate\RollingDate;
+use Chill\MainBundle\Service\RollingDate\RollingDateConverterInterface;
+use Chill\PersonBundle\Entity\AccompanyingPeriod;
+use Chill\PersonBundle\Export\Declarations;
+use Doctrine\ORM\QueryBuilder;
+use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
+use function in_array;
+
+class StepFilterBetweenDates implements FilterInterface
+{
+    private const DEFAULT_CHOICE = [
+        AccompanyingPeriod::STEP_CONFIRMED,
+        AccompanyingPeriod::STEP_CONFIRMED_INACTIVE_SHORT,
+        AccompanyingPeriod::STEP_CONFIRMED_INACTIVE_LONG,
+    ];
+
+    private const STEPS = [
+        'course.draft' => AccompanyingPeriod::STEP_DRAFT,
+        'course.confirmed' => AccompanyingPeriod::STEP_CONFIRMED,
+        'course.closed' => AccompanyingPeriod::STEP_CLOSED,
+        'course.inactive_short' => AccompanyingPeriod::STEP_CONFIRMED_INACTIVE_SHORT,
+        'course.inactive_long' => AccompanyingPeriod::STEP_CONFIRMED_INACTIVE_LONG,
+    ];
+
+    private RollingDateConverterInterface $rollingDateConverter;
+
+    private TranslatorInterface $translator;
+
+    public function __construct(
+        RollingDateConverterInterface $rollingDateConverter,
+        TranslatorInterface $translator
+    ) {
+        $this->rollingDateConverter = $rollingDateConverter;
+        $this->translator = $translator;
+    }
+
+    public function addRole(): ?string
+    {
+        return null;
+    }
+
+    public function alterQuery(QueryBuilder $qb, $data)
+    {
+        $alias = 'acp_filter_by_step_between_dat_alias';
+        $steps = 'acp_filter_by_step_between_dat_steps';
+        $from = 'acp_filter_by_step_between_dat_from';
+        $to = 'acp_filter_by_step_between_dat_to';
+
+        $qb
+            ->andWhere(
+                $qb->expr()->exists(
+                    "SELECT 1 FROM " . AccompanyingPeriod\AccompanyingPeriodStepHistory::class . " {$alias} " .
+                    "WHERE {$alias}.step IN (:{$steps}) AND OVERLAPSI ({$alias}.startDate, {$alias}.endDate),(:{$from}, :{$to}) = TRUE " .
+                    "AND {$alias}.period = acp"
+                )
+            )
+            ->setParameter($from, $this->rollingDateConverter->convert($data['date_from']))
+            ->setParameter($to, $this->rollingDateConverter->convert($data['date_to']))
+            ->setParameter($steps, $data['accepted_steps_multi']);
+    }
+
+    public function applyOn()
+    {
+        return Declarations::ACP_TYPE;
+    }
+
+    public function buildForm(FormBuilderInterface $builder)
+    {
+        $builder
+            ->add('accepted_steps_multi', ChoiceType::class, [
+                'label' => 'export.filter.course.by_step.steps',
+                'choices' => self::STEPS,
+                'multiple' => true,
+                'expanded' => true,
+            ])
+            ->add('date_from', PickRollingDateType::class, [
+                'label' => 'export.filter.course.by_step.date_from',
+            ])
+            ->add('date_to', PickRollingDateType::class, [
+                'label' => 'export.filter.course.by_step.date_to',
+            ]);
+    }
+
+    public function getFormDefaultData(): array
+    {
+        return [
+            'accepted_steps_multi' => self::DEFAULT_CHOICE,
+            'date_from' => new RollingDate(RollingDate::T_YEAR_CURRENT_START),
+            'date_to' => new RollingDate(RollingDate::T_TODAY),
+        ];
+    }
+
+    public function describeAction($data, $format = 'string')
+    {
+        $steps = array_map(fn (string $step) => $this->translator->trans(array_flip(self::STEPS)[$step]), $data['accepted_steps_multi']);
+
+        return ['export.filter.course.by_step.Filtered by steps: only %step% and between %date_from% and %date_to%', [
+            '%step%' => implode(', ', $steps),
+            '%date_from%' => $this->rollingDateConverter->convert($data['date_from'])->format('d-m-Y'),
+            '%date_to%' => $this->rollingDateConverter->convert($data['date_to'])->format('d-m-Y'),
+        ]];
+    }
+
+    public function getTitle()
+    {
+        return 'export.filter.course.by_step.Filter by step between dates';
+    }
+}

src/Bundle/ChillPersonBundle/Export/Filter/AccompanyingCourseFilters/StepFilterOnDate.php

@@ -23,7 +23,7 @@ use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Contracts\Translation\TranslatorInterface;
 use function in_array;
 
-class StepFilter implements FilterInterface
+class StepFilterOnDate implements FilterInterface
 {
     private const A = 'acp_filter_bystep_stephistories';
 
@@ -95,6 +95,7 @@ class StepFilter implements FilterInterface
     {
         $builder
             ->add('accepted_steps_multi', ChoiceType::class, [
+                'label' => 'export.filter.course.by_step.steps',
                 'choices' => self::STEPS,
                 'multiple' => true,
                 'expanded' => true,
@@ -123,6 +124,6 @@ class StepFilter implements FilterInterface
 
     public function getTitle()
     {
-        return 'Filter by step';
+        return 'export.filter.course.by_step.Filter by step';
     }
 }

src/Bundle/ChillPersonBundle/Tests/Export/Filter/AccompanyingCourseFilters/StepFilterTest.php

@@ -13,7 +13,7 @@ namespace Chill\PersonBundle\Tests\Export\Filter\AccompanyingCourseFilters;
 
 use Chill\MainBundle\Test\Export\AbstractFilterTest;
 use Chill\PersonBundle\Entity\AccompanyingPeriod;
-use Chill\PersonBundle\Export\Filter\AccompanyingCourseFilters\StepFilter;
+use Chill\PersonBundle\Export\Filter\AccompanyingCourseFilters\StepFilterOnDate;
 
 /**
  * @internal
@@ -21,7 +21,7 @@ use Chill\PersonBundle\Export\Filter\AccompanyingCourseFilters\StepFilter;
  */
 final class StepFilterTest extends AbstractFilterTest
 {
-    private StepFilter $filter;
+    private StepFilterOnDate $filter;
 
     protected function setUp(): void
     {

src/Bundle/ChillPersonBundle/config/services/exports_accompanying_course.yaml

@@ -28,11 +28,14 @@ services:
         tags:
             - { name: chill.export_filter, alias: accompanyingcourse_socialissue_filter }
 
-    chill.person.export.filter_step:
-        class: Chill\PersonBundle\Export\Filter\AccompanyingCourseFilters\StepFilter
+    Chill\PersonBundle\Export\Filter\AccompanyingCourseFilters\StepFilterOnDate:
         tags:
             - { name: chill.export_filter, alias: accompanyingcourse_step_filter }
 
+    Chill\PersonBundle\Export\Filter\AccompanyingCourseFilters\StepFilterBetweenDates:
+        tags:
+            - { name: chill.export_filter, alias: accompanyingcourse_step_filter_between_dates }
+
     chill.person.export.filter_geographicalunitstat:
         class: Chill\PersonBundle\Export\Filter\AccompanyingCourseFilters\GeographicalUnitStatFilter
         tags:

src/Bundle/ChillPersonBundle/translations/messages.fr.yml

@@ -473,7 +473,6 @@ Accepted socialissues: Problématiques sociales
 "Filtered by socialissues: only %socialissues%": "Filtré par problématique sociale: uniquement %socialissues%"
 Group by social issue: Grouper les parcours par problématiques sociales
 
-Filter by step: Filtrer les parcours par statut du parcours
 Accepted steps: Statuts
 Step: Statut
 "Filtered by steps: only %step%": "Filtré par statut du parcours: uniquement %step%"
@@ -1085,7 +1084,13 @@ export:
                 title: Filter les parcours par intervenant
                 'Filtered by user working on course: only %users%': 'Filtré par intervenants sur le parcours: seulement %users%'
             by_step:
+                Filter by step: Filtrer les parcours par statut du parcours
+                Filter by step between dates: Filtrer les parcours par statut du parcours entre deux dates
+                steps: Statuts retenus
                 date_calc: Date de prise en compte du statut
+                date_from: Statuts acquis après cette date
+                date_to: Statuts acquis avant cette date
+                'Filtered by steps: only %step% and between %date_from% and %date_to%': 'Filtré par statut: seulement %step%, entre %date_from% et %date_to%'
             by_user_scope:
                 Computation date for referrer: Date à laquelle le référent était actif
             by_referrer: