Drafting general approach of query filters, moving Filter / Compound Filter into new namespace & adding valid filter operators

Author: mechelon

src/Query/CompoundFilter.php src/Query/Filter/CompoundFilter.phpsrc/Query/CompoundFilter.php renamed to src/Query/Filter/CompoundFilter.php

@@ -1,8 +1,9 @@
 <?php
 
-namespace FiveamCode\LaravelNotionApi\Query;
+namespace FiveamCode\LaravelNotionApi\Query\Filter;
 
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
+use FiveamCode\LaravelNotionApi\Query\QueryHelper;
 
 /**
  * Class CompoundFilter

src/Query/Filter.php src/Query/Filter/Filter.phpsrc/Query/Filter.php renamed to src/Query/Filter/Filter.php

@@ -1,7 +1,9 @@
 <?php
 
-namespace FiveamCode\LaravelNotionApi\Query;
+namespace FiveamCode\LaravelNotionApi\Query\Filter;
 
+use FiveamCode\LaravelNotionApi\Query\Filter\Operators;
+use FiveamCode\LaravelNotionApi\Query\QueryHelper;
 use Illuminate\Support\Collection;
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
 
@@ -35,8 +37,8 @@ class Filter extends QueryHelper
     public function __construct(
         string $property,
         string $filterType = null,
-        array $filterConditions = null,
-        array $filterDefinition = null
+        array  $filterConditions = null,
+        array  $filterDefinition = null
     )
     {
         parent::__construct();
@@ -53,12 +55,20 @@ public function __construct(
      * @see https://developers.notion.com/reference/post-database-query#text-filter-condition
      *
      * @param string $property
-     * @param array $filterConditions
+     * @param string $comparisonOperator
+     * @param $value
      * @return Filter
      */
-    public static function textFilter(string $property, array $filterConditions): Filter
+    public static function textFilter(string $property, string $comparisonOperator, string $value): Filter
     {
-        return new Filter($property, 'text', $filterConditions);
+        self::isValidComparisonOperatorFor('text', $comparisonOperator);
+        return new Filter($property, 'text', [$comparisonOperator => $value]);
+    }
+
+    public static function numberFilter(string $property, string $comparisonOperator, float|int|double $number): Filter
+    {
+        self::isValidComparisonOperatorFor('number', $comparisonOperator);
+        return new Filter($property, 'number', [$comparisonOperator => $number]);
     }
 
     /**
@@ -122,4 +132,13 @@ public static function filterQuery(Collection $filter): array
     }
 
 
+    private static function isValidComparisonOperatorFor($filterType, $operator)
+    {
+        $validOperators = Operators::getValidComparisonOperators($filterType);
+
+        if (!in_array($operator, $validOperators))
+            throw HandlingException::instance("Invalid comparison operator.", compact("operator"));
+    }
+
+
 }

src/Query/Filter/Operators.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace FiveamCode\LaravelNotionApi\Query\Filter;
+
+use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
+
+class Operators
+{
+    # ToDo: Make this a enum with PHP 8.1
+    const EQUALS = 'equals';
+    const DOES_NOT_EQUAL = 'does_not_equal';
+    const CONTAINS = 'contain';
+    const DOES_NOT_CONTAIN = 'does_not_contain';
+    const STARTS_WITH = 'starts_with';
+    const ENDS_WITH = 'ends_with';
+    const IS_EMPTY = 'is_empty';
+    const IS_NOT_EMPTY = 'is_not_empty';
+    const GREATER_THAN = 'greater_than';
+    const LESS_THAN = 'less_than';
+    const GREATER_THAN_OR_EQUAL_TO = 'greater_than_or_equal_to';
+    const LESS_THAN_OR_EQUAL_TO = 'less_than_or_equal_to';
+    const BEFORE = 'before';
+    const AFTER = 'after';
+    const ON_OR_BEFORE = 'on_or_before';
+    const ON_OR_AFTER = 'on_or_after';
+    const PAST_WEEK = 'past_week';
+    const PAST_MONTH = 'past_month';
+    const PAST_YEAR = 'past_year';
+    const NEXT_WEEK = 'next_week';
+    const NEXT_MONTH = 'next_month';
+    const NEXT_YEAR = 'next_year';
+
+    // TODO: Formula filter condition
+
+
+    static function getValidComparisonOperators($filterType)
+    {
+        switch ($filterType) {
+            case 'text':
+                return Operators::text();
+            case 'number':
+                return Operators::number();
+            default:
+                throw HandlingException::instance("Invalid filterType.", compact("filterType"));
+        }
+    }
+
+    private static function text()
+    {
+        return [
+            Operators::EQUALS,
+            Operators::DOES_NOT_EQUAL,
+            Operators::CONTAINS,
+            Operators::DOES_NOT_CONTAIN,
+            Operators::STARTS_WITH,
+            Operators::ENDS_WITH,
+            Operators::IS_EMPTY,
+            Operators::IS_NOT_EMPTY
+        ];
+    }
+
+    private static function number()
+    {
+        return [
+            Operators::EQUALS,
+            Operators::DOES_NOT_EQUAL,
+            Operators::GREATER_THAN,
+            Operators::LESS_THAN,
+            Operators::GREATER_THAN_OR_EQUAL_TO,
+            Operators::LESS_THAN_OR_EQUAL_TO,
+            Operators::IS_EMPTY,
+            Operators::IS_NOT_EMPTY
+        ];
+    }
+
+}