Merge pull request #13 from pionl/geo-bounding-box-query

Add bottomLeft / topRight settings to geo bounding box query

Author: erichard

src/Query/GeoBoundingBoxQuery.php

@@ -7,6 +7,7 @@
 use Erichard\ElasticQueryBuilder\Contracts\QueryInterface;
 use Erichard\ElasticQueryBuilder\Entities\GpsPointEntity;
 use Erichard\ElasticQueryBuilder\Features\HasField;
+use Exception;
 
 /**
  * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-bounding-box-query.html
@@ -17,26 +18,40 @@ class GeoBoundingBoxQuery implements QueryInterface
 
     public function __construct(
         string $field,
-        private GpsPointEntity $topLeft,
-        private GpsPointEntity $bottomRight
+        private GpsPointEntity|null $topLeft = null,
+        private GpsPointEntity|null $bottomRight = null,
+        private GpsPointEntity|null $topRight = null,
+        private GpsPointEntity|null $bottomLeft = null,
     ) {
         $this->field = $field;
     }
 
     public function build(): array
     {
+        $filters = array_filter([
+            'top_left' => $this->pointToArray($this->topLeft),
+            'bottom_right' => $this->pointToArray($this->bottomRight),
+            'top_right' => $this->pointToArray($this->topRight),
+            'bottom_left' => $this->pointToArray($this->bottomLeft),
+        ]);
+
+        if (count($filters) < 2) {
+            throw new Exception('GeoBoundingBoxQuery needs at least 2 sides set');
+        }
+
         return [
             'geo_bounding_box' => [
-                $this->field => [
-                    'top_left' => $this->pointToArray($this->topLeft),
-                    'bottom_right' => $this->pointToArray($this->bottomRight),
-                ],
+                $this->field => $filters,
             ],
         ];
     }
 
-    protected function pointToArray(GpsPointEntity $entity): array
+    protected function pointToArray(?GpsPointEntity $entity): ?array
     {
+        if ($entity === null) {
+            return null;
+        }
+
         return [
             'lat' => $entity->lat,
             'lon' => $entity->lon,

tests/Query/GeoBoundingBoxQueryTest.php

@@ -0,0 +1,76 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Erichard\ElasticQueryBuilder\Query;
+
+use Erichard\ElasticQueryBuilder\Entities\GpsPointEntity;
+use Erichard\ElasticQueryBuilder\Query\GeoBoundingBoxQuery;
+use PHPUnit\Framework\TestCase;
+
+class GeoBoundingBoxQueryTest extends TestCase
+{
+    public function testBuildFailsOnAllNull(): void
+    {
+        $this->expectErrorMessage('GeoBoundingBoxQuery needs at least 2 sides set');
+        (new GeoBoundingBoxQuery('test'))->build();
+    }
+
+    public function testBuildFailsOnOneFilter(): void
+    {
+        $this->expectErrorMessage('GeoBoundingBoxQuery needs at least 2 sides set');
+        (new GeoBoundingBoxQuery(field: 'test', topLeft: new GpsPointEntity(1.1, 2.1)))->build();
+    }
+
+    public function testBuildTopLeftBottomRight(): void
+    {
+        $result = (new GeoBoundingBoxQuery(
+            field: 'test',
+            topLeft: new GpsPointEntity(1.1, 2.1),
+            bottomRight: new GpsPointEntity(2.1, 3.1),
+        ))->build();
+
+        $this->assertEquals([
+            'geo_bounding_box' => [
+                'test' => [
+                    'top_left' => [
+                        'lat' => 1.1,
+                        'lon' => 2.1,
+                    ],
+                    'bottom_right' => [
+                        'lat' => 2.1,
+                        'lon' => 3.1,
+                        
+                    ],
+                    
+                ],
+            ],
+        ], $result);
+    }
+
+    public function testBuildTopRightBottomLeft(): void
+    {
+        $result = (new GeoBoundingBoxQuery(
+            field: 'test',
+            topRight: new GpsPointEntity(1.1, 2.1),
+            bottomLeft: new GpsPointEntity(2.1, 3.1),
+        ))->build();
+
+        $this->assertEquals([
+            'geo_bounding_box' => [
+                'test' => [
+                    'top_right' => [
+                        'lat' => 1.1,
+                        'lon' => 2.1,
+                    ],
+                    'bottom_left' => [
+                        'lat' => 2.1,
+                        'lon' => 3.1,
+                        
+                    ],
+                    
+                ],
+            ],
+        ], $result);
+    }
+}