Merge remote-tracking branch 'origin/master' into issue120_filter_social_actions

src/Bundle/ChillMainBundle/Templating/Listing/FilterOrderGetActiveFilterHelper.php

@@ -0,0 +1,92 @@
+<?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\Templating\Listing;
+
+use Chill\MainBundle\Templating\Entity\UserRender;
+use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
+use Symfony\Component\PropertyAccess\PropertyPathInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
+
+final readonly class FilterOrderGetActiveFilterHelper
+{
+    public function __construct(
+        private TranslatorInterface $translator,
+        private PropertyAccessorInterface $propertyAccessor,
+        private UserRender $userRender,
+    ) {
+    }
+
+    /**
+     * Return all the data required to display the active filters
+     *
+     * @param FilterOrderHelper $filterOrderHelper
+     * @return array<array{label: string, value: string, position: string, name: string}>
+     */
+    public function getActiveFilters(FilterOrderHelper $filterOrderHelper): array
+    {
+        $result = [];
+
+        if ($filterOrderHelper->hasSearchBox() && '' !== $filterOrderHelper->getQueryString()) {
+            $result[] = ['label' => '', 'value' => $filterOrderHelper->getQueryString(), 'position' => FilterOrderPositionEnum::SearchBox->value, 'name' => 'q'];
+        }
+
+        foreach ($filterOrderHelper->getDateRanges() as $name => ['label' => $label]) {
+            $base = ['position' => FilterOrderPositionEnum::DateRange->value, 'name' => $name, 'label' => (string)$label];
+
+            if (null !== ($from = $filterOrderHelper->getDateRangeData($name)['from'] ?? null)) {
+                $result[] = ['value' => $this->translator->trans('filter_order.by_date.From', ['from_date' => $from]), ...$base];
+            }
+            if (null !== ($to = $filterOrderHelper->getDateRangeData($name)['to'] ?? null)) {
+                $result[] = ['value' => $this->translator->trans('filter_order.by_date.To', ['to_date' => $to]), ...$base];
+            }
+        }
+
+        foreach ($filterOrderHelper->getCheckboxes() as $name => ['choices' => $choices, 'trans' => $trans]) {
+            $translatedChoice = array_combine($choices, [...$trans]);
+            foreach ($filterOrderHelper->getCheckboxData($name) as $keyChoice) {
+                $result[] = ['value' => $this->translator->trans($translatedChoice[$keyChoice]), 'label' => '', 'position' => FilterOrderPositionEnum::Checkboxes->value, 'name' => $name];
+            }
+        }
+
+        foreach ($filterOrderHelper->getEntityChoices() as $name => ['label' => $label, 'class' => $class, 'choices' => $choices, 'options' => $options]) {
+            foreach ($filterOrderHelper->getEntityChoiceData($name) as $selected) {
+                if (is_callable($options['choice_label'])) {
+                    $value = call_user_func($options['choice_label'], $selected);
+                } elseif ($options['choice_label'] instanceof PropertyPathInterface || is_string($options['choice_label'])) {
+                    $value = $this->propertyAccessor->getValue($selected, $options['choice_label']);
+                } else {
+                    if (!$selected instanceof \Stringable) {
+                        throw new \UnexpectedValueException(sprintf("we are not able to transform the value of %s to a string. Implements \\Stringable or add a 'choice_label' option to the filterFormBuilder", get_class($selected)));
+                    }
+
+                    $value = (string)$selected;
+                }
+
+                $result[] = ['value' => $this->translator->trans($value), 'label' => $label, 'position' => FilterOrderPositionEnum::EntityChoice->value, 'name' => $name];
+            }
+        }
+
+        foreach ($filterOrderHelper->getUserPickers() as $name => ['label' => $label, 'options' => $options]) {
+            foreach ($filterOrderHelper->getUserPickerData($name) as $user) {
+                $result[] = ['value' => $this->userRender->renderString($user, []), 'label' => (string) $label, 'position' => FilterOrderPositionEnum::UserPicker->value, 'name' => $name];
+            }
+        }
+
+        foreach ($filterOrderHelper->getSingleCheckbox() as $name => ['label' => $label]) {
+            if (true === $filterOrderHelper->getSingleCheckboxData($name)) {
+                $result[] = ['label' => '', 'value' => $this->translator->trans($label), 'position' => FilterOrderPositionEnum::SingleCheckbox->value, 'name' => $name];
+            }
+        }
+
+        return $result;
+    }
+}

src/Bundle/ChillMainBundle/Templating/Listing/FilterOrderHelper.php

@@ -20,6 +20,11 @@ use Symfony\Component\Form\FormFactoryInterface;
 use Symfony\Component\Form\FormInterface;
 use Symfony\Component\HttpFoundation\RequestStack;
 
+use Symfony\Component\PropertyAccess\PropertyAccessor;
+use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
+use Symfony\Component\PropertyAccess\PropertyPath;
+use Symfony\Component\PropertyAccess\PropertyPathInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
 use function array_merge;
 use function count;
 
@@ -34,16 +39,12 @@ class FilterOrderHelper
 
     private array $dateRanges = [];
 
-    private FormFactoryInterface $formFactory;
-
     public const FORM_NAME = 'f';
 
     private array $formOptions = [];
 
     private string $formType = FilterOrderType::class;
 
-    private RequestStack $requestStack;
-
     private ?array $searchBoxFields = null;
 
     private ?array $submitted = null;
@@ -59,11 +60,9 @@ class FilterOrderHelper
     private array $userPickers = [];
 
     public function __construct(
-        FormFactoryInterface $formFactory,
-        RequestStack $requestStack
+        private readonly FormFactoryInterface $formFactory,
+        private readonly RequestStack $requestStack,
     ) {
-        $this->formFactory = $formFactory;
-        $this->requestStack = $requestStack;
     }
 
     public function addSingleCheckbox(string $name, string $label): self
@@ -98,14 +97,14 @@ class FilterOrderHelper
 
     public function addCheckbox(string $name, array $choices, ?array $default = [], ?array $trans = [], array $options = []): self
     {
-        $missing = count($choices) - count($trans) - 1;
+        if ([] === $trans) {
+            $trans = $choices;
+        }
+
         $this->checkboxes[$name] = [
-            'choices' => $choices, 'default' => $default,
-            'trans' => array_merge(
-                $trans,
-                0 < $missing ?
-                       array_fill(0, $missing, null) : []
-            ),
+            'choices' => $choices,
+            'default' => $default,
+            'trans' => $trans,
             ...$options,
         ];
 
@@ -135,21 +134,39 @@ class FilterOrderHelper
         return $this->userPickers;
     }
 
-    public function getUserPickerData(string $name)
+    /**
+     * @return list<User>
+     */
+    public function getUserPickerData(string $name): array
     {
         return $this->getFormData()['user_pickers'][$name];
     }
 
+    public function hasCheckboxData(string $name): bool
+    {
+        return array_key_exists($name, $this->checkboxes);
+    }
+
     public function getCheckboxData(string $name): array
     {
         return $this->getFormData()['checkboxes'][$name];
     }
 
+    public function hasSingleCheckboxData(string $name): bool
+    {
+        return array_key_exists($name, $this->singleCheckbox);
+    }
+
     public function getSingleCheckboxData(string $name): ?bool
     {
         return $this->getFormData()['single_checkboxes'][$name];
     }
 
+    public function hasEntityChoice(string $name): bool
+    {
+        return array_key_exists($name, $this->entityChoices);
+    }
+
     public function getEntityChoiceData($name): mixed
     {
         return $this->getFormData()['entity_choices'][$name];
@@ -173,6 +190,11 @@ class FilterOrderHelper
         return $this->singleCheckbox;
     }
 
+    public function hasDateRangeData(string $name): bool
+    {
+        return array_key_exists($name, $this->dateRanges);
+    }
+
     /**
      * @return array{to: ?DateTimeImmutable, from: ?DateTimeImmutable}
      */
@@ -239,7 +261,6 @@ class FilterOrderHelper
         }
 
         return $r;
-
     }
 
     private function getFormData(): array

src/Bundle/ChillMainBundle/Templating/Listing/FilterOrderHelperBuilder.php

@@ -14,6 +14,8 @@ namespace Chill\MainBundle\Templating\Listing;
 use DateTimeImmutable;
 use Symfony\Component\Form\FormFactoryInterface;
 use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
 
 class FilterOrderHelperBuilder
 {
@@ -44,7 +46,7 @@ class FilterOrderHelperBuilder
 
     public function __construct(
         FormFactoryInterface $formFactory,
-        RequestStack $requestStack
+        RequestStack $requestStack,
     ) {
         $this->formFactory = $formFactory;
         $this->requestStack = $requestStack;
@@ -99,7 +101,7 @@ class FilterOrderHelperBuilder
     {
         $helper = new FilterOrderHelper(
             $this->formFactory,
-            $this->requestStack
+            $this->requestStack,
         );
 
         $helper->setSearchBox($this->searchBoxFields);

src/Bundle/ChillMainBundle/Templating/Listing/FilterOrderHelperFactory.php

@@ -13,6 +13,8 @@ namespace Chill\MainBundle\Templating\Listing;
 
 use Symfony\Component\Form\FormFactoryInterface;
 use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
 
 class FilterOrderHelperFactory implements FilterOrderHelperFactoryInterface
 {
@@ -22,7 +24,7 @@ class FilterOrderHelperFactory implements FilterOrderHelperFactoryInterface
 
     public function __construct(
         FormFactoryInterface $formFactory,
-        RequestStack $requestStack
+        RequestStack $requestStack,
     ) {
         $this->formFactory = $formFactory;
         $this->requestStack = $requestStack;

src/Bundle/ChillMainBundle/Templating/Listing/FilterOrderPositionEnum.php

@@ -0,0 +1,22 @@
+<?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\Templating\Listing;
+
+enum FilterOrderPositionEnum: string
+{
+    case SearchBox = 'search_box';
+    case Checkboxes = 'checkboxes';
+    case DateRange = 'date_range';
+    case EntityChoice = 'entity_choice';
+    case SingleCheckbox = 'single_checkbox';
+    case UserPicker = 'user_picker';
+}

src/Bundle/ChillMainBundle/Templating/Listing/Templating.php

@@ -24,6 +24,7 @@ class Templating extends AbstractExtension
 {
     public function __construct(
         private readonly RequestStack $requestStack,
+        private readonly FilterOrderGetActiveFilterHelper $filterOrderGetActiveFilterHelper,
     ) {
     }
 
@@ -68,6 +69,7 @@ class Templating extends AbstractExtension
 
         return $environment->render($template, [
             'helper' => $helper,
+            'active' => $this->filterOrderGetActiveFilterHelper->getActiveFilters($helper),
             'form' => $helper->buildForm()->createView(),
             'options' => $options,
             'otherParameters' => $otherParameters,