Improve filters handler

webgriffe · Apr 24, 2024 · deace31 · deace31
1 parent 2ff485c
commit deace31
Show file tree

Hide file tree

Showing 7 changed files with 104 additions and 11 deletions.
diff --git a/config/services/twig.php b/config/services/twig.php
@@ -4,6 +4,8 @@
 
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
+use Webgriffe\SyliusElasticsearchPlugin\Twig\FilterExtension;
+use Webgriffe\SyliusElasticsearchPlugin\Twig\FilterRuntime;
 use Webgriffe\SyliusElasticsearchPlugin\Twig\SearchExtension;
 use Webgriffe\SyliusElasticsearchPlugin\Twig\SearchRuntime;
 
@@ -20,4 +22,12 @@
         ])
         ->tag('twig.runtime')
     ;
+
+    $services->set('webgriffe.sylius_elasticsearch_plugin.twig.extension.filter', FilterExtension::class)
+        ->tag('twig.extension')
+    ;
+
+    $services->set('webgriffe.sylius_elasticsearch_plugin.twig.runtime.filter', FilterRuntime::class)
+        ->tag('twig.runtime')
+    ;
 };
diff --git a/src/Controller/ProductController.php b/src/Controller/ProductController.php
@@ -70,7 +70,7 @@ public function __invoke(Request $request, string $slug): Response
         $size = $request->query->getInt('limit', $this->taxonDefaultPageLimit);
         $page = $request->query->getInt('page', 1);
 
-        /** @var array<string, array<string, string>> $requestFilters */
+        /** @var array<string, array<array-key, array{code: string, value: string}>> $requestFilters */
         $requestFilters = $request->query->all('filters');
         $filters = FilterHelper::retrieveFilters($requestFilters);
 

diff --git a/src/Controller/SearchController.php b/src/Controller/SearchController.php
@@ -74,7 +74,7 @@ public function __invoke(Request $request, ?string $query = null): Response
         $size = $request->query->getInt('limit', $this->searchDefaultPageLimit);
         $page = $request->query->getInt('page', 1);
 
-        /** @var array<string, array<string, string>> $requestFilters */
+        /** @var array<string, array<array-key, array{code: string, value: string}>> $requestFilters */
         $requestFilters = $request->query->all('filters');
         $filters = FilterHelper::retrieveFilters($requestFilters);
 

diff --git a/src/FilterHelper.php b/src/FilterHelper.php
@@ -15,7 +15,7 @@
 final class FilterHelper
 {
     /**
-     * @param array<string, array<string, string>> $requestFilters
+     * @param array<string, array<array-key, array{code: string, value: string}>> $requestFilters
      *
      * @return QueryFilters
      */
@@ -31,10 +31,10 @@ public static function retrieveFilters(array $requestFilters = []): array
             if (!array_key_exists($type, $filters)) {
                 continue;
             }
-            foreach ($filter as $code => $value) {
+            foreach ($filter as $value) {
                 $filters[$type][] = [
-                    'code' => $code,
-                    'value' => $value,
+                    'code' => $value['code'],
+                    'value' => $value['value'],
                 ];
             }
         }

diff --git a/src/Twig/FilterExtension.php b/src/Twig/FilterExtension.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Webgriffe\SyliusElasticsearchPlugin\Twig;
+
+use Twig\Extension\AbstractExtension;
+use Twig\TwigFilter;
+use Twig\TwigFunction;
+
+final class FilterExtension extends AbstractExtension
+{
+    public function getFilters(): array
+    {
+        return [
+            new TwigFilter('is_filter_active', [FilterRuntime::class, 'isFilterActive']),
+        ];
+    }
+
+    public function getFunctions(): array
+    {
+        return [
+            new TwigFunction('merge_filter_value_with_current_active_filters', [FilterRuntime::class, 'mergeFilterValueWithCurrentActiveFilters']),
+        ];
+    }
+}
diff --git a/src/Twig/FilterRuntime.php b/src/Twig/FilterRuntime.php
@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Webgriffe\SyliusElasticsearchPlugin\Twig;
+
+use Twig\Extension\RuntimeExtensionInterface;
+use Webgriffe\SyliusElasticsearchPlugin\Model\FilterInterface;
+use Webgriffe\SyliusElasticsearchPlugin\Model\FilterValueInterface;
+
+final class FilterRuntime implements RuntimeExtensionInterface
+{
+    /**
+     * @param array<string, array<array-key, array{code: string, value: string}>> $activeFilters
+     */
+    public function isFilterActive(FilterValueInterface $filterValue, FilterInterface $filter, array $activeFilters): bool
+    {
+        if (!array_key_exists($filter->getType(), $activeFilters)) {
+            return false;
+        }
+        $appliedFilterValues = $activeFilters[$filter->getType()];
+        foreach ($appliedFilterValues as $appliedFilterValue) {
+            if ($appliedFilterValue['code'] === $filter->getKeyCode() &&
+                $appliedFilterValue['value'] === $filterValue->getKey()
+            ) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * @param array<string, array<array-key, array{code: string, value: string}>> $activeFilters
+     */
+    public function mergeFilterValueWithCurrentActiveFilters(
+        FilterValueInterface $filterValue,
+        FilterInterface $filter,
+        array $activeFilters,
+    ): array {
+        $filterType = $filter->getType();
+        if (!array_key_exists($filterType, $activeFilters)) {
+            $activeFilters[$filterType] = [];
+        }
+        foreach ($activeFilters[$filterType] as $appliedFilterValue) {
+            if ($appliedFilterValue['code'] === $filter->getKeyCode() &&
+                $appliedFilterValue['value'] === $filterValue->getKey()) {
+                return $activeFilters;
+            }
+        }
+        $activeFilters[$filterType][] = [
+            'code' => $filter->getKeyCode(),
+            'value' => $filterValue->getKey(),
+        ];
+
+        return $activeFilters;
+    }
+}
diff --git a/templates/Common/Components/_attributes.html.twig b/templates/Common/Components/_attributes.html.twig
@@ -15,15 +15,14 @@
             <h3>{{ filter.name }}</h3>
             <ul>
                 {% for filterValue in filter.values %}
-                    {% set isCurrentOptionValueUsedAsFilter = currentAppliedFilters[filter.type] is defined and
-                        currentAppliedFilters[filter.type][filter.keyCode] is defined and
-                        currentAppliedFilters[filter.type][filter.keyCode] == filterValue.key
-                    %}
+                    {% set isCurrentOptionValueUsedAsFilter = filterValue|is_filter_active(filter, currentAppliedFilters) %}
 
                     <li>
                         {% set path = path(
                             app.request.attributes.get('_route'),
-                            app.request.attributes.all('_route_params')|merge(app.request.query.all)|merge({(filter.queryStringKey): filterValue.key}),
+                            app.request.attributes.all('_route_params')|merge({
+                                'filters': merge_filter_value_with_current_active_filters(filterValue, filter, currentAppliedFilters),
+                            }),
                         ) %}
                         <a class="item {% if isCurrentOptionValueUsedAsFilter %}disabled{% endif %}"
                            href="{{ path }}"