Add SRID Enum (#84)

* Add SRID Enum

* update enum definitions

* Change namespace

* Rename to Srid

* Remove doc block

Author: Riley19280

API.md

@@ -50,6 +50,17 @@ echo $geometryCollection->getGeometries()[1]->latitude; // 0
 echo $geometryCollection[1]->latitude; // 0
 ```
 
+## Available Enums
+
+Spatial reference identifiers (SRID) identify the type of coordinate system to use.
+
+An enum is provided with the following values:
+
+| Identifier         | Value | Description                                                                         |
+|--------------------|-------|-------------------------------------------------------------------------------------|
+| SRID::WGS84        | 4326  | [Geographic coordinate system](https://epsg.org/crs_4326/WGS-84.html)               |                                 
+| SRID::WEB_MERCATOR | 3857  | [Mercator coordinate system](https://epsg.org/crs_3857/WGS-84-Pseudo-Mercator.html) | 
+
 ## Available spatial scopes
 
 * [withDistance](#withDistance)

README.md

@@ -98,6 +98,7 @@ use App\Models\Place;
 use MatanYadaev\EloquentSpatial\Objects\Polygon;
 use MatanYadaev\EloquentSpatial\Objects\LineString;
 use MatanYadaev\EloquentSpatial\Objects\Point;
+use MatanYadaev\EloquentSpatial\Enums\Srid;
 
 $londonEye = Place::create([
     'name' => 'London Eye',
@@ -106,7 +107,7 @@ $londonEye = Place::create([
 
 $whiteHouse = Place::create([
     'name' => 'White House',
-    'location' => new Point(38.8976763, -77.0365298, 4326), // with SRID
+    'location' => new Point(38.8976763, -77.0365298, Srid::WGS84->value), // with SRID
 ]);
 
 $vaticanCity = Place::create([

src/Enums/Srid.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace MatanYadaev\EloquentSpatial\Enums;
+
+enum Srid: int
+{
+  case WGS84 = 4326; // https://epsg.org/crs_4326/WGS-84.html
+  case WEB_MERCATOR = 3857; //https://epsg.org/crs_3857/WGS-84-Pseudo-Mercator.html
+}

tests/GeometryCastTest.php

@@ -2,6 +2,7 @@
 
 use Illuminate\Foundation\Testing\DatabaseMigrations;
 use Illuminate\Support\Facades\DB;
+use MatanYadaev\EloquentSpatial\Enums\Srid;
 use MatanYadaev\EloquentSpatial\Objects\LineString;
 use MatanYadaev\EloquentSpatial\Objects\Point;
 use MatanYadaev\EloquentSpatial\Tests\TestModels\TestPlace;
@@ -50,8 +51,8 @@
 });
 
 it('gets original geometry field', function (): void {
-  $point = new Point(0, 180, 4326);
-  $point2 = new Point(0, 0, 4326);
+  $point = new Point(0, 180, Srid::WGS84->value);
+  $point2 = new Point(0, 0, Srid::WGS84->value);
   /** @var TestPlace $testPlace */
   $testPlace = TestPlace::factory()->create(['point' => $point]);
 

tests/Objects/GeometryCollectionTest.php

@@ -1,6 +1,7 @@
 <?php
 
 use Illuminate\Foundation\Testing\DatabaseMigrations;
+use MatanYadaev\EloquentSpatial\Enums\Srid;
 use MatanYadaev\EloquentSpatial\Objects\Geometry;
 use MatanYadaev\EloquentSpatial\Objects\GeometryCollection;
 use MatanYadaev\EloquentSpatial\Objects\LineString;
@@ -43,12 +44,12 @@
       ]),
     ]),
     new Point(0, 180),
-  ], 4326);
+  ], Srid::WGS84->value);
 
   /** @var TestPlace $testPlace */
   $testPlace = TestPlace::factory()->create(['geometry_collection' => $geometryCollection]);
 
-  expect($testPlace->geometry_collection->srid)->toBe(4326);
+  expect($testPlace->geometry_collection->srid)->toBe(Srid::WGS84->value);
 });
 
 it('creates geometry collection from JSON', function (): void {
@@ -82,9 +83,9 @@
       ]),
     ]),
     new Point(0, 180),
-  ], 4326);
+  ], Srid::WGS84->value);
 
-  $geometryCollectionFromJson = GeometryCollection::fromJson('{"type":"GeometryCollection","geometries":[{"type":"Polygon","coordinates":[[[180,0],[179,1],[178,2],[177,3],[180,0]]]},{"type":"Point","coordinates":[180,0]}]}', 4326);
+  $geometryCollectionFromJson = GeometryCollection::fromJson('{"type":"GeometryCollection","geometries":[{"type":"Polygon","coordinates":[[[180,0],[179,1],[178,2],[177,3],[180,0]]]},{"type":"Point","coordinates":[180,0]}]}', Srid::WGS84->value);
 
   expect($geometryCollectionFromJson)->toEqual($geometryCollection);
 });
@@ -179,9 +180,9 @@
       ]),
     ]),
     new Point(0, 180),
-  ], 4326);
+  ], Srid::WGS84->value);
 
-  $geometryCollectionFromWkt = GeometryCollection::fromWkt('GEOMETRYCOLLECTION(POLYGON((180 0, 179 1, 178 2, 177 3, 180 0)), POINT(180 0))', 4326);
+  $geometryCollectionFromWkt = GeometryCollection::fromWkt('GEOMETRYCOLLECTION(POLYGON((180 0, 179 1, 178 2, 177 3, 180 0)), POINT(180 0))', Srid::WGS84->value);
 
   expect($geometryCollectionFromWkt)->toEqual($geometryCollection);
 });
@@ -237,7 +238,7 @@
       ]),
     ]),
     new Point(0, 180),
-  ], 4326);
+  ], Srid::WGS84->value);
 
   $geometryCollectionFromWkb = GeometryCollection::fromWkb($geometryCollection->toWkb());
 

tests/Objects/GeometryTest.php

@@ -3,6 +3,7 @@
 use Illuminate\Database\QueryException;
 use Illuminate\Support\Facades\DB;
 use MatanYadaev\EloquentSpatial\AxisOrder;
+use MatanYadaev\EloquentSpatial\Enums\Srid;
 use MatanYadaev\EloquentSpatial\Objects\Geometry;
 use MatanYadaev\EloquentSpatial\Objects\LineString;
 use MatanYadaev\EloquentSpatial\Objects\Point;
@@ -18,36 +19,36 @@
 
 it('throws exception when generating geometry with invalid latitude', function (): void {
   expect(function (): void {
-    $point = (new Point(91, 0, 4326));
+    $point = (new Point(91, 0, Srid::WGS84->value));
     TestPlace::factory()->create(['point' => $point]);
   })->toThrow(QueryException::class);
 })->skip(fn () => ! (new AxisOrder)->supported(DB::connection()));
 
 it('throws exception when generating geometry with invalid latitude - without axis-order', function (): void {
   expect(function (): void {
-    $point = (new Point(91, 0, 4326));
+    $point = (new Point(91, 0, Srid::WGS84->value));
     TestPlace::factory()->create(['point' => $point]);
 
     TestPlace::query()
-      ->withDistanceSphere('point', new Point(1, 1, 4326))
+      ->withDistanceSphere('point', new Point(1, 1, Srid::WGS84->value))
       ->firstOrFail();
   })->toThrow(QueryException::class);
 })->skip(fn () => (new AxisOrder)->supported(DB::connection()));
 
 it('throws exception when generating geometry with invalid longitude', function (): void {
   expect(function (): void {
-    $point = (new Point(0, 181, 4326));
+    $point = (new Point(0, 181, Srid::WGS84->value));
     TestPlace::factory()->create(['point' => $point]);
   })->toThrow(QueryException::class);
 })->skip(fn () => ! (new AxisOrder)->supported(DB::connection()));
 
 it('throws exception when generating geometry with invalid longitude - without axis-order', function (): void {
   expect(function (): void {
-    $point = (new Point(0, 181, 4326));
+    $point = (new Point(0, 181, Srid::WGS84->value));
     TestPlace::factory()->create(['point' => $point]);
 
     TestPlace::query()
-      ->withDistanceSphere('point', new Point(1, 1, 4326))
+      ->withDistanceSphere('point', new Point(1, 1, Srid::WGS84->value))
       ->firstOrFail();
   })->toThrow(QueryException::class);
 })->skip(fn () => (new AxisOrder)->supported(DB::connection()));
@@ -81,7 +82,7 @@
 });
 
 it('creates an SQL expression from a geometry', function (): void {
-  $point = new Point(0, 180, 4326);
+  $point = new Point(0, 180, Srid::WGS84->value);
 
   $expression = $point->toSqlExpression(DB::connection());
 
@@ -91,7 +92,7 @@
 })->skip(fn () => ! (new AxisOrder)->supported(DB::connection()));
 
 it('creates an SQL expression from a geometry - without axis-order', function (): void {
-  $point = new Point(0, 180, 4326);
+  $point = new Point(0, 180, Srid::WGS84->value);
 
   $expression = $point->toSqlExpression(DB::connection());
 

tests/Objects/LineStringTest.php

@@ -1,6 +1,7 @@
 <?php
 
 use Illuminate\Foundation\Testing\DatabaseMigrations;
+use MatanYadaev\EloquentSpatial\Enums\Srid;
 use MatanYadaev\EloquentSpatial\Objects\Geometry;
 use MatanYadaev\EloquentSpatial\Objects\LineString;
 use MatanYadaev\EloquentSpatial\Objects\Point;
@@ -26,12 +27,12 @@
   $lineString = new LineString([
     new Point(0, 180),
     new Point(1, 179),
-  ], 4326);
+  ], Srid::WGS84->value);
 
   /** @var TestPlace $testPlace */
   $testPlace = TestPlace::factory()->create(['line_string' => $lineString]);
 
-  expect($testPlace->line_string->srid)->toBe(4326);
+  expect($testPlace->line_string->srid)->toBe(Srid::WGS84->value);
 });
 
 it('creates line string from JSON', function (): void {
@@ -49,9 +50,9 @@
   $lineString = new LineString([
     new Point(0, 180),
     new Point(1, 179),
-  ], 4326);
+  ], Srid::WGS84->value);
 
-  $lineStringFromJson = LineString::fromJson('{"type":"LineString","coordinates":[[180,0],[179,1]]}', 4326);
+  $lineStringFromJson = LineString::fromJson('{"type":"LineString","coordinates":[[180,0],[179,1]]}', Srid::WGS84->value);
 
   expect($lineStringFromJson)->toEqual($lineString);
 });
@@ -95,9 +96,9 @@
   $lineString = new LineString([
     new Point(0, 180),
     new Point(1, 179),
-  ], 4326);
+  ], Srid::WGS84->value);
 
-  $lineStringFromWkt = LineString::fromWkt('LINESTRING(180 0, 179 1)', 4326);
+  $lineStringFromWkt = LineString::fromWkt('LINESTRING(180 0, 179 1)', Srid::WGS84->value);
 
   expect($lineStringFromWkt)->toEqual($lineString);
 });
@@ -129,7 +130,7 @@
   $lineString = new LineString([
     new Point(0, 180),
     new Point(1, 179),
-  ], 4326);
+  ], Srid::WGS84->value);
 
   $lineStringFromWkb = LineString::fromWkb($lineString->toWkb());
 

tests/Objects/MultiLineStringTest.php

@@ -1,6 +1,7 @@
 <?php
 
 use Illuminate\Foundation\Testing\DatabaseMigrations;
+use MatanYadaev\EloquentSpatial\Enums\Srid;
 use MatanYadaev\EloquentSpatial\Objects\Geometry;
 use MatanYadaev\EloquentSpatial\Objects\LineString;
 use MatanYadaev\EloquentSpatial\Objects\MultiLineString;
@@ -30,12 +31,12 @@
       new Point(0, 180),
       new Point(1, 179),
     ]),
-  ], 4326);
+  ], Srid::WGS84->value);
 
   /** @var TestPlace $testPlace */
   $testPlace = TestPlace::factory()->create(['multi_line_string' => $multiLineString]);
 
-  expect($testPlace->multi_line_string->srid)->toBe(4326);
+  expect($testPlace->multi_line_string->srid)->toBe(Srid::WGS84->value);
 });
 
 it('creates multi line string from JSON', function (): void {
@@ -57,9 +58,9 @@
       new Point(0, 180),
       new Point(1, 179),
     ]),
-  ], 4326);
+  ], Srid::WGS84->value);
 
-  $multiLineStringFromJson = MultiLineString::fromJson('{"type":"MultiLineString","coordinates":[[[180,0],[179,1]]]}', 4326);
+  $multiLineStringFromJson = MultiLineString::fromJson('{"type":"MultiLineString","coordinates":[[[180,0],[179,1]]]}', Srid::WGS84->value);
 
   expect($multiLineStringFromJson)->toEqual($multiLineString);
 });
@@ -111,9 +112,9 @@
       new Point(0, 180),
       new Point(1, 179),
     ]),
-  ], 4326);
+  ], Srid::WGS84->value);
 
-  $multiLineStringFromWkt = MultiLineString::fromWkt('MULTILINESTRING((180 0, 179 1))', 4326);
+  $multiLineStringFromWkt = MultiLineString::fromWkt('MULTILINESTRING((180 0, 179 1))', Srid::WGS84->value);
 
   expect($multiLineStringFromWkt)->toEqual($multiLineString);
 });
@@ -151,7 +152,7 @@
       new Point(0, 180),
       new Point(1, 179),
     ]),
-  ], 4326);
+  ], Srid::WGS84->value);
 
   $multiLineStringFromWkb = MultiLineString::fromWkb($multiLineString->toWkb());
 

tests/Objects/MultiPointTest.php

@@ -1,6 +1,7 @@
 <?php
 
 use Illuminate\Foundation\Testing\DatabaseMigrations;
+use MatanYadaev\EloquentSpatial\Enums\Srid;
 use MatanYadaev\EloquentSpatial\Objects\Geometry;
 use MatanYadaev\EloquentSpatial\Objects\MultiPoint;
 use MatanYadaev\EloquentSpatial\Objects\Point;
@@ -24,12 +25,12 @@
 it('creates a model record with multi point with SRID', function (): void {
   $multiPoint = new MultiPoint([
     new Point(0, 180),
-  ], 4326);
+  ], Srid::WGS84->value);
 
   /** @var TestPlace $testPlace */
   $testPlace = TestPlace::factory()->create(['multi_point' => $multiPoint]);
 
-  expect($testPlace->multi_point->srid)->toBe(4326);
+  expect($testPlace->multi_point->srid)->toBe(Srid::WGS84->value);
 });
 
 it('creates multi point from JSON', function (): void {
@@ -45,9 +46,9 @@
 it('creates multi point with SRID from JSON', function (): void {
   $multiPoint = new MultiPoint([
     new Point(0, 180),
-  ], 4326);
+  ], Srid::WGS84->value);
 
-  $multiPointFromJson = MultiPoint::fromJson('{"type":"MultiPoint","coordinates":[[180,0]]}', 4326);
+  $multiPointFromJson = MultiPoint::fromJson('{"type":"MultiPoint","coordinates":[[180,0]]}', Srid::WGS84->value);
 
   expect($multiPointFromJson)->toEqual($multiPoint);
 });
@@ -87,9 +88,9 @@
 it('creates multi point with SRID from WKT', function (): void {
   $multiPoint = new MultiPoint([
     new Point(0, 180),
-  ], 4326);
+  ], Srid::WGS84->value);
 
-  $multiPointFromWkt = MultiPoint::fromWkt('MULTIPOINT(180 0)', 4326);
+  $multiPointFromWkt = MultiPoint::fromWkt('MULTIPOINT(180 0)', Srid::WGS84->value);
 
   expect($multiPointFromWkt)->toEqual($multiPoint);
 });
@@ -118,7 +119,7 @@
 it('creates multi point with SRID from WKB', function (): void {
   $multiPoint = new MultiPoint([
     new Point(0, 180),
-  ], 4326);
+  ], Srid::WGS84->value);
 
   $multiPointFromWkb = MultiPoint::fromWkb($multiPoint->toWkb());