exports: add new step filter

src/Bundle/ChillPersonBundle/Export/Filter/StepFilter.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace Chill\PersonBundle\Export\Filter;
+
+use Chill\MainBundle\Export\ExportElementValidatedInterface;
+use Chill\MainBundle\Export\FilterInterface;
+use Chill\PersonBundle\Entity\AccompanyingPeriod;
+use Chill\PersonBundle\Entity\Person;
+use Chill\PersonBundle\Export\Declarations;
+use Doctrine\ORM\Query\Expr\Andx;
+use Doctrine\ORM\QueryBuilder;
+use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Validator\Context\ExecutionContextInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
+
+class StepFilter implements FilterInterface
+{
+
+    private const STEPS = [
+        'Draft' => AccompanyingPeriod::STEP_DRAFT,
+        'Confirmed' => AccompanyingPeriod::STEP_CONFIRMED,
+        'Closed' => AccompanyingPeriod::STEP_CLOSED,
+    ];
+
+    private const DEFAULT_CHOICE = AccompanyingPeriod::STEP_CONFIRMED;
+
+    /**
+     * @var TranslatorInterface
+     */
+    protected $translator;
+
+    public function __construct(TranslatorInterface $translator)
+    {
+        $this->translator = $translator;
+    }
+
+    public function buildForm(FormBuilderInterface $builder)
+    {
+        $builder->add('accepted_step', ChoiceType::class, [
+            'choices' => self::STEPS,
+            'multiple' => false,
+            'expanded' => true,
+            'empty_data' => self::DEFAULT_CHOICE,
+            'data' => self::DEFAULT_CHOICE,
+        ]);
+    }
+
+    public function getTitle()
+    {
+        return 'Filter by step';
+    }
+
+    public function describeAction($data, $format = 'string')
+    {
+        $step = array_flip(self::STEPS)[$data['accepted_step']];
+
+        return ["Filtered by steps: only %step%", [
+            '%step%' => $this->translator->trans($step)
+        ]];
+    }
+
+    public function addRole()
+    {
+        return null;
+    }
+
+    public function alterQuery(QueryBuilder $qb, $data)
+    {
+        $where = $qb->getDQLPart('where');
+        $clause = $qb->expr()->eq('acp.step', ':step');
+
+        // override original where clause
+        $where = $qb->expr()->andX($clause);
+
+        $qb->add('where', $where);
+        $qb->setParameter('step', $data['accepted_step']);
+    }
+
+    public function applyOn()
+    {
+        return Declarations::ACP_TYPE;
+    }
+
+}