Adds shape type constants to GeoShapeQuery

ongr-io · Dec 16, 2020 · be2d341 · be2d341
1 parent b4c3c89
commit be2d341
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/src/Query/Geo/GeoShapeQuery.php b/src/Query/Geo/GeoShapeQuery.php
@@ -28,6 +28,21 @@ class GeoShapeQuery implements BuilderInterface
     const WITHIN = 'within';
     const CONTAINS = 'contains';
 
+    /*
+     * Available shape types for addShape() $type param.
+     *
+     * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/geo-shape.html#input-structure
+     */
+    const SHAPE_TYPE_POINT = 'point';
+    const SHAPE_TYPE_LINESTRING = 'linestring';
+    const SHAPE_TYPE_POLYGON = 'polygon';
+    const SHAPE_TYPE_MULTIPOINT = 'multipoint';
+    const SHAPE_TYPE_MULTILINESTRING = 'multilinestring';
+    const SHAPE_TYPE_MULTIPOLYGON = 'multipolygon';
+    const SHAPE_TYPE_GEOMETRYCOLLECTION = 'geometrycollection';
+    const SHAPE_TYPE_ENVELOPE = 'envelope';
+    const SHAPE_TYPE_CIRCLE = 'circle';
+
     /**
      * @var array
      */

diff --git a/tests/Unit/Query/Geo/GeoShapeQueryTest.php b/tests/Unit/Query/Geo/GeoShapeQueryTest.php
@@ -21,13 +21,18 @@ class GeoShapeQueryTest extends \PHPUnit\Framework\TestCase
     public function testToArray()
     {
         $filter = new GeoShapeQuery(['param1' => 'value1']);
-        $filter->addShape('location', 'envelope', [[13, 53], [14, 52]], GeoShapeQuery::INTERSECTS);
+        $filter->addShape(
+            'location',
+            GeoShapeQuery::SHAPE_TYPE_ENVELOPE,
+            [[13, 53], [14, 52]],
+            GeoShapeQuery::INTERSECTS
+        );
 
         $expected = [
             'geo_shape' => [
                 'location' => [
                     'shape' => [
-                        'type' => 'envelope',
+                        'type' => GeoShapeQuery::SHAPE_TYPE_ENVELOPE,
                         'coordinates' => [[13, 53], [14, 52]],
                     ],
                     'relation' => 'intersects'