allow setting default srid

MatanYadaev · MatanYadaev · commit 43edde698892 · 2024-11-23T23:55:28.000+02:00
diff --git a/API.md b/API.md
@@ -2,19 +2,19 @@
 
 ## Available geometry classes
 
-* `Point(float $latitude, float $longitude, int|Srid $srid = 0)` - [MySQL Point](https://dev.mysql.com/doc/refman/8.0/en/gis-class-point.html)
-* `MultiPoint(Point[] | Collection<Point> $geometries, int|Srid $srid = 0)` - [MySQL MultiPoint](https://dev.mysql.com/doc/refman/8.0/en/gis-class-multipoint.html)
-* `LineString(Point[] | Collection<Point> $geometries, int|Srid $srid = 0)` - [MySQL LineString](https://dev.mysql.com/doc/refman/8.0/en/gis-class-linestring.html)
-* `MultiLineString(LineString[] | Collection<LineString> $geometries, int|Srid $srid = 0)` - [MySQL MultiLineString](https://dev.mysql.com/doc/refman/8.0/en/gis-class-multilinestring.html)
-* `Polygon(LineString[] | Collection<LineString> $geometries, int|Srid $srid = 0)` - [MySQL Polygon](https://dev.mysql.com/doc/refman/8.0/en/gis-class-polygon.html)
-* `MultiPolygon(Polygon[] | Collection<Polygon> $geometries, int|Srid $srid = 0)` - [MySQL MultiPolygon](https://dev.mysql.com/doc/refman/8.0/en/gis-class-multipolygon.html)
-* `GeometryCollection(Geometry[] | Collection<Geometry> $geometries, int|Srid $srid = 0)` - [MySQL GeometryCollection](https://dev.mysql.com/doc/refman/8.0/en/gis-class-geometrycollection.html)
+* `Point(float $latitude, float $longitude, int|Srid|null $srid = null)` - [MySQL Point](https://dev.mysql.com/doc/refman/8.0/en/gis-class-point.html)
+* `MultiPoint(Point[] | Collection<Point> $geometries, int|Srid|null $srid = null)` - [MySQL MultiPoint](https://dev.mysql.com/doc/refman/8.0/en/gis-class-multipoint.html)
+* `LineString(Point[] | Collection<Point> $geometries, int|Srid|null $srid = null)` - [MySQL LineString](https://dev.mysql.com/doc/refman/8.0/en/gis-class-linestring.html)
+* `MultiLineString(LineString[] | Collection<LineString> $geometries, int|Srid|null $srid = null)` - [MySQL MultiLineString](https://dev.mysql.com/doc/refman/8.0/en/gis-class-multilinestring.html)
+* `Polygon(LineString[] | Collection<LineString> $geometries, int|Srid|null $srid = null)` - [MySQL Polygon](https://dev.mysql.com/doc/refman/8.0/en/gis-class-polygon.html)
+* `MultiPolygon(Polygon[] | Collection<Polygon> $geometries, int|Srid|null $srid = null)` - [MySQL MultiPolygon](https://dev.mysql.com/doc/refman/8.0/en/gis-class-multipolygon.html)
+* `GeometryCollection(Geometry[] | Collection<Geometry> $geometries, int|Srid|null $srid = null)` - [MySQL GeometryCollection](https://dev.mysql.com/doc/refman/8.0/en/gis-class-geometrycollection.html)
 
 Geometry classes can be also created by these static methods:
 
-* `fromArray(array $geometry, int|Srid $srid = 0)` - Creates a geometry object from a [GeoJSON](https://en.wikipedia.org/wiki/GeoJSON) array.
-* `fromJson(string $geoJson, int|Srid $srid = 0)` - Creates a geometry object from a [GeoJSON](https://en.wikipedia.org/wiki/GeoJSON) string.
-* `fromWkt(string $wkt, int|Srid $srid = 0)` - Creates a geometry object from a [WKT](https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry).
+* `fromArray(array $geometry, int|Srid|null $srid = null)` - Creates a geometry object from a [GeoJSON](https://en.wikipedia.org/wiki/GeoJSON) array.
+* `fromJson(string $geoJson, int|Srid|null $srid = null)` - Creates a geometry object from a [GeoJSON](https://en.wikipedia.org/wiki/GeoJSON) string.
+* `fromWkt(string $wkt, int|Srid|null $srid = null)` - Creates a geometry object from a [WKT](https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry).
 * `fromWkb(string $wkb)` - Creates a geometry object from a [WKB](https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry#Well-known_binary).
 
 ## Available geometry class methods
diff --git a/README.md b/README.md
@@ -256,6 +256,25 @@ $place = Place::create([
 echo $place->coordinates->toCustomArray(); // ['longitude' => -0.1217424, 'latitude' => 51.5032973]
 ```
 
+## Set default SRID
+
+By default, the SRID is set to 0 (EPSG:0).
+You can set the default SRID for your application by setting the `SRID` constant in a service provider's `boot` method:
+
+```php
+use MatanYadaev\EloquentSpatial\Enums\Srid;
+use Illuminate\Support\ServiceProvider;
+
+class AppServiceProvider extends ServiceProvider
+{
+    public function boot(): void
+    {
+        // Set the default SRID to WGS84 (EPSG:4326)
+        EloquentSpatial::setDefaultSrid(Srid::WGS84);
+    }
+}
+```
+
 ## Development
 
 Here are some useful commands for development:
diff --git a/src/EloquentSpatial.php b/src/EloquentSpatial.php
@@ -4,6 +4,7 @@
 
 namespace MatanYadaev\EloquentSpatial;
 
+use MatanYadaev\EloquentSpatial\Enums\Srid;
 use MatanYadaev\EloquentSpatial\Objects\GeometryCollection;
 use MatanYadaev\EloquentSpatial\Objects\LineString;
 use MatanYadaev\EloquentSpatial\Objects\MultiLineString;
@@ -35,6 +36,8 @@ class EloquentSpatial
     /** @var class-string<Polygon> */
     public static string $polygon = Polygon::class;
 
+    public static int $defaultSrid = 0;
+
     /**
      * @param  class-string<GeometryCollection>  $class
      */
@@ -104,4 +107,9 @@ public static function usePolygon(string $class): string
 
         return static::$polygon;
     }
+
+    public static function setDefaultSrid(Srid|int $srid): void
+    {
+        static::$defaultSrid = $srid instanceof Srid ? $srid->value : $srid;
+    }
 }
diff --git a/src/Helper.php b/src/Helper.php
@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MatanYadaev\EloquentSpatial;
+
+use MatanYadaev\EloquentSpatial\Enums\Srid;
+
+class Helper
+{
+    public static function getSrid(Srid|int|null $srid = null): int
+    {
+        if ($srid instanceof Srid) {
+            return $srid->value;
+        }
+
+        if (is_int($srid)) {
+            return $srid;
+        }
+
+        return EloquentSpatial::$defaultSrid;
+    }
+}
diff --git a/src/Objects/Geometry.php b/src/Objects/Geometry.php
@@ -21,14 +21,15 @@
 use MatanYadaev\EloquentSpatial\Factory;
 use MatanYadaev\EloquentSpatial\GeometryCast;
 use MatanYadaev\EloquentSpatial\GeometryExpression;
+use MatanYadaev\EloquentSpatial\Helper;
 use Stringable;
 use WKB as geoPHPWkb;
 
 abstract class Geometry implements Arrayable, Castable, Jsonable, JsonSerializable, Stringable
 {
     use Macroable;
 
-    public int $srid = 0;
+    public int $srid;
 
     abstract public function toWkt(): string;
 
@@ -90,10 +91,10 @@ public static function fromWkb(string $wkb): static
     /**
      * @throws InvalidArgumentException
      */
-    public static function fromWkt(string $wkt, int|Srid $srid = 0): static
+    public static function fromWkt(string $wkt, int|Srid|null $srid = null): static
     {
         $geometry = Factory::parse($wkt);
-        $geometry->srid = $srid instanceof Srid ? $srid->value : $srid;
+        $geometry->srid = Helper::getSrid($srid);
 
         if (! ($geometry instanceof static)) {
             throw new InvalidArgumentException(
@@ -107,10 +108,10 @@ public static function fromWkt(string $wkt, int|Srid $srid = 0): static
     /**
      * @throws InvalidArgumentException
      */
-    public static function fromJson(string $geoJson, int|Srid $srid = 0): static
+    public static function fromJson(string $geoJson, int|Srid|null $srid = null): static
     {
         $geometry = Factory::parse($geoJson);
-        $geometry->srid = $srid instanceof Srid ? $srid->value : $srid;
+        $geometry->srid = Helper::getSrid($srid);
 
         if (! ($geometry instanceof static)) {
             throw new InvalidArgumentException(
@@ -126,7 +127,7 @@ public static function fromJson(string $geoJson, int|Srid $srid = 0): static
      *
      * @throws JsonException
      */
-    public static function fromArray(array $geometry, int|Srid $srid = 0): static
+    public static function fromArray(array $geometry, int|Srid|null $srid = null): static
     {
         $geoJson = json_encode($geometry, JSON_THROW_ON_ERROR);
 
diff --git a/src/Objects/GeometryCollection.php b/src/Objects/GeometryCollection.php
@@ -9,6 +9,7 @@
 use Illuminate\Support\Str;
 use InvalidArgumentException;
 use MatanYadaev\EloquentSpatial\Enums\Srid;
+use MatanYadaev\EloquentSpatial\Helper;
 
 class GeometryCollection extends Geometry implements ArrayAccess
 {
@@ -24,14 +25,14 @@ class GeometryCollection extends Geometry implements ArrayAccess
      *
      * @throws InvalidArgumentException
      */
-    public function __construct(Collection|array $geometries, int|Srid $srid = 0)
+    public function __construct(Collection|array $geometries, int|Srid|null $srid = null)
     {
         if (is_array($geometries)) {
             $geometries = collect($geometries);
         }
 
         $this->geometries = $geometries;
-        $this->srid = $srid instanceof Srid ? $srid->value : $srid;
+        $this->srid = Helper::getSrid($srid);
 
         $this->validateGeometriesType();
         $this->validateGeometriesCount();
diff --git a/src/Objects/MultiLineString.php b/src/Objects/MultiLineString.php
@@ -26,10 +26,10 @@ class MultiLineString extends GeometryCollection
      *
      * @throws InvalidArgumentException
      */
-    public function __construct(Collection|array $geometries, int|Srid $srid = 0)
+    public function __construct(Collection|array $geometries, int|Srid|null $srid = null)
     {
         // @phpstan-ignore-next-line
-        parent::__construct($geometries, $this->srid = $srid instanceof Srid ? $srid->value : $srid);
+        parent::__construct($geometries, $srid);
     }
 
     public function toWkt(): string
diff --git a/src/Objects/MultiPolygon.php b/src/Objects/MultiPolygon.php
@@ -26,10 +26,10 @@ class MultiPolygon extends GeometryCollection
      *
      * @throws InvalidArgumentException
      */
-    public function __construct(Collection|array $geometries, int|Srid $srid = 0)
+    public function __construct(Collection|array $geometries, int|Srid|null $srid = null)
     {
         // @phpstan-ignore-next-line
-        parent::__construct($geometries, $this->srid = $srid instanceof Srid ? $srid->value : $srid);
+        parent::__construct($geometries, $srid);
     }
 
     public function toWkt(): string
diff --git a/src/Objects/Point.php b/src/Objects/Point.php
@@ -5,18 +5,19 @@
 namespace MatanYadaev\EloquentSpatial\Objects;
 
 use MatanYadaev\EloquentSpatial\Enums\Srid;
+use MatanYadaev\EloquentSpatial\Helper;
 
 class Point extends Geometry
 {
     public float $latitude;
 
     public float $longitude;
 
-    public function __construct(float $latitude, float $longitude, int|Srid $srid = 0)
+    public function __construct(float $latitude, float $longitude, int|Srid|null $srid = null)
     {
         $this->latitude = $latitude;
         $this->longitude = $longitude;
-        $this->srid = $srid instanceof Srid ? $srid->value : $srid;
+        $this->srid = Helper::getSrid($srid);
     }
 
     public function toWkt(): string
diff --git a/src/Objects/PointCollection.php b/src/Objects/PointCollection.php
@@ -24,9 +24,9 @@ abstract class PointCollection extends GeometryCollection
      *
      * @throws InvalidArgumentException
      */
-    public function __construct(Collection|array $geometries, int|Srid $srid = 0)
+    public function __construct(Collection|array $geometries, int|Srid|null $srid = null)
     {
         // @phpstan-ignore-next-line
-        parent::__construct($geometries, $this->srid = $srid instanceof Srid ? $srid->value : $srid);
+        parent::__construct($geometries, $srid);
     }
 }
diff --git a/tests/Objects/GeometryCollectionTest.php b/tests/Objects/GeometryCollectionTest.php
@@ -72,7 +72,9 @@
     expect($testPlace->geometry_collection->srid)->toBe(Srid::WGS84->value);
 });
 
-it('creates geometry collection from JSON', function (): void {
+it('creates geometry collection with default 0 SRID from JSON', function (): void {
+    // Arrange
+    EloquentSpatial::setDefaultSrid(0);
     $geometryCollection = new GeometryCollection([
         new Polygon([
             new LineString([
@@ -86,9 +88,39 @@
         new Point(0, 180),
     ]);
 
+    // Act
     $geometryCollectionFromJson = GeometryCollection::fromJson('{"type":"GeometryCollection","geometries":[{"type":"Polygon","coordinates":[[[180,0],[179,1],[178,2],[177,3],[180,0]]]},{"type":"Point","coordinates":[180,0]}]}');
 
+    // Assert
     expect($geometryCollectionFromJson)->toEqual($geometryCollection);
+    expect($geometryCollectionFromJson->srid)->toBe(0);
+});
+
+it('creates geometry collection with default 4326 SRID from JSON', function (): void {
+    // Arrange
+    EloquentSpatial::setDefaultSrid(Srid::WGS84);
+    $geometryCollection = new GeometryCollection([
+        new Polygon([
+            new LineString([
+                new Point(0, 180),
+                new Point(1, 179),
+                new Point(2, 178),
+                new Point(3, 177),
+                new Point(0, 180),
+            ]),
+        ]),
+        new Point(0, 180),
+    ]);
+
+    // Act
+    $geometryCollectionFromJson = GeometryCollection::fromJson('{"type":"GeometryCollection","geometries":[{"type":"Polygon","coordinates":[[[180,0],[179,1],[178,2],[177,3],[180,0]]]},{"type":"Point","coordinates":[180,0]}]}');
+
+    // Assert
+    expect($geometryCollectionFromJson->toWkt())->toBe($geometryCollection->toWkt());
+    expect($geometryCollectionFromJson->srid)->toBe(Srid::WGS84->value);
+
+    // Cleanup
+    EloquentSpatial::setDefaultSrid(0);
 });
 
 it('creates geometry collection with SRID from JSON', function (): void {
@@ -110,7 +142,9 @@
     expect($geometryCollectionFromJson)->toEqual($geometryCollection);
 });
 
-it('creates geometry collection from array', function (): void {
+it('creates geometry collection with default 0 SRID from array', function (): void {
+    // Arrange
+    EloquentSpatial::setDefaultSrid(0);
     $geometryCollection = new GeometryCollection([
         new Polygon([
             new LineString([
@@ -124,9 +158,39 @@
         new Point(0, 180),
     ]);
 
+    // Act
     $geometryCollectionFromJson = GeometryCollection::fromArray(json_decode('{"type":"GeometryCollection","geometries":[{"type":"Polygon","coordinates":[[[180,0],[179,1],[178,2],[177,3],[180,0]]]},{"type":"Point","coordinates":[180,0]}]}', true));
 
+    // Assert
     expect($geometryCollectionFromJson)->toEqual($geometryCollection);
+    expect($geometryCollectionFromJson->srid)->toBe(0);
+});
+
+it('creates geometry collection with default 4326 SRID from array', function (): void {
+    // Arrange
+    EloquentSpatial::setDefaultSrid(Srid::WGS84);
+    $geometryCollection = new GeometryCollection([
+        new Polygon([
+            new LineString([
+                new Point(0, 180),
+                new Point(1, 179),
+                new Point(2, 178),
+                new Point(3, 177),
+                new Point(0, 180),
+            ]),
+        ]),
+        new Point(0, 180),
+    ]);
+
+    // Act
+    $geometryCollectionFromJson = GeometryCollection::fromArray(json_decode('{"type":"GeometryCollection","geometries":[{"type":"Polygon","coordinates":[[[180,0],[179,1],[178,2],[177,3],[180,0]]]},{"type":"Point","coordinates":[180,0]}]}', true));
+
+    // Assert
+    expect($geometryCollectionFromJson->toWkt())->toBe($geometryCollection->toWkt());
+    expect($geometryCollectionFromJson->srid)->toBe(Srid::WGS84->value);
+
+    // Cleanup
+    EloquentSpatial::setDefaultSrid(0);
 });
 
 it('creates geometry collection with SRID from array', function (): void {
@@ -264,7 +328,9 @@
     expect($featureCollectionJson)->toBe($expectedFeatureCollectionJson);
 });
 
-it('creates geometry collection from WKT', function (): void {
+it('creates geometry collection with default 0 SRID from WKT', function (): void {
+    // Arrange
+    EloquentSpatial::setDefaultSrid(0);
     $geometryCollection = new GeometryCollection([
         new Polygon([
             new LineString([
@@ -278,11 +344,40 @@
         new Point(0, 180),
     ]);
 
+    // Act
     $geometryCollectionFromWkt = GeometryCollection::fromWkt('GEOMETRYCOLLECTION(POLYGON((180 0, 179 1, 178 2, 177 3, 180 0)), POINT(180 0))');
 
+    // Assert
     expect($geometryCollectionFromWkt)->toEqual($geometryCollection);
 });
 
+it('creates geometry collection with default 4326 SRID from WKT', function (): void {
+    // Arrange
+    EloquentSpatial::setDefaultSrid(Srid::WGS84);
+    $geometryCollection = new GeometryCollection([
+        new Polygon([
+            new LineString([
+                new Point(0, 180),
+                new Point(1, 179),
+                new Point(2, 178),
+                new Point(3, 177),
+                new Point(0, 180),
+            ]),
+        ]),
+        new Point(0, 180),
+    ]);
+
+    // Act
+    $geometryCollectionFromWkt = GeometryCollection::fromWkt('GEOMETRYCOLLECTION(POLYGON((180 0, 179 1, 178 2, 177 3, 180 0)), POINT(180 0))');
+
+    // Assert
+    expect($geometryCollectionFromWkt->toWkt())->toBe($geometryCollection->toWkt());
+    expect($geometryCollectionFromWkt->srid)->toBe(Srid::WGS84->value);
+
+    // Cleanup
+    EloquentSpatial::setDefaultSrid(0);
+});
+
 it('creates geometry collection with SRID from WKT', function (): void {
     $geometryCollection = new GeometryCollection([
         new Polygon([
diff --git a/tests/Objects/PointTest.php b/tests/Objects/PointTest.php

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`use Illuminate\Support\Str;`
`10`	`10`	`use InvalidArgumentException;`
`11`	`11`	`use MatanYadaev\EloquentSpatial\Enums\Srid;`
	`12`	`+use MatanYadaev\EloquentSpatial\Helper;`
`12`	`13`
`13`	`14`	`class GeometryCollection extends Geometry implements ArrayAccess`
`14`	`15`	`{`
`@@ -24,14 +25,14 @@ class GeometryCollection extends Geometry implements ArrayAccess`
`24`	`25`	`*`
`25`	`26`	`* @throws InvalidArgumentException`
`26`	`27`	`*/`
`27`		`- public function __construct(Collection\|array $geometries, int\|Srid $srid = 0)`
	`28`	`+ public function __construct(Collection\|array $geometries, int\|Srid\|null $srid = null)`
`28`	`29`	`{`
`29`	`30`	`if (is_array($geometries)) {`
`30`	`31`	`$geometries = collect($geometries);`
`31`	`32`	`}`
`32`	`33`
`33`	`34`	`$this->geometries = $geometries;`
`34`		`- $this->srid = $srid instanceof Srid ? $srid->value : $srid;`
	`35`	`+ $this->srid = Helper::getSrid($srid);`
`35`	`36`
`36`	`37`	`$this->validateGeometriesType();`
`37`	`38`	`$this->validateGeometriesCount();`
Original file line number	Diff line number	Diff line change
`@@ -26,10 +26,10 @@ class MultiLineString extends GeometryCollection`
`26`	`26`	`*`
`27`	`27`	`* @throws InvalidArgumentException`
`28`	`28`	`*/`
`29`		`- public function __construct(Collection\|array $geometries, int\|Srid $srid = 0)`
	`29`	`+ public function __construct(Collection\|array $geometries, int\|Srid\|null $srid = null)`
`30`	`30`	`{`
`31`	`31`	`// @phpstan-ignore-next-line`
`32`		`- parent::__construct($geometries, $this->srid = $srid instanceof Srid ? $srid->value : $srid);`
	`32`	`+ parent::__construct($geometries, $srid);`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`public function toWkt(): string`
Original file line number	Diff line number	Diff line change
`@@ -26,10 +26,10 @@ class MultiPolygon extends GeometryCollection`
`26`	`26`	`*`
`27`	`27`	`* @throws InvalidArgumentException`
`28`	`28`	`*/`
`29`		`- public function __construct(Collection\|array $geometries, int\|Srid $srid = 0)`
	`29`	`+ public function __construct(Collection\|array $geometries, int\|Srid\|null $srid = null)`
`30`	`30`	`{`
`31`	`31`	`// @phpstan-ignore-next-line`
`32`		`- parent::__construct($geometries, $this->srid = $srid instanceof Srid ? $srid->value : $srid);`
	`32`	`+ parent::__construct($geometries, $srid);`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`public function toWkt(): string`
Original file line number	Diff line number	Diff line change
`@@ -5,18 +5,19 @@`
`5`	`5`	`namespace MatanYadaev\EloquentSpatial\Objects;`
`6`	`6`
`7`	`7`	`use MatanYadaev\EloquentSpatial\Enums\Srid;`
	`8`	`+use MatanYadaev\EloquentSpatial\Helper;`
`8`	`9`
`9`	`10`	`class Point extends Geometry`
`10`	`11`	`{`
`11`	`12`	`public float $latitude;`
`12`	`13`
`13`	`14`	`public float $longitude;`
`14`	`15`
`15`		`- public function __construct(float $latitude, float $longitude, int\|Srid $srid = 0)`
	`16`	`+ public function __construct(float $latitude, float $longitude, int\|Srid\|null $srid = null)`
`16`	`17`	`{`
`17`	`18`	`$this->latitude = $latitude;`
`18`	`19`	`$this->longitude = $longitude;`
`19`		`- $this->srid = $srid instanceof Srid ? $srid->value : $srid;`
	`20`	`+ $this->srid = Helper::getSrid($srid);`
`20`	`21`	`}`
`21`	`22`
`22`	`23`	`public function toWkt(): string`
Original file line number	Diff line number	Diff line change
`@@ -24,9 +24,9 @@ abstract class PointCollection extends GeometryCollection`
`24`	`24`	`*`
`25`	`25`	`* @throws InvalidArgumentException`
`26`	`26`	`*/`
`27`		`- public function __construct(Collection\|array $geometries, int\|Srid $srid = 0)`
	`27`	`+ public function __construct(Collection\|array $geometries, int\|Srid\|null $srid = null)`
`28`	`28`	`{`
`29`	`29`	`// @phpstan-ignore-next-line`
`30`		`- parent::__construct($geometries, $this->srid = $srid instanceof Srid ? $srid->value : $srid);`
	`30`	`+ parent::__construct($geometries, $srid);`
`31`	`31`	`}`
`32`	`32`	`}`