[Modifier] Add Time Filter

docker-compose.yml

@@ -1,4 +1,3 @@
-version: '3.0'
 services:
     php-generic-data-index-bundle:
         image: pimcore/pimcore:php8.3-latest

src/Model/DefaultSearch/Query/TimeFilter.php

@@ -0,0 +1,93 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+
+namespace Pimcore\Bundle\GenericDataIndexBundle\Model\DefaultSearch\Query;
+
+use Carbon\Carbon;
+use DateTimeInterface;
+use Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\DefaultSearch\QueryType;
+use Pimcore\Bundle\GenericDataIndexBundle\Exception\InvalidArgumentException;
+
+final readonly class TimeFilter implements QueryInterface
+{
+    public function __construct(
+        private string $field,
+        private string|null $startTime = null,
+        private string|null $endTime = null,
+        private string|null $onTime = null,
+    ) {
+    }
+
+    public function getType(): QueryType|string
+    {
+        return 'range';
+    }
+
+    public function isEmpty(): bool
+    {
+        return empty($this->getParams());
+    }
+
+    public function getParams(): array
+    {
+        $params = [];
+
+        if ($this->onTime) {
+            $params['gte'] = $this->onTime;
+            $params['lte'] =  $this->onTime;
+
+            return [$this->field => $params];
+        }
+
+        $params = $this->addStartParams($params);
+        $params = $this->addEndParams($params);
+
+        return [$this->field => $params];
+    }
+
+    public function toArray(bool $withType = false): array
+    {
+        if ($withType) {
+            return [$this->getType() => $this->getParams()];
+        }
+
+        return $this->getParams();
+    }
+
+    public function getField(): string
+    {
+        return $this->field;
+    }
+
+    private function addStartParams(array $params): array
+    {
+        if (!$this->startTime) {
+            return $params;
+        }
+
+        $params['gte'] = $this->startTime;
+
+        return $params;
+    }
+
+    private function addEndParams(array $params): array
+    {
+        if (!$this->endTime) {
+            return $params;
+        }
+
+        $params['lte'] = $this->endTime;
+
+        return $params;
+    }
+}

src/Model/Search/Modifier/Filter/FieldType/ClassificationStoreFilter.php

@@ -27,7 +27,7 @@ public function __construct(
         private string $fieldName,
         private string $group,
         private BooleanFilter|DateFilter|FullTextSearch|IntegerFilter|MultiSelectFilter|BooleanMultiSelectFilter|
-        NumberFilter|NumberRangeFilter|WildcardSearch $subModifier,
+        NumberFilter|NumberRangeFilter|WildcardSearch|TimeFilter $subModifier,
         private string $locale = MappingProperty::NOT_LOCALIZED_KEY,
     ) {
     }
@@ -43,7 +43,7 @@ public function getGroup(): string
     }
 
     public function getSubModifier(): BooleanFilter|DateFilter|FullTextSearch|IntegerFilter|
-    MultiSelectFilter|BooleanMultiSelectFilter|NumberFilter|NumberRangeFilter|WildcardSearch
+    MultiSelectFilter|BooleanMultiSelectFilter|NumberFilter|NumberRangeFilter|WildcardSearch|TimeFilter
     {
         return $this->subModifier;
     }

src/Model/Search/Modifier/Filter/FieldType/TimeFilter.php

@@ -0,0 +1,53 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+
+namespace Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\FieldType;
+
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\SearchModifierInterface;
+
+final readonly class TimeFilter implements SearchModifierInterface
+{
+    public function __construct(
+        private string $field,
+        private string|null $startTime = null,
+        private string|null $endTime = null,
+        private string|null $onTime = null,
+        private bool $enablePqlFieldNameResolution = true,
+    ) {
+    }
+
+    public function getStartTime(): ?string
+    {
+        return $this->startTime;
+    }
+
+    public function getEndTime(): ?string
+    {
+        return $this->endTime;
+    }
+
+    public function getOnTime(): ?string
+    {
+        return $this->onTime;
+    }
+
+    public function getField(): string
+    {
+        return $this->field;
+    }
+
+    public function isPqlFieldNameResolutionEnabled(): bool
+    {
+        return $this->enablePqlFieldNameResolution;
+    }
+}

src/SearchIndexAdapter/DefaultSearch/Search/Modifier/Filter/FieldTypeFilters.php

@@ -17,6 +17,7 @@
 use Pimcore\Bundle\GenericDataIndexBundle\Model\DefaultSearch\Modifier\SearchModifierContextInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\DefaultSearch\Query\BoolExistsQuery;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\DefaultSearch\Query\DateFilter as DateFilterQuery;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\DefaultSearch\Query\TimeFilter as TimeFilterQuery;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\DefaultSearch\Query\MultiBoolQuery;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\DefaultSearch\Query\Query as QueryFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\DefaultSearch\Query\TermsFilter as TermsFilterQuery;
@@ -25,6 +26,7 @@
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\FieldType\DateFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\FieldType\MultiSelectFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\FieldType\NumberRangeFilter;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\FieldType\TimeFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Service\Search\SearchService\SearchPqlFieldNameTransformationServiceInterface;
 
 /**
@@ -71,6 +73,39 @@ public function getDateFilterQuery(
         );
     }
 
+    #[AsSearchModifierHandler]
+    public function handleTimeFilter(
+        TimeFilter $timeFilter,
+        SearchModifierContextInterface $context
+    ): void {
+        $context->getSearch()->addQuery($this->getTimeFilterQuery(
+            $timeFilter,
+            null,
+            $context->getOriginalSearch())
+        );
+    }
+
+    public function getTimeFilterQuery(
+        TimeFilter $timeFilter,
+        ?string $prefix = null,
+        ?SearchInterface $search = null
+    ): TimeFilterQuery {
+        $fieldName = $timeFilter->getField();
+        if ($prefix) {
+            $fieldName = $prefix . '.' . $fieldName;
+        }
+        if ($search && $timeFilter->isPqlFieldNameResolutionEnabled()) {
+            $fieldName = $this->fieldNameTransformationService->transformFieldnameForSearch($search, $fieldName);
+        }
+
+        return new TimeFilterQuery(
+            $fieldName,
+            $timeFilter->getStartTime(),
+            $timeFilter->getEndTime(),
+            $timeFilter->getOnTime(),
+        );
+    }
+
     #[AsSearchModifierHandler]
     public function handleMultiSelectFilter(
         MultiSelectFilter $multiSelectFilter,

src/SearchIndexAdapter/DefaultSearch/Search/Modifier/Filter/NestedTypeFilters.php

@@ -28,6 +28,7 @@
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\FieldType\MultiSelectFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\FieldType\NestedFilter as NestedFilterParam;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\FieldType\NumberRangeFilter;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\FieldType\TimeFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\FullTextSearch\FullTextSearch;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\FullTextSearch\WildcardSearch;
 use Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\DefaultSearch\Search\Modifier\FullTextSearch\FullTextSearchHandlers;
@@ -92,6 +93,9 @@ private function getSubQuery(ClassificationStoreFilter|NestedFilterParam $filter
             $modifier instanceof DateFilter =>
             $this->fieldTypeFilters->getDateFilterQuery($modifier, $fieldName, $search)->toArray(true),
 
+            $modifier instanceof TimeFilter =>
+            $this->fieldTypeFilters->getTimeFilterQuery($modifier, $fieldName, $search)->toArray(true),
+
             $modifier instanceof MultiSelectFilter =>
             $this->fieldTypeFilters->getMultiSelectQuery($modifier, $fieldName, $search)->toArrayAsSubQuery(),
 

tests/Unit/Model/DefaultSearch/Query/TimeFilterTest.php

@@ -0,0 +1,113 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+
+namespace Pimcore\Bundle\GenericDataIndexBundle\Tests\Unit\Model\DefaultSearch\Query;
+
+use Codeception\Test\Unit;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\DefaultSearch\Query\TimeFilter;
+
+/**
+ * @internal
+ */
+final class TimeFilterTest extends Unit
+{
+
+    public function testToArray(): void
+    {
+        $timeFilter = new TimeFilter('datefield', '12:15', '13:15');
+
+        self::assertSame([
+            'range' => [
+                'datefield' => [
+                    'gte' => '12:15',
+                    'lte' => '13:15',
+                ],
+            ],
+        ], $timeFilter->toArray(true));
+
+        $timeFilter = new TimeFilter('datefield', '12:45');
+
+        self::assertSame([
+            'range' => [
+                'datefield' => [
+                    'gte' => '12:45',
+                ],
+            ],
+        ], $timeFilter->toArray(true));
+
+        $timeFilter = new TimeFilter('datefield', null, '13:00');
+
+        self::assertSame([
+            'range' => [
+                'datefield' => [
+                    'lte' => '13:00',
+                ],
+            ],
+        ], $timeFilter->toArray(true));
+
+        $timeFilter = new TimeFilter('datefield', null, null, '12:30');
+
+        self::assertSame([
+            'range' => [
+                'datefield' => [
+                    'gte' => '12:30',
+                    'lte' => '12:30',
+                ],
+            ],
+        ], $timeFilter->toArray(true));
+    }
+
+    public function testGetType(): void
+    {
+        $dateFilter = new TimeFilter('datefield', "12:30", "12:45");
+
+        self::assertSame('range', $dateFilter->getType());
+    }
+
+    public function testGetParams(): void
+    {
+        $timeFilter = new TimeFilter('datefield', '12:15', '13:15');
+
+        self::assertSame([
+            'datefield' => [
+                'gte' => '12:15',
+                'lte' => '13:15',
+            ],
+        ], $timeFilter->getParams());
+
+        $timeFilter = new TimeFilter('datefield', '12:45');
+
+        self::assertSame([
+            'datefield' => [
+                'gte' => '12:45',
+            ],
+        ], $timeFilter->getParams());
+
+        $timeFilter = new TimeFilter('datefield', null, '13:00');
+
+        self::assertSame([
+            'datefield' => [
+                'lte' => '13:00',
+            ],
+        ], $timeFilter->getParams());
+
+        $timeFilter = new TimeFilter('datefield', null, null, '12:30');
+
+        self::assertSame([
+            'datefield' => [
+                'gte' => '12:30',
+                'lte' => '12:30',
+            ],
+        ], $timeFilter->getParams());
+    }
+}