Implement ByStepFilter for AccompanyingPeriodStepHistoryFilters and its tests

A new feature has been added, the ByStepFilter, to the Chill project. The ByStepFilter provides a way to filter data in AccompanyingPeriodStepHistoryFilters based on certain steps. In addition, a new test suite has been introduced to ensure the correct functionality of this filter. The necessary translations for completing this feature have also been included.
2025-08-31 12:03:48 +00:00 · 2024-01-29 11:37:59 +01:00
parent 44ccfe92b6
commit 97d401b7f6
3 changed files with 159 additions and 1 deletions
--- a/src/Bundle/ChillPersonBundle/Export/Filter/AccompanyingPeriodStepHistoryFilters/ByStepFilter.php
+++ b/src/Bundle/ChillPersonBundle/Export/Filter/AccompanyingPeriodStepHistoryFilters/ByStepFilter.php
@@ -0,0 +1,87 @@
+<?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\AccompanyingPeriodStepHistoryFilters;
+
+use Chill\MainBundle\Export\FilterInterface;
+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;
+
+final readonly class ByStepFilter implements FilterInterface
+{
+    public function __construct(
+        private TranslatorInterface $translator,
+    ) {
+    }
+
+    public function getTitle()
+    {
+        return 'export.filter.step_history.by_step.title';
+    }
+
+    public function buildForm(FormBuilderInterface $builder)
+    {
+        $steps = [
+            AccompanyingPeriod::STEP_CONFIRMED,
+            AccompanyingPeriod::STEP_CONFIRMED_INACTIVE_SHORT,
+            AccompanyingPeriod::STEP_CONFIRMED_INACTIVE_LONG,
+            AccompanyingPeriod::STEP_CLOSED,
+        ];
+
+        $builder->add('steps', ChoiceType::class, [
+            'choices' => array_combine(
+                array_map(static fn (string $step): string => 'accompanying_period.'.$step, $steps),
+                $steps
+            ),
+            'label' => 'export.filter.step_history.by_step.pick_steps',
+            'multiple' => true,
+            'expanded' => true,
+        ]);
+    }
+
+    public function getFormDefaultData(): array
+    {
+        return [
+            'steps' => [],
+        ];
+    }
+
+    public function describeAction($data, $format = 'string')
+    {
+        return [
+            'export.filter.step_history.by_step.description',
+            [
+                '%steps%' => implode(', ', array_map(fn (string $step) => $this->translator->trans('accompanying_period.'.$step), $data['steps'])),
+            ],
+        ];
+    }
+
+    public function addRole(): ?string
+    {
+        return null;
+    }
+
+    public function alterQuery(QueryBuilder $qb, $data)
+    {
+        $qb
+            ->andWhere('acpstephistory.step IN (:acpstephistory_by_step_filter_steps)')
+            ->setParameter('acpstephistory_by_step_filter_steps', $data['steps']);
+    }
+
+    public function applyOn()
+    {
+        return Declarations::ACP_STEP_HISTORY;
+    }
+}