types for php8.1

tupywebteam · tupywebteam · commit 245a161defc2 · 2022-04-12T13:00:22.000-03:00
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,6 @@
 vendor/
 composer.lock
 _db/
-build/
+build/
+.phpunit.result.cache
+_db*
diff --git a/src/Types/Factory.php b/src/Types/Factory.php
@@ -4,42 +4,42 @@
 
 class Factory implements \GeoIO\Factory
 {
-    public function createPoint($dimension, array $coordinates, $srid = null)
+    public function createPoint($dimension, array $coordinates, $srid = null): Point
     {
         return new Point($coordinates['y'], $coordinates['x']);
     }
 
-    public function createLineString($dimension, array $points, $srid = null)
+    public function createLineString($dimension, array $points, $srid = null): LineString
     {
         return new LineString($points);
     }
 
-    public function createLinearRing($dimension, array $points, $srid = null)
+    public function createLinearRing($dimension, array $points, $srid = null): LineString
     {
         return new LineString($points);
     }
 
-    public function createPolygon($dimension, array $lineStrings, $srid = null)
+    public function createPolygon($dimension, array $lineStrings, $srid = null): Polygon
     {
         return new Polygon($lineStrings);
     }
 
-    public function createMultiPoint($dimension, array $points, $srid = null)
+    public function createMultiPoint($dimension, array $points, $srid = null): MultiPoint
     {
         return new MultiPoint($points);
     }
 
-    public function createMultiLineString($dimension, array $lineStrings, $srid = null)
+    public function createMultiLineString($dimension, array $lineStrings, $srid = null): MultiLineString
     {
         return new MultiLineString($lineStrings);
     }
 
-    public function createMultiPolygon($dimension, array $polygons, $srid = null)
+    public function createMultiPolygon($dimension, array $polygons, $srid = null): MultiPolygon
     {
         return new MultiPolygon($polygons);
     }
 
-    public function createGeometryCollection($dimension, array $geometries, $srid = null)
+    public function createGeometryCollection($dimension, array $geometries, $srid = null): GeometryCollection
     {
         return new GeometryCollection($geometries);
     }
diff --git a/src/Types/Geometry.php b/src/Types/Geometry.php
@@ -27,7 +27,7 @@ public static function getWKTArgument($value)
         return substr($value, $left + 1, $right - $left - 1);
     }
 
-    public static function getWKTClass($value)
+    public static function getWKTClass($value): string
     {
         $left = strpos($value, '(');
         $type = trim(substr($value, 0, $left));
diff --git a/src/Types/GeometryCollection.php b/src/Types/GeometryCollection.php
@@ -47,7 +47,7 @@ public function __construct(array $geometries)
         $this->items = $geometries;
     }
 
-    public function getGeometries()
+    public function getGeometries(): array
     {
         return $this->items;
     }
@@ -79,17 +79,17 @@ public static function fromString($wktArgument)
         }, $geometry_strings));
     }
 
-    public function toArray()
+    public function toArray(): array
     {
         return $this->items;
     }
 
-    public function getIterator()
+    public function getIterator(): ArrayIterator
     {
         return new ArrayIterator($this->items);
     }
 
-    public function offsetExists($offset)
+    public function offsetExists($offset): bool
     {
         return isset($this->items[$offset]);
     }
@@ -115,7 +115,7 @@ public function offsetUnset($offset)
         unset($this->items[$offset]);
     }
 
-    public function count()
+    public function count(): int
     {
         return count($this->items);
     }
@@ -141,9 +141,9 @@ public static function fromJson($geoJson)
     /**
      * Convert to GeoJson GeometryCollection that is jsonable to GeoJSON.
      *
-     * @return \GeoJson\Geometry\GeometryCollection
+     * @return array|\GeoJson\Geometry\GeometryCollection
      */
-    public function jsonSerialize()
+    public function jsonSerialize(): mixed
     {
         $geometries = [];
         foreach ($this->items as $geometry) {
@@ -158,7 +158,7 @@ public function jsonSerialize()
      *
      * @param array $items
      */
-    protected function validateItems(array $items)
+    protected function validateItems(array $items): void
     {
         $this->validateItemCount($items);
 
@@ -174,7 +174,7 @@ protected function validateItems(array $items)
      *
      * @see $minimumCollectionItems
      */
-    protected function validateItemCount(array $items)
+    protected function validateItemCount(array $items): void
     {
         if (count($items) < $this->minimumCollectionItems) {
             $entries = $this->minimumCollectionItems === 1 ? 'entry' : 'entries';
@@ -195,7 +195,7 @@ protected function validateItemCount(array $items)
      *
      * @see $collectionItemType
      */
-    protected function validateItemType($item)
+    protected function validateItemType($item): void
     {
         if (!$item instanceof $this->collectionItemType) {
             throw new InvalidArgumentException(sprintf(
diff --git a/src/Types/LineString.php b/src/Types/LineString.php
@@ -15,7 +15,7 @@ class LineString extends PointCollection
      */
     protected $minimumCollectionItems = 2;
 
-    public function toWKT()
+    public function toWKT(): string
     {
         return sprintf('LINESTRING(%s)', $this->toPairList());
     }
@@ -63,9 +63,9 @@ public static function fromJson($geoJson)
     /**
      * Convert to GeoJson LineString that is jsonable to GeoJSON.
      *
-     * @return \GeoJson\Geometry\LineString
+     * @return array|\GeoJson\Geometry\LineString
      */
-    public function jsonSerialize()
+    public function jsonSerialize(): mixed
     {
         $points = [];
         foreach ($this->items as $point) {
diff --git a/src/Types/MultiLineString.php b/src/Types/MultiLineString.php
@@ -83,7 +83,7 @@ public static function fromJson($geoJson)
      *
      * @return \GeoJson\Geometry\MultiLineString
      */
-    public function jsonSerialize()
+    public function jsonSerialize(): mixed
     {
         $lineStrings = [];
 
diff --git a/src/Types/MultiPoint.php b/src/Types/MultiPoint.php
@@ -69,7 +69,7 @@ public static function fromJson($geoJson)
      *
      * @return \GeoJson\Geometry\MultiPoint
      */
-    public function jsonSerialize()
+    public function jsonSerialize(): mixed
     {
         $points = [];
         foreach ($this->items as $point) {
diff --git a/src/Types/MultiPolygon.php b/src/Types/MultiPolygon.php
@@ -127,7 +127,7 @@ public static function fromJson($geoJson)
      *
      * @return \GeoJson\Geometry\MultiPolygon
      */
-    public function jsonSerialize()
+    public function jsonSerialize(): mixed
     {
         $polygons = [];
         foreach ($this->items as $polygon) {
diff --git a/src/Types/PointCollection.php b/src/Types/PointCollection.php
@@ -14,7 +14,7 @@ abstract class PointCollection extends GeometryCollection
      */
     protected $collectionItemType = Point::class;
 
-    public function toPairList()
+    public function toPairList(): string
     {
         return implode(',', array_map(function (Point $point) {
             return $point->toPair();
@@ -31,7 +31,7 @@ public function offsetSet($offset, $value)
     /**
      * @return array|\Grimzy\LaravelMysqlSpatial\Types\Point[]
      */
-    public function getPoints()
+    public function getPoints(): array
     {
         return $this->items;
     }
diff --git a/src/Types/Polygon.php b/src/Types/Polygon.php
@@ -40,7 +40,7 @@ public static function fromJson($geoJson)
      *
      * @return \GeoJson\Geometry\Polygon
      */
-    public function jsonSerialize()
+    public function jsonSerialize(): mixed
     {
         $linearRings = [];
         foreach ($this->items as $lineString) {
diff --git a/tests/Integration/SpatialTest.php b/tests/Integration/SpatialTest.php
@@ -98,7 +98,7 @@ public function createApplication()
      *
      * @return void
      */
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 
@@ -113,7 +113,7 @@ public function setUp()
 //        });
     }
 
-    public function tearDown()
+    public function tearDown(): void
     {
         $this->onMigrations(function ($migrationClass) {
             (new $migrationClass())->down();
diff --git a/tests/Unit/BaseTestCase.php b/tests/Unit/BaseTestCase.php
@@ -4,7 +4,7 @@
 
 abstract class BaseTestCase extends TestCase
 {
-    public function tearDown()
+    public function tearDown(): void
     {
         Mockery::close();
     }
diff --git a/tests/Unit/Eloquent/BuilderTest.php b/tests/Unit/Eloquent/BuilderTest.php
@@ -20,7 +20,7 @@ class BuilderTest extends BaseTestCase
     protected $builder;
     protected $queryBuilder;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         $connection = Mockery::mock(MysqlConnection::class)->makePartial();
         $grammar = Mockery::mock(MySqlGrammar::class)->makePartial();
diff --git a/tests/Unit/Eloquent/SpatialTraitTest.php b/tests/Unit/Eloquent/SpatialTraitTest.php
@@ -21,13 +21,13 @@ class SpatialTraitTest extends BaseTestCase
      */
     protected $queries;
 
-    public function setUp()
+    public function setUp(): void
     {
         $this->model = new TestModel();
         $this->queries = &$this->model->getConnection()->getPdo()->queries;
     }
 
-    public function tearDown()
+    public function tearDown(): void
     {
         $this->model->getConnection()->getPdo()->resetQueries();
     }
diff --git a/tests/Unit/MysqlConnectionTest.php b/tests/Unit/MysqlConnectionTest.php
@@ -9,7 +9,7 @@ class MysqlConnectionTest extends TestCase
 {
     private $mysqlConnection;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         $mysqlConfig = ['driver' => 'mysql', 'prefix' => 'prefix', 'database' => 'database', 'name' => 'foo'];
         $this->mysqlConnection = new MysqlConnection(new PDOStub(), 'database', 'prefix', $mysqlConfig);
diff --git a/tests/Unit/Schema/BlueprintTest.php b/tests/Unit/Schema/BlueprintTest.php
@@ -11,7 +11,7 @@ class BlueprintTest extends BaseTestCase
 {
     protected $blueprint;
 
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 
diff --git a/tests/Unit/Types/LineStringTest.php b/tests/Unit/Types/LineStringTest.php
@@ -7,7 +7,7 @@ class LineStringTest extends BaseTestCase
 {
     private $points;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         $this->points = [new Point(0, 0), new Point(1, 1), new Point(2, 2)];
     }
diff --git a/tests/Unit/Types/PolygonTest.php b/tests/Unit/Types/PolygonTest.php
@@ -8,7 +8,7 @@ class PolygonTest extends BaseTestCase
 {
     private $polygon;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         $collection = new LineString(
             [

Original file line number	Diff line number	Diff line change
`@@ -4,42 +4,42 @@`
`4`	`4`
`5`	`5`	`class Factory implements \GeoIO\Factory`
`6`	`6`	`{`
`7`		`- public function createPoint($dimension, array $coordinates, $srid = null)`
	`7`	`+ public function createPoint($dimension, array $coordinates, $srid = null): Point`
`8`	`8`	`{`
`9`	`9`	`return new Point($coordinates['y'], $coordinates['x']);`
`10`	`10`	`}`
`11`	`11`
`12`		`- public function createLineString($dimension, array $points, $srid = null)`
	`12`	`+ public function createLineString($dimension, array $points, $srid = null): LineString`
`13`	`13`	`{`
`14`	`14`	`return new LineString($points);`
`15`	`15`	`}`
`16`	`16`
`17`		`- public function createLinearRing($dimension, array $points, $srid = null)`
	`17`	`+ public function createLinearRing($dimension, array $points, $srid = null): LineString`
`18`	`18`	`{`
`19`	`19`	`return new LineString($points);`
`20`	`20`	`}`
`21`	`21`
`22`		`- public function createPolygon($dimension, array $lineStrings, $srid = null)`
	`22`	`+ public function createPolygon($dimension, array $lineStrings, $srid = null): Polygon`
`23`	`23`	`{`
`24`	`24`	`return new Polygon($lineStrings);`
`25`	`25`	`}`
`26`	`26`
`27`		`- public function createMultiPoint($dimension, array $points, $srid = null)`
	`27`	`+ public function createMultiPoint($dimension, array $points, $srid = null): MultiPoint`
`28`	`28`	`{`
`29`	`29`	`return new MultiPoint($points);`
`30`	`30`	`}`
`31`	`31`
`32`		`- public function createMultiLineString($dimension, array $lineStrings, $srid = null)`
	`32`	`+ public function createMultiLineString($dimension, array $lineStrings, $srid = null): MultiLineString`
`33`	`33`	`{`
`34`	`34`	`return new MultiLineString($lineStrings);`
`35`	`35`	`}`
`36`	`36`
`37`		`- public function createMultiPolygon($dimension, array $polygons, $srid = null)`
	`37`	`+ public function createMultiPolygon($dimension, array $polygons, $srid = null): MultiPolygon`
`38`	`38`	`{`
`39`	`39`	`return new MultiPolygon($polygons);`
`40`	`40`	`}`
`41`	`41`
`42`		`- public function createGeometryCollection($dimension, array $geometries, $srid = null)`
	`42`	`+ public function createGeometryCollection($dimension, array $geometries, $srid = null): GeometryCollection`
`43`	`43`	`{`
`44`	`44`	`return new GeometryCollection($geometries);`
`45`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ public static function getWKTArgument($value)`
`27`	`27`	`return substr($value, $left + 1, $right - $left - 1);`
`28`	`28`	`}`
`29`	`29`
`30`		`- public static function getWKTClass($value)`
	`30`	`+ public static function getWKTClass($value): string`
`31`	`31`	`{`
`32`	`32`	`$left = strpos($value, '(');`
`33`	`33`	`$type = trim(substr($value, 0, $left));`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public function __construct(array $geometries)`
`47`	`47`	`$this->items = $geometries;`
`48`	`48`	`}`
`49`	`49`
`50`		`- public function getGeometries()`
	`50`	`+ public function getGeometries(): array`
`51`	`51`	`{`
`52`	`52`	`return $this->items;`
`53`	`53`	`}`
`@@ -79,17 +79,17 @@ public static function fromString($wktArgument)`
`79`	`79`	`}, $geometry_strings));`
`80`	`80`	`}`
`81`	`81`
`82`		`- public function toArray()`
	`82`	`+ public function toArray(): array`
`83`	`83`	`{`
`84`	`84`	`return $this->items;`
`85`	`85`	`}`
`86`	`86`
`87`		`- public function getIterator()`
	`87`	`+ public function getIterator(): ArrayIterator`
`88`	`88`	`{`
`89`	`89`	`return new ArrayIterator($this->items);`
`90`	`90`	`}`
`91`	`91`
`92`		`- public function offsetExists($offset)`
	`92`	`+ public function offsetExists($offset): bool`
`93`	`93`	`{`
`94`	`94`	`return isset($this->items[$offset]);`
`95`	`95`	`}`
`@@ -115,7 +115,7 @@ public function offsetUnset($offset)`
`115`	`115`	`unset($this->items[$offset]);`
`116`	`116`	`}`
`117`	`117`
`118`		`- public function count()`
	`118`	`+ public function count(): int`
`119`	`119`	`{`
`120`	`120`	`return count($this->items);`
`121`	`121`	`}`
`@@ -141,9 +141,9 @@ public static function fromJson($geoJson)`
`141`	`141`	`/**`
`142`	`142`	`* Convert to GeoJson GeometryCollection that is jsonable to GeoJSON.`
`143`	`143`	`*`
`144`		`- * @return \GeoJson\Geometry\GeometryCollection`
	`144`	`+ * @return array\|\GeoJson\Geometry\GeometryCollection`
`145`	`145`	`*/`
`146`		`- public function jsonSerialize()`
	`146`	`+ public function jsonSerialize(): mixed`
`147`	`147`	`{`
`148`	`148`	`$geometries = [];`
`149`	`149`	`foreach ($this->items as $geometry) {`
`@@ -158,7 +158,7 @@ public function jsonSerialize()`
`158`	`158`	`*`
`159`	`159`	`* @param array $items`
`160`	`160`	`*/`
`161`		`- protected function validateItems(array $items)`
	`161`	`+ protected function validateItems(array $items): void`
`162`	`162`	`{`
`163`	`163`	`$this->validateItemCount($items);`
`164`	`164`
`@@ -174,7 +174,7 @@ protected function validateItems(array $items)`
`174`	`174`	`*`
`175`	`175`	`* @see $minimumCollectionItems`
`176`	`176`	`*/`
`177`		`- protected function validateItemCount(array $items)`
	`177`	`+ protected function validateItemCount(array $items): void`
`178`	`178`	`{`
`179`	`179`	`if (count($items) < $this->minimumCollectionItems) {`
`180`	`180`	`$entries = $this->minimumCollectionItems === 1 ? 'entry' : 'entries';`
`@@ -195,7 +195,7 @@ protected function validateItemCount(array $items)`
`195`	`195`	`*`
`196`	`196`	`* @see $collectionItemType`
`197`	`197`	`*/`
`198`		`- protected function validateItemType($item)`
	`198`	`+ protected function validateItemType($item): void`
`199`	`199`	`{`
`200`	`200`	`if (!$item instanceof $this->collectionItemType) {`
`201`	`201`	`throw new InvalidArgumentException(sprintf(`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ class LineString extends PointCollection`
`15`	`15`	`*/`
`16`	`16`	`protected $minimumCollectionItems = 2;`
`17`	`17`
`18`		`- public function toWKT()`
	`18`	`+ public function toWKT(): string`
`19`	`19`	`{`
`20`	`20`	`return sprintf('LINESTRING(%s)', $this->toPairList());`
`21`	`21`	`}`
`@@ -63,9 +63,9 @@ public static function fromJson($geoJson)`
`63`	`63`	`/**`
`64`	`64`	`* Convert to GeoJson LineString that is jsonable to GeoJSON.`
`65`	`65`	`*`
`66`		`- * @return \GeoJson\Geometry\LineString`
	`66`	`+ * @return array\|\GeoJson\Geometry\LineString`
`67`	`67`	`*/`
`68`		`- public function jsonSerialize()`
	`68`	`+ public function jsonSerialize(): mixed`
`69`	`69`	`{`
`70`	`70`	`$points = [];`
`71`	`71`	`foreach ($this->items as $point) {`
Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ public static function fromJson($geoJson)`
`83`	`83`	`*`
`84`	`84`	`* @return \GeoJson\Geometry\MultiLineString`
`85`	`85`	`*/`
`86`		`- public function jsonSerialize()`
	`86`	`+ public function jsonSerialize(): mixed`
`87`	`87`	`{`
`88`	`88`	`$lineStrings = [];`
`89`	`89`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ public static function fromJson($geoJson)`
`69`	`69`	`*`
`70`	`70`	`* @return \GeoJson\Geometry\MultiPoint`
`71`	`71`	`*/`
`72`		`- public function jsonSerialize()`
	`72`	`+ public function jsonSerialize(): mixed`
`73`	`73`	`{`
`74`	`74`	`$points = [];`
`75`	`75`	`foreach ($this->items as $point) {`
Original file line number	Diff line number	Diff line change
`@@ -127,7 +127,7 @@ public static function fromJson($geoJson)`
`127`	`127`	`*`
`128`	`128`	`* @return \GeoJson\Geometry\MultiPolygon`
`129`	`129`	`*/`
`130`		`- public function jsonSerialize()`
	`130`	`+ public function jsonSerialize(): mixed`
`131`	`131`	`{`
`132`	`132`	`$polygons = [];`
`133`	`133`	`foreach ($this->items as $polygon) {`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ abstract class PointCollection extends GeometryCollection`
`14`	`14`	`*/`
`15`	`15`	`protected $collectionItemType = Point::class;`
`16`	`16`
`17`		`- public function toPairList()`
	`17`	`+ public function toPairList(): string`
`18`	`18`	`{`
`19`	`19`	`return implode(',', array_map(function (Point $point) {`
`20`	`20`	`return $point->toPair();`
`@@ -31,7 +31,7 @@ public function offsetSet($offset, $value)`
`31`	`31`	`/**`
`32`	`32`	`* @return array\|\Grimzy\LaravelMysqlSpatial\Types\Point[]`
`33`	`33`	`*/`
`34`		`- public function getPoints()`
	`34`	`+ public function getPoints(): array`
`35`	`35`	`{`
`36`	`36`	`return $this->items;`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public static function fromJson($geoJson)`
`40`	`40`	`*`
`41`	`41`	`* @return \GeoJson\Geometry\Polygon`
`42`	`42`	`*/`
`43`		`- public function jsonSerialize()`
	`43`	`+ public function jsonSerialize(): mixed`
`44`	`44`	`{`
`45`	`45`	`$linearRings = [];`
`46`	`46`	`foreach ($this->items as $lineString) {`