[Grid] [Filter] Add filter for system.integer (#537)

* Add integer filter.

* Apply php-cs-fixer changes

* Needs Key.

* Change to integer.

---------

Co-authored-by: martineiber <[email protected]>

Author: martineiber

config/data_index_filters.yaml

@@ -44,6 +44,9 @@ services:
   Pimcore\Bundle\StudioBackendBundle\DataIndex\Filter\IdFilter:
     tags: [ 'pimcore.studio_backend.open_search.filter' ]
 
+  Pimcore\Bundle\StudioBackendBundle\DataIndex\Filter\IntegerFilter:
+    tags: [ 'pimcore.studio_backend.open_search.filter' ]
+
   # DataObject
   Pimcore\Bundle\StudioBackendBundle\DataIndex\Filter\DataObject\ClassNameFilter:
       tags: [ 'pimcore.studio_backend.open_search.data_object.filter' ]

doc/03_Grid.md

@@ -44,6 +44,7 @@ Available filters are:
 |    system.tag     |       object        | `considerChildTags`, `tags` |     false      |
 |    system.pql     |       string        |          PQL Query          |     false      |
 |     system.id     |       integer       |                             |     false      |
+|  system.integer   |       integer       |                             |      true      |
 
 
 

src/DataIndex/Filter/IntegerFilter.php

@@ -0,0 +1,54 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+namespace Pimcore\Bundle\StudioBackendBundle\DataIndex\Filter;
+
+use Pimcore\Bundle\StudioBackendBundle\DataIndex\Query\QueryInterface;
+use Pimcore\Bundle\StudioBackendBundle\Exception\Api\InvalidArgumentException;
+use Pimcore\Bundle\StudioBackendBundle\Grid\Column\ColumnType;
+use Pimcore\Bundle\StudioBackendBundle\MappedParameter\Filter\ColumnFilter;
+use Pimcore\Bundle\StudioBackendBundle\MappedParameter\Filter\ColumnFiltersParameterInterface;
+use function is_int;
+
+/**
+ * @internal
+ */
+final class IntegerFilter implements FilterInterface
+{
+    public function apply(mixed $parameters, QueryInterface $query): QueryInterface
+    {
+        if (!$parameters instanceof ColumnFiltersParameterInterface) {
+            return $query;
+        }
+
+        foreach ($parameters->getColumnFilterByType(ColumnType::SYSTEM_INTEGER->value) as $column) {
+            $query = $this->applyIntegerFilter($column, $query);
+        }
+
+        return $query;
+    }
+
+    private function applyIntegerFilter(ColumnFilter $column, QueryInterface $query): QueryInterface
+    {
+        if (!is_int($column->getFilterValue())) {
+            throw new InvalidArgumentException('Filter value for this filter must be a integer');
+        }
+
+        $query->filterInteger($column->getKey(), $column->getFilterValue());
+
+        return $query;
+    }
+}

src/DataIndex/Query/AssetQuery.php

@@ -21,6 +21,7 @@
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Asset\AssetMetaDataFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Basic\ExcludeFoldersFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Basic\IdsFilter;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Basic\IntegerFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\FieldType\DateFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Tree\ParentIdFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Tree\PathFilter;
@@ -174,4 +175,11 @@ public function setUser(UserInterface $user): self
 
         return $this;
     }
+
+    public function filterInteger(string $field, int $value): QueryInterface
+    {
+        $this->search->addModifier(new IntegerFilter($field, $value));
+
+        return $this;
+    }
 }

src/DataIndex/Query/DataObjectQuery.php

@@ -21,6 +21,7 @@
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\DataObject\DataObjectSearch;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Basic\ExcludeFoldersFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Basic\IdsFilter;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Basic\IntegerFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Tree\ParentIdFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Tree\PathFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Tree\TagFilter;
@@ -153,4 +154,11 @@ public function setUser(UserInterface $user): QueryInterface
 
         return $this;
     }
+
+    public function filterInteger(string $field, int $value): QueryInterface
+    {
+        $this->search->addModifier(new IntegerFilter($field, $value));
+
+        return $this;
+    }
 }

src/DataIndex/Query/DocumentQuery.php

@@ -21,6 +21,7 @@
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Asset\AssetMetaDataFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Basic\ExcludeFoldersFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Basic\IdsFilter;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Basic\IntegerFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Tree\ParentIdFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Tree\PathFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Tree\TagFilter;
@@ -153,4 +154,11 @@ public function setUser(UserInterface $user): self
 
         return $this;
     }
+
+    public function filterInteger(string $field, int $value): QueryInterface
+    {
+        $this->search->addModifier(new IntegerFilter($field, $value));
+
+        return $this;
+    }
 }

src/DataIndex/Query/QueryInterface.php

@@ -47,4 +47,6 @@ public function filterTags(array $tags, bool $considerChildTags): self;
     public function filterByPql(string $pqlQuery): self;
 
     public function setUser(UserInterface $user): self;
+
+    public function filterInteger(string $field, int $value): self;
 }