Added btw operator that translates to BETWEEN

* Closes #9
hschimpf · Aug 1, 2024 · 0fb48e9 · 0fb48e9
1 parent e64d189
commit 0fb48e9
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -50,13 +50,14 @@ The available operators are:
 - `gt`: Translates to a `field_name > "value"` filter.
 - `gte`: Translates to a `field_name >= "value"` filter.
 - `in`: Translates to a `field_name IN ("value1", "value2", ...)` filter.
+- `btw`: Translates to a `field_name BETWEEN "value1" AND "value2"` filter.
 
 Operators are also grouped by field type:
 
 - `string`: Translates to the operators `eq`, `ne` and `has`.
-- `numeric`: Translates to the operators `eq`, `ne`, `lt`, `lte`, `gt`, `gte` and `in`.
+- `numeric`: Translates to the operators `eq`, `ne`, `lt`, `lte`, `gt`, `gte`, `in`, and `btw`.
 - `boolean`: Translates to the operators `eq` and `ne`.
-- `date`: Translates to the operators `eq`, `ne`, `lt`, `lte`, `gt`, and `gte`.
+- `date`: Translates to the operators `eq`, `ne`, `lt`, `lte`, `gt`, `gte`, and `btw`.
 
 #### Example implementation
 
@@ -70,7 +71,7 @@ class CountryFilters extends \HDSSolutions\Laravel\API\ResourceFilters {
     protected array $allowed_columns = [
         'name'      => 'string',
         'code'      => 'string',
-        'something' => [ 'gt', 'lt' ],
+        'size_km2'  => [ 'gt', 'lt', 'btw' ],
     ];
 
 }
@@ -93,7 +94,7 @@ class CountryFilters extends \HDSSolutions\Laravel\API\ResourceFilters {
     protected array $allowed_columns = [
         'name'          => 'string',
         'code'          => 'string',
-        'something'     => [ 'gt', 'lt' ],
+        'size_km2'      => [ 'gt', 'lt', 'btw' ],
         'regions_count' => 'number',
     ];
 
@@ -119,6 +120,37 @@ class CountryFilters extends \HDSSolutions\Laravel\API\ResourceFilters {
             {
                 "id": 123,
                 "name": "Country name",
+                "size_km2": 125000,
+                ...
+            },
+            { ... },
+            { ... },
+            { ... },
+            ...
+        ],
+        "links": {
+            ...
+        }
+        "meta": {
+            ...
+        }
+    }
+    ```
+
+- Filtering by country size:
+
+    ```http request
+    GET https://localhost/api/countries?size_km2[btw]=100000,500000
+    Accept: application/json
+    ```
+    Example response:
+    ```json5
+    {
+        "data": [
+            {
+                "id": 123,
+                "name": "Country name",
+                "size_km2": 125000,
                 ...
             },
             { ... },
@@ -148,6 +180,7 @@ class CountryFilters extends \HDSSolutions\Laravel\API\ResourceFilters {
             {
                 "id": 123,
                 "name": "Country name",
+                "size_km2": 125000,
                 ...
             },
             { ... },

diff --git a/src/ResourceFilters.php b/src/ResourceFilters.php
@@ -26,6 +26,7 @@ abstract class ResourceFilters {
         'ne'  => '!=',
         'has' => 'like',
         'in'  => 'in',
+        'btw' => 'between',
     ];
 
     /**
@@ -35,9 +36,9 @@ abstract class ResourceFilters {
      */
     private const TYPES = [
         'string'  => [ 'eq', 'ne', 'has' ],
-        'numeric' => [ 'eq', 'ne', 'lt', 'lte', 'gt', 'gte', 'in' ],
+        'numeric' => [ 'eq', 'ne', 'lt', 'lte', 'gt', 'gte', 'in', 'btw' ],
         'boolean' => [ 'eq', 'ne' ],
-        'date'    => [ 'eq', 'ne', 'lt', 'lte', 'gt', 'gte' ],
+        'date'    => [ 'eq', 'ne', 'lt', 'lte', 'gt', 'gte', 'btw' ],
     ];
 
     /**
@@ -123,13 +124,21 @@ private function addQueryFilter(Builder $query, string $column, string $operator
                 $value,
             ));
 
-        // capture special case for WHERE IN
+        // special case for WHERE IN
         } elseif ($operator === 'in') {
             $query->whereIn(
                 column: $this->column_mappings[ $column ] ?? $column,
                 values: $this->parseValue($operator, $value),
             );
 
+        // special case for BETWEEN
+        } elseif ($operator === 'btw') {
+            $query->whereBetween(
+                column: $this->column_mappings[ $column ] ?? $column,
+                values: $this->parseValue($operator, $value),
+            );
+
+        // fallback to default filtering
         } else {
             $query->where(
                 column:   $this->column_mappings[ $column ] ?? $column,
@@ -152,6 +161,17 @@ private function parseValue(string $operator, $value) {
             return explode(',', $value);
         }
 
+        if ($operator === 'btw') {
+            if (count($value = explode(',', $value)) !== 2) {
+                throw new RuntimeException(
+                    message: 'Invalid value count for "btw" filter',
+                    code: Response::HTTP_BAD_REQUEST,
+                );
+            }
+
+            return $value;
+        }
+
         return $value;
     }