[Grid] [Filter] Add Fulltext Search Filter (#543)

* Add Fulltext search filter. * Update docs * Apply php-cs-fixer changes * Add test. * Apply php-cs-fixer changes --------- Co-authored-by: martineiber <[email protected]>
pimcore · Nov 7, 2024 · 2e8578e · 2e8578e
1 parent 3aa25d5
commit 2e8578e
Show file tree

Hide file tree

Showing 9 changed files with 147 additions and 0 deletions.
diff --git a/config/data_index_filters.yaml b/config/data_index_filters.yaml
@@ -47,6 +47,9 @@ services:
   Pimcore\Bundle\StudioBackendBundle\DataIndex\Filter\IntegerFilter:
     tags: [ 'pimcore.studio_backend.open_search.filter' ]
 
+  Pimcore\Bundle\StudioBackendBundle\DataIndex\Filter\FullTextFilter:
+    tags: [ 'pimcore.studio_backend.open_search.filter' ]
+
   # DataObject
   Pimcore\Bundle\StudioBackendBundle\DataIndex\Filter\DataObject\ClassNameFilter:
       tags: [ 'pimcore.studio_backend.open_search.data_object.filter' ]

diff --git a/doc/03_Grid.md b/doc/03_Grid.md
@@ -45,6 +45,7 @@ Available filters are:
 |    system.pql     |       string        |          PQL Query          |     false      |
 |     system.id     |       integer       |                             |     false      |
 |  system.integer   |       integer       |                             |      true      |
+|  system.fulltext  |       string        |                             |     false      |
 
 
 

diff --git a/src/DataIndex/Filter/FullTextFilter.php b/src/DataIndex/Filter/FullTextFilter.php
@@ -0,0 +1,50 @@
+<?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\SimpleColumnFiltersParameterInterface;
+use function is_string;
+
+/**
+ * @internal
+ */
+final class FullTextFilter implements FilterInterface
+{
+    public function apply(mixed $parameters, QueryInterface $query): QueryInterface
+    {
+        if (!$parameters instanceof SimpleColumnFiltersParameterInterface) {
+            return $query;
+        }
+
+        $filter = $parameters->getSimpleColumnFilterByType(ColumnType::SYSTEM_FULLTEXT->value);
+
+        if (!$filter) {
+            return $query;
+        }
+
+        if (!is_string($filter->getFilterValue())) {
+            throw new InvalidArgumentException('Filter value for the fulltext filter must be a string');
+        }
+
+        $query->filterFullText($filter->getFilterValue());
+
+        return $query;
+    }
+}
diff --git a/src/DataIndex/Query/AssetQuery.php b/src/DataIndex/Query/AssetQuery.php
@@ -27,6 +27,7 @@
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Tree\PathFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Tree\TagFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\FullTextSearch\ElementKeySearch;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\FullTextSearch\FullTextSearch;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\FullTextSearch\WildcardSearch;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\QueryLanguage\PqlFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Sort\OrderByField;
@@ -182,4 +183,11 @@ public function filterInteger(string $field, int $value): QueryInterface
 
         return $this;
     }
+
+    public function filterFullText(string $value): QueryInterface
+    {
+        $this->search->addModifier(new FullTextSearch($value));
+
+        return $this;
+    }
 }
diff --git a/src/DataIndex/Query/DataObjectQuery.php b/src/DataIndex/Query/DataObjectQuery.php
@@ -26,6 +26,7 @@
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Tree\PathFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Tree\TagFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\FullTextSearch\ElementKeySearch;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\FullTextSearch\FullTextSearch;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\QueryLanguage\PqlFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Sort\Tree\OrderByFullPath;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Sort\Tree\OrderByIndexField;
@@ -161,4 +162,11 @@ public function filterInteger(string $field, int $value): QueryInterface
 
         return $this;
     }
+
+    public function filterFullText(string $value): QueryInterface
+    {
+        $this->search->addModifier(new FullTextSearch($value));
+
+        return $this;
+    }
 }
diff --git a/src/DataIndex/Query/DocumentQuery.php b/src/DataIndex/Query/DocumentQuery.php
@@ -26,6 +26,7 @@
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Tree\PathFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Tree\TagFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\FullTextSearch\ElementKeySearch;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\FullTextSearch\FullTextSearch;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\FullTextSearch\WildcardSearch;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\QueryLanguage\PqlFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Sort\OrderByField;
@@ -161,4 +162,11 @@ public function filterInteger(string $field, int $value): QueryInterface
 
         return $this;
     }
+
+    public function filterFullText(string $value): QueryInterface
+    {
+        $this->search->addModifier(new FullTextSearch($value));
+
+        return $this;
+    }
 }
diff --git a/src/DataIndex/Query/QueryInterface.php b/src/DataIndex/Query/QueryInterface.php
@@ -49,4 +49,6 @@ public function filterByPql(string $pqlQuery): self;
     public function setUser(UserInterface $user): self;
 
     public function filterInteger(string $field, int $value): self;
+
+    public function filterFullText(string $value): self;
 }
diff --git a/src/Grid/Column/ColumnType.php b/src/Grid/Column/ColumnType.php
@@ -28,6 +28,7 @@ enum ColumnType: string
     case SYSTEM_DATETIME = 'system.datetime';
     case SYSTEM_TAG = 'system.tag';
     case SYSTEM_PQL_QUERY = 'system.pql';
+    case SYSTEM_FULLTEXT = 'system.fulltext';
     case METADATA_SELECT = 'metadata.select';
     case METADATA_INPUT = 'metadata.input';
     case METADATA_DATE = 'metadata.date';

diff --git a/tests/Unit/DataIndex/Filter/FullTextFilterTest.php b/tests/Unit/DataIndex/Filter/FullTextFilterTest.php
@@ -0,0 +1,66 @@
+<?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\Tests\Unit\DataIndex\Filter;
+
+use Codeception\Stub\Expected;
+use Codeception\Test\Unit;
+use Pimcore\Bundle\StudioBackendBundle\DataIndex\Filter\FullTextFilter;
+use Pimcore\Bundle\StudioBackendBundle\DataIndex\Query\QueryInterface;
+use Pimcore\Bundle\StudioBackendBundle\Exception\Api\InvalidArgumentException;
+use Pimcore\Bundle\StudioBackendBundle\MappedParameter\Filter\SimpleColumnFilter;
+use Pimcore\Bundle\StudioBackendBundle\MappedParameter\Filter\SimpleColumnFiltersParameterInterface;
+
+/**
+ * @internal
+ */
+final class FullTextFilterTest extends Unit
+{
+    public function testIsExceptionThrownWhenFilterIsNotAString(): void
+    {
+        $columnFilter = new SimpleColumnFilter('system.fulltext', 1);
+        $parameter = $this->makeEmpty(SimpleColumnFiltersParameterInterface::class, [
+            'getSimpleColumnFilterByType' => $columnFilter,
+        ]);
+
+        $query = $this->makeEmpty(QueryInterface::class);
+
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Filter value for the fulltext filter must be a string');
+
+        $filter = new FullTextFilter();
+        $filter->apply($parameter, $query);
+    }
+
+    public function testIfFilterFullTextIsCalled(): void
+    {
+        $columnFilter = new SimpleColumnFilter('system.fulltext', 'term');
+        $parameter = $this->makeEmpty(SimpleColumnFiltersParameterInterface::class, [
+            'getSimpleColumnFilterByType' => $columnFilter,
+        ]);
+
+        $query = $this->makeEmpty(QueryInterface::class, [
+            'filterFullText' => Expected::once(function ($term) {
+                $this->assertSame('term', $term);
+
+                return $this->makeEmpty(QueryInterface::class);
+            }),
+        ]);
+
+        $filter = new FullTextFilter();
+        $filter->apply($parameter, $query);
+    }
+}