[Grid] Add Time Filter

composer.json

@@ -21,7 +21,7 @@
     "league/csv": "^9.22",
     "nesbot/carbon": "^3.8.4",
     "pimcore/static-resolver-bundle": "^3.3.0",
-    "pimcore/generic-data-index-bundle": "^2.2.1",
+    "pimcore/generic-data-index-bundle": "^2.3.0",
     "pimcore/pimcore": "^12.3",
     "zircote/swagger-php": "^4.8 || ^5.0",
     "ext-zip": "*",

config/data_index_filters.yaml

@@ -83,6 +83,9 @@ services:
   Pimcore\Bundle\StudioBackendBundle\DataIndex\Filter\RGBAFilter:
     tags: [ 'pimcore.studio_backend.search_index.filter' ]
 
+  Pimcore\Bundle\StudioBackendBundle\DataIndex\Filter\TimeFilter:
+    tags: [ 'pimcore.studio_backend.search_index.filter' ]
+
   # DataObject
   Pimcore\Bundle\StudioBackendBundle\DataIndex\Filter\DataObject\ClassNameFilter:
       tags: [ 'pimcore.studio_backend.search_index.data_object.filter' ]
@@ -120,5 +123,8 @@ services:
   Pimcore\Bundle\StudioBackendBundle\DataIndex\Filter\DataObject\Classificationstore\BooleanFilter:
     tags: [ 'pimcore.studio_backend.search_index.data_object.filter' ]
 
+  Pimcore\Bundle\StudioBackendBundle\DataIndex\Filter\DataObject\Classificationstore\TimeFilter:
+    tags: [ 'pimcore.studio_backend.search_index.data_object.filter' ]
+
   Pimcore\Bundle\StudioBackendBundle\DataIndex\Filter\DataObject\CRM\ConsentFilter:
     tags: [ 'pimcore.studio_backend.search_index.data_object.filter' ]

doc/03_Grid.md

@@ -34,6 +34,7 @@ Available filters are:
 |              system.string               |                  string                  |       Wildcard search can be used       |      true      |
 |             system.datetime              |            object of ISO 8601            |          `from`, `to`, or `on`          |      true      |
 |               system.date                | object of ISO 8601<br/>will round to day |          `from`, `to`, or `on`          |      true      |
+|               system.time                |              object (12:15)              |          `from`, `to`, or `on`          |      true      |
 |                system.tag                |                  object                  |       `considerChildTags`, `tags`       |     false      |
 |                system.pql                |                  string                  |                PQL Query                |     false      |
 |                system.id                 |                 integer                  |                                         |     false      |
@@ -50,6 +51,7 @@ Available filters are:
 |         classificationstore.rbga         |                  object                  |             `r`,`g`,`b`,`a`             |      true      |
 |         classificationstore.date         | object of ISO 8601<br/>will round to day |          `from`, `to`, or `on`          |      true      |
 |       classificationstore.datetime       |            object of ISO 8601            |          `from`, `to`, or `on`          |      true      |
+|         classificationstore.time         |              object (12:45)              |          `from`, `to`, or `on`          |      true      |
 |    classificationstore.quantity_value    |              sting, integer              | `from`, `to`, `is`, `setting`, `unitId` |      true      |
 | classificationstore.input_quantity_value |                  string                  |    `unitId`(string), `value`(string)    |      true      |
 |        classificationstore.select        |                  array                   |                                         |      true      |

src/DataIndex/Filter/DataObject/Classificationstore/TimeFilter.php

@@ -0,0 +1,141 @@
+<?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\StudioBackendBundle\DataIndex\Filter\DataObject\Classificationstore;
+
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\FieldType\TimeFilter as GDITimeFilter;
+use Pimcore\Bundle\StudioBackendBundle\ClassificationStore\Repository\GroupConfigRepositoryInterface;
+use Pimcore\Bundle\StudioBackendBundle\ClassificationStore\Repository\KeyGroupRelationRepositoryInterface;
+use Pimcore\Bundle\StudioBackendBundle\DataIndex\Filter\FilterInterface;
+use Pimcore\Bundle\StudioBackendBundle\DataIndex\Query\DataObjectQueryInterface;
+use Pimcore\Bundle\StudioBackendBundle\DataIndex\Query\QueryInterface;
+use Pimcore\Bundle\StudioBackendBundle\DataIndex\Utils\ClassificationStoreFilterValue;
+use Pimcore\Bundle\StudioBackendBundle\DataIndex\Utils\GetClassificationStoreFilterValueTrait;
+use Pimcore\Bundle\StudioBackendBundle\Grid\Column\ColumnType;
+use Pimcore\Bundle\StudioBackendBundle\MappedParameter\Filter\ColumnFilter;
+use Pimcore\Bundle\StudioBackendBundle\MappedParameter\Filter\ColumnFiltersParameterInterface;
+use Pimcore\Model\DataObject\Classificationstore\GroupConfig;
+use Pimcore\Model\DataObject\Classificationstore\KeyGroupRelation;
+
+/**
+ * @internal
+ */
+final class TimeFilter implements FilterInterface
+{
+    use GetClassificationStoreFilterValueTrait;
+
+    public function __construct(
+        private readonly GroupConfigRepositoryInterface $groupConfigRepository,
+        private readonly KeyGroupRelationRepositoryInterface $keyGroupRelationRepository
+    ) {
+
+    }
+
+    public function apply(mixed $parameters, QueryInterface $query): QueryInterface
+    {
+        if (!$parameters instanceof ColumnFiltersParameterInterface) {
+            return $query;
+        }
+
+        if (!$query instanceof DataObjectQueryInterface) {
+            return $query;
+        }
+
+        foreach ($parameters->getColumnFilterByType(ColumnType::CLASSIFICATION_STORE_TIME->value) as $column) {
+            $filterValue = $this->getClassificationStoreFilterValue($column->getFilterValue());
+            $key = $this->keyGroupRelationRepository->getByKeyId($filterValue->getKeyId());
+            $group = $this->groupConfigRepository->getById($filterValue->getGroupId());
+            /** @var DataObjectQueryInterface $query */
+            $query = $this->applyTimeFilter($column, $query, $key, $group, $filterValue);
+        }
+
+        return $query;
+    }
+
+    private function applyTimeFilter(
+        ColumnFilter $column,
+        DataObjectQueryInterface $query,
+        KeyGroupRelation $key,
+        GroupConfig $group,
+        ClassificationStoreFilterValue $filterValue,
+    ): QueryInterface {
+
+        $value = $filterValue->getValue();
+
+        if (isset($value['from'], $value['to'])) {
+
+            $query->classificationStoreFilter(
+                $column->getKeyWithOutLocale(),
+                $group->getName(),
+                $this->buildTimeFilterModifier(
+                    $key->getName(),
+                    $value['from'],
+                    $value['to']
+                ),
+                $column->getLocale()
+            );
+
+            return $query;
+        }
+
+        if (isset($value['on'])) {
+            $query->classificationStoreFilter(
+                $column->getKeyWithOutLocale(),
+                $group->getName(),
+                $this->buildTimeFilterModifier(
+                    $key->getName(),
+                    null,
+                    null,
+                    $value['on']
+                ),
+                $column->getLocale()
+            );
+        }
+
+        if (isset($value['to'])) {
+            $query->classificationStoreFilter(
+                $column->getKeyWithOutLocale(),
+                $group->getName(),
+                $this->buildTimeFilterModifier(
+                    $key->getName(),
+                    null,
+                    $value['to']
+                ),
+                $column->getLocale()
+            );
+        }
+
+        if (isset($value['from'])) {
+            $query->classificationStoreFilter(
+                $column->getKeyWithOutLocale(),
+                $group->getName(),
+                $this->buildTimeFilterModifier(
+                    $key->getName(),
+                    $value['from']
+                ),
+                $column->getLocale()
+            );
+        }
+
+        return $query;
+    }
+
+    private function buildTimeFilterModifier(
+        string $field,
+        ?string $startTime = null,
+        ?string $endTime = null,
+        ?string $onTime = null,
+    ): GDITimeFilter {
+        return new GDITimeFilter($field, $startTime, $endTime, $onTime);
+    }
+}

src/DataIndex/Filter/DateTimeTrait.php

@@ -201,7 +201,6 @@ private function applyClassificationStoreDateFilter(
                 ),
                 $column->getLocale()
             );
-            $query->filterDatetime($column->getKey(), $this->getFromAsCarbon());
         }
 
         return $query;

src/DataIndex/Filter/TimeFilter.php

@@ -0,0 +1,79 @@
+<?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\StudioBackendBundle\DataIndex\Filter;
+
+use Pimcore\Bundle\StudioBackendBundle\DataIndex\Filter\Asset\IsAssetFilterTrait;
+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_array;
+
+/**
+ * @internal
+ */
+final class TimeFilter implements FilterInterface
+{
+    use IsAssetFilterTrait;
+
+    public function apply(mixed $parameters, QueryInterface $query): QueryInterface
+    {
+        if (!$parameters instanceof ColumnFiltersParameterInterface) {
+            return $query;
+        }
+
+        foreach ($parameters->getColumnFilterByType(ColumnType::SYSTEM_TIME->value) as $column) {
+            $query = $this->applyDatetimeFilter($column, $query);
+        }
+
+        return $query;
+    }
+
+    private function applyDatetimeFilter(
+        ColumnFilter $column,
+        QueryInterface $query,
+    ): QueryInterface {
+
+        if (!is_array($column->getFilterValue())) {
+            throw new InvalidArgumentException('Filter value for this filter must be an array');
+        }
+
+        $filterValue = $column->getFilterValue();
+
+        if (isset($filterValue['from'], $filterValue['to'])) {
+            $query->filterTime(
+                $column->getKey(),
+                $filterValue['from'],
+                $filterValue['to']
+            );
+
+            return $query;
+        }
+
+        if (isset($filterValue['on'])) {
+            $query->filterTime($column->getKey(), null, null, $filterValue['on']);
+        }
+
+        if (isset($filterValue['to'])) {
+            $query->filterTime($column->getKey(), null, $filterValue['to']);
+        }
+
+        if (isset($filterValue['from'])) {
+            $query->filterTime($column->getKey(), $filterValue['from']);
+        }
+
+        return $query;
+    }
+}

src/DataIndex/Query/AssetQuery.php

@@ -26,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\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;
@@ -162,6 +163,24 @@ public function filterDatetime(
         return $this;
     }
 
+    public function filterTime(
+        string $field,
+        string|null $startTime = null,
+        string|null $endTime = null,
+        string|null $onTime = null,
+        bool $enablePqlFieldNameResolution = true
+    ): QueryInterface {
+        $this->search->addModifier(new TimeFilter(
+            $field,
+            $startTime,
+            $endTime,
+            $onTime,
+            $enablePqlFieldNameResolution
+        ));
+
+        return $this;
+    }
+
     /**
      * @param array<int> $tags
      */

src/DataIndex/Query/DataObjectQuery.php

@@ -28,6 +28,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\Model\Search\Modifier\Filter\Tree\ClassIdsFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Tree\ParentIdFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Tree\PathFilter;
@@ -251,6 +252,24 @@ public function filterDatetime(
         return $this;
     }
 
+    public function filterTime(
+        string $field,
+        string|null $startTime = null,
+        string|null $endTime = null,
+        string|null $onTime = null,
+        bool $enablePqlFieldNameResolution = true
+    ): QueryInterface {
+        $this->search->addModifier(new TimeFilter(
+            $field,
+            $startTime,
+            $endTime,
+            $onTime,
+            $enablePqlFieldNameResolution
+        ));
+
+        return $this;
+    }
+
     public function booleanFilter(string $fieldName, array $values): self
     {
         $this->search->addModifier(new BooleanMultiSelectFilter($fieldName, $values));
@@ -269,6 +288,7 @@ public function classificationStoreFilter(
         NumberRangeFilter|
         NumberFilter|
         BooleanMultiSelectFilter|
+        TimeFilter|
         WildcardSearch $subModifier,
         ?string $locale = null
     ): self {

src/DataIndex/Query/DataObjectQueryInterface.php

@@ -21,6 +21,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\Model\Search\Modifier\FullTextSearch\FullTextSearch;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\FullTextSearch\WildcardSearch;
 
@@ -51,6 +52,7 @@ public function classificationStoreFilter(
         MultiSelectFilter|
         NumberRangeFilter|
         NumberFilter|
+        TimeFilter|
         BooleanMultiSelectFilter|
         WildcardSearch $subModifier,
         ?string $locale

src/DataIndex/Query/DocumentQuery.php

@@ -26,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\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;
@@ -209,6 +210,24 @@ public function filterDatetime(
         return $this;
     }
 
+    public function filterTime(
+        string $field,
+        string|null $startTime = null,
+        string|null $endTime = null,
+        string|null $onTime = null,
+        bool $enablePqlFieldNameResolution = true
+    ): QueryInterface {
+        $this->search->addModifier(new TimeFilter(
+            $field,
+            $startTime,
+            $endTime,
+            $onTime,
+            $enablePqlFieldNameResolution
+        ));
+
+        return $this;
+    }
+
     public function filterNumber(
         string $fieldName,
         int|float $searchTerm,