feat: date filter and facets

sitepark · May 3, 2024 · 9208e14 · 9208e14
1 parent 2e2b71a
commit 9208e14
Show file tree

Hide file tree

Showing 24 changed files with 646 additions and 96 deletions.
diff --git a/src/Dto/Search/Query/DateRangeRound.php b/src/Dto/Search/Query/DateRangeRound.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Atoolo\Search\Dto\Search\Query;
+
+/**
+ * @codeCoverageIgnore
+ */
+enum DateRangeRound : string
+{
+    case START_OF_DAY = 'START_OF_DAY';
+    case START_OF_PREVIOUS_DAY = 'START_OF_PREVIOUS_DAY';
+    case END_OF_DAY = 'END_OF_DAY';
+    case END_OF_PREVIOUS_DAY = 'END_OF_PREVIOUS_DAY';
+    case START_OF_MONTH = 'START_OF_MONTH';
+    case START_OF_PREVIOUS_MONTH = 'START_OF_PREVIOUS_MONTH';
+    case END_OF_MONTH = 'END_OF_MONTH';
+    case END_OF_PREVIOUS_MONTH = 'END_OF_PREVIOUS_MONTH';
+    case START_OF_YEAR = 'START_OF_YEAR';
+    case START_OF_PREVIOUS_YEAR = 'START_OF_PREVIOUS_YEAR';
+    case END_OF_YEAR = 'END_OF_YEAR';
+    case END_OF_PREVIOUS_YEAR = 'END_OF_PREVIOUS_YEAR';
+}
diff --git a/src/Dto/Search/Query/Facet/AbsoluteDateRangeFacet.php b/src/Dto/Search/Query/Facet/AbsoluteDateRangeFacet.php
@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Atoolo\Search\Dto\Search\Query\Facet;
+
+use DateInterval;
+use DateTime;
+
+class AbsoluteDateRangeFacet extends Facet
+{
+    /**
+     * @param string[] $excludeFilter
+     */
+    public function __construct(
+        string $key,
+        public readonly DateTime $from,
+        public readonly DateTime $to,
+        public readonly ?DateInterval $gap,
+        array $excludeFilter = []
+    ) {
+        parent::__construct(
+            $key,
+            $excludeFilter
+        );
+    }
+}
diff --git a/src/Dto/Search/Query/Facet/CategoryFacet.php b/src/Dto/Search/Query/Facet/CategoryFacet.php
@@ -11,15 +11,15 @@ class CategoryFacet extends FacetField
 {
     /**
      * @param string[] $categories
+     * @param string[] $excludeFilter
      */
     public function __construct(
         string $key,
         array $categories,
-        ?string $excludeFilter = null
+        array $excludeFilter = []
     ) {
         parent::__construct(
             $key,
-            'sp_category_path',
             $categories,
             $excludeFilter
         );

diff --git a/src/Dto/Search/Query/Facet/ContentSectionTypeFacet.php b/src/Dto/Search/Query/Facet/ContentSectionTypeFacet.php
@@ -11,15 +11,15 @@ class ContentSectionTypeFacet extends FacetField
 {
     /**
      * @param string[] $contentSectionTypes
+     * @param string[] $excludeFilter
      */
     public function __construct(
         string $key,
         array $contentSectionTypes,
-        ?string $excludeFilter = null
+        array $excludeFilter = []
     ) {
         parent::__construct(
             $key,
-            'sp_contenttype',
             $contentSectionTypes,
             $excludeFilter
         );

diff --git a/src/Dto/Search/Query/Facet/Facet.php b/src/Dto/Search/Query/Facet/Facet.php
@@ -9,9 +9,12 @@
  */
 abstract class Facet
 {
+    /**
+     * @param string[] $excludeFilter
+     */
     public function __construct(
         public readonly string $key,
-        public readonly ?string $excludeFilter = null
+        public readonly array $excludeFilter = []
     ) {
     }
 }
diff --git a/src/Dto/Search/Query/Facet/FacetField.php b/src/Dto/Search/Query/Facet/FacetField.php
@@ -11,12 +11,12 @@ class FacetField extends Facet
 {
     /**
      * @param string[] $terms
+     * @param string[] $excludeFilter
      */
     public function __construct(
         string $key,
-        public readonly string $field,
         public readonly array $terms,
-        ?string $excludeFilter = null
+        array $excludeFilter = []
     ) {
         parent::__construct($key, $excludeFilter);
     }

diff --git a/src/Dto/Search/Query/Facet/FacetMultiQuery.php b/src/Dto/Search/Query/Facet/FacetMultiQuery.php
@@ -11,12 +11,12 @@ class FacetMultiQuery extends Facet
 {
     /**
      * @param FacetQuery[] $queries
-     * @param string|null $excludeFilter
+     * @param string[] $excludeFilter
      */
     public function __construct(
         string $key,
         public readonly array $queries,
-        ?string $excludeFilter = null
+        array $excludeFilter = []
     ) {
         parent::__construct($key, $excludeFilter);
     }

diff --git a/src/Dto/Search/Query/Facet/FacetQuery.php b/src/Dto/Search/Query/Facet/FacetQuery.php
@@ -9,10 +9,13 @@
  */
 class FacetQuery extends Facet
 {
+    /**
+     * @param string[] $excludeFilter
+     */
     public function __construct(
         string $key,
         public readonly string $query,
-        ?string $excludeFilter = null
+        array $excludeFilter = []
     ) {
         parent::__construct($key, $excludeFilter);
     }

diff --git a/src/Dto/Search/Query/Facet/GroupFacet.php b/src/Dto/Search/Query/Facet/GroupFacet.php
@@ -11,15 +11,15 @@ class GroupFacet extends FacetField
 {
     /**
      * @param string[] $groups
+     * @param string[] $excludeFilter
      */
     public function __construct(
         string $key,
         public readonly array $groups,
-        ?string $excludeFilter = null
+        array $excludeFilter = []
     ) {
         parent::__construct(
             $key,
-            'sp_group_path',
             $groups,
             $excludeFilter
         );

diff --git a/src/Dto/Search/Query/Facet/ObjectTypeFacet.php b/src/Dto/Search/Query/Facet/ObjectTypeFacet.php
@@ -11,15 +11,15 @@ class ObjectTypeFacet extends FacetField
 {
     /**
      * @param string[] $objectTypes
+     * @param string[] $excludeFilter
      */
     public function __construct(
         string $key,
         public readonly array $objectTypes,
-        ?string $excludeFilter = null
+        array $excludeFilter = []
     ) {
         parent::__construct(
             $key,
-            'sp_objecttype',
             $objectTypes,
             $excludeFilter
         );

diff --git a/src/Dto/Search/Query/Facet/RelativeDateRangeFacet.php b/src/Dto/Search/Query/Facet/RelativeDateRangeFacet.php
@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Atoolo\Search\Dto\Search\Query\Facet;
+
+use Atoolo\Search\Dto\Search\Query\DateRangeRound;
+use DateInterval;
+
+class RelativeDateRangeFacet extends Facet
+{
+    /**
+     * @param string[] $excludeFilter
+     */
+    public function __construct(
+        string $key,
+        public readonly ?\DateTime $base,
+        public readonly ?DateInterval $before,
+        public readonly ?DateInterval $after,
+        public readonly ?DateInterval $gap,
+        public readonly ?DateRangeRound $roundStart,
+        public readonly ?DateRangeRound $roundEnd,
+        array $excludeFilter = []
+    ) {
+        parent::__construct(
+            $key,
+            $excludeFilter
+        );
+    }
+}
diff --git a/src/Dto/Search/Query/Facet/SiteFacet.php b/src/Dto/Search/Query/Facet/SiteFacet.php
@@ -11,15 +11,15 @@ class SiteFacet extends FacetField
 {
     /**
      * @param string[] $sites
+     * @param string[] $excludeFilter
      */
     public function __construct(
         string $key,
         public readonly array $sites,
-        ?string $excludeFilter = null
+        array $excludeFilter = []
     ) {
         parent::__construct(
             $key,
-            'sp_site',
             $sites,
             $excludeFilter
         );

diff --git a/src/Dto/Search/Query/Filter/AbsoluteDateRangeFilter.php b/src/Dto/Search/Query/Filter/AbsoluteDateRangeFilter.php
@@ -5,6 +5,7 @@
 namespace Atoolo\Search\Dto\Search\Query\Filter;
 
 use DateTime;
+use InvalidArgumentException;
 
 class AbsoluteDateRangeFilter extends Filter
 {
@@ -17,6 +18,11 @@ public function __construct(
             $key,
             $key !== null ? [$key] : []
         );
+        if ($this->from === null && $this->to === null) {
+            throw new InvalidArgumentException(
+                'At least `from` or `to` must be specified'
+            );
+        }
     }
 
     public function getQuery(): string

diff --git a/src/Dto/Search/Query/Filter/RelativeDateRangeFilter.php b/src/Dto/Search/Query/Filter/RelativeDateRangeFilter.php
@@ -4,15 +4,19 @@
 
 namespace Atoolo\Search\Dto\Search\Query\Filter;
 
+use Atoolo\Search\Dto\Search\Query\DateRangeRound;
 use DateInterval;
+use DateTime;
 use InvalidArgumentException;
 
 class RelativeDateRangeFilter extends Filter
 {
     public function __construct(
-        private readonly ?\DateTime $base,
+        private readonly ?DateTime $base,
         private readonly ?DateInterval $before,
         private readonly ?DateInterval $after,
+        private readonly ?DateRangeRound $roundStart,
+        private readonly ?DateRangeRound $roundEnd,
         ?string $key = null
     ) {
         parent::__construct(
@@ -29,22 +33,38 @@ public function getQuery(): string
     private function toSolrDateRage(): string
     {
         if ($this->before === null) {
-            $from = $this->getBaseInSolrSyntax() . "/DAY";
+            $from = $this->roundStart($this->getBaseInSolrSyntax());
         } else {
-            $from = $this->toSolrIntervalSyntax($this->before, '-') .
-                '/DAY';
+            $from = $this->roundStart(
+                $this->toSolrIntervalSyntax($this->before, '-')
+            );
         }
 
         if ($this->after === null) {
-            $to = $this->getBaseInSolrSyntax() . "/DAY+1DAY-1SECOND";
+            $to = $this->roundEnd($this->getBaseInSolrSyntax());
         } else {
-            $to = $this->toSolrIntervalSyntax($this->after, '+') .
-                "/DAY+1DAY-1SECOND";
+            $to = $this->roundEnd(
+                $this->toSolrIntervalSyntax($this->after, '+')
+            );
         }
 
         return '[' . $from . ' TO ' . $to . ']';
     }
 
+    private function roundStart(string $start): string
+    {
+        return $start . $this->toSolrRound(
+            $this->roundStart ?? DateRangeRound::START_OF_DAY
+        );
+    }
+
+    private function roundEnd(string $start): string
+    {
+        return $start . $this->toSolrRound(
+            $this->roundEnd ?? DateRangeRound::END_OF_DAY
+        );
+    }
+
     private function getBaseInSolrSyntax(): string
     {
         if ($this->base === null) {
@@ -88,4 +108,44 @@ private function toSolrIntervalSyntax(
 
         return $interval;
     }
+
+    private function toSolrRound(DateRangeRound $round): string
+    {
+        if ($round === DateRangeRound::START_OF_DAY) {
+            return '/DAY';
+        }
+        if ($round === DateRangeRound::START_OF_PREVIOUS_DAY) {
+            return '/DAY-1DAY';
+        }
+        if ($round === DateRangeRound::END_OF_DAY) {
+            return '/DAY+1DAY-1SECOND';
+        }
+        if ($round === DateRangeRound::END_OF_PREVIOUS_DAY) {
+            return '/DAY-1SECOND';
+        }
+        if ($round === DateRangeRound::START_OF_MONTH) {
+            return '/MONTH';
+        }
+        if ($round === DateRangeRound::START_OF_PREVIOUS_MONTH) {
+            return '/MONTH-1MONTH';
+        }
+        if ($round === DateRangeRound::END_OF_MONTH) {
+            return '/MONTH+1MONTH-1SECOND';
+        }
+        if ($round === DateRangeRound::END_OF_PREVIOUS_MONTH) {
+            return '/MONTH-1SECOND';
+        }
+        if ($round === DateRangeRound::START_OF_YEAR) {
+            return '/YEAR';
+        }
+        if ($round === DateRangeRound::START_OF_PREVIOUS_YEAR) {
+            return '/YEAR-1YEAR';
+        }
+        if ($round === DateRangeRound::END_OF_YEAR) {
+            return '/YEAR+1YEAR-1SECOND';
+        }
+        if ($round === DateRangeRound::END_OF_PREVIOUS_YEAR) {
+            return '/YEAR-1SECOND';
+        }
+    }
 }
diff --git a/src/Dto/Search/Query/SearchQuery.php b/src/Dto/Search/Query/SearchQuery.php
@@ -7,6 +7,7 @@
 use Atoolo\Search\Dto\Search\Query\Facet\Facet;
 use Atoolo\Search\Dto\Search\Query\Filter\Filter;
 use Atoolo\Search\Dto\Search\Query\Sort\Criteria;
+use DateTimeZone;
 
 /**
  * @codeCoverageIgnore
@@ -28,7 +29,8 @@ public function __construct(
         public readonly array $sort,
         public readonly array $filter,
         public readonly array $facets,
-        public readonly QueryOperator $defaultQueryOperator
+        public readonly QueryOperator $defaultQueryOperator,
+        public readonly ?DateTimeZone $timeZone
     ) {
     }
 }