Merge pull request #19 from grimzy/feature/collection

ArrayAccess, IteratorAggregate, Arrayable, Jsonable on Collections

Author: grimzy

src/Types/Geometry.php

@@ -4,8 +4,9 @@
 
 use GeoIO\WKB\Parser\Parser;
 use Grimzy\LaravelMysqlSpatial\Exceptions\UnknownWKTTypeException;
+use Illuminate\Contracts\Support\Jsonable;
 
-abstract class Geometry implements GeometryInterface, \JsonSerializable
+abstract class Geometry implements GeometryInterface, Jsonable, \JsonSerializable
 {
     protected static $wkb_types = [
         1 => Point::class,
@@ -69,4 +70,9 @@ public static function fromWKT($wkt)
 
         return static::fromString($wktArgument);
     }
+
+    public function toJson($options = 0)
+    {
+        return json_encode($this, $options);
+    }
 }

src/Types/GeometryCollection.php

@@ -2,15 +2,21 @@
 
 namespace Grimzy\LaravelMysqlSpatial\Types;
 
+use ArrayAccess;
+use ArrayIterator;
 use Countable;
+use Illuminate\Contracts\Support\Arrayable;
 use InvalidArgumentException;
+use IteratorAggregate;
 
-class GeometryCollection extends Geometry implements Countable
+class GeometryCollection extends Geometry implements IteratorAggregate, ArrayAccess, Arrayable, Countable
 {
     /**
+     * The items contained in the spatial collection.
+     *
      * @var GeometryInterface[]
      */
-    protected $geometries = [];
+    protected $items = [];
 
     /**
      * @param GeometryInterface[] $geometries
@@ -27,12 +33,12 @@ public function __construct(array $geometries)
             throw new InvalidArgumentException('$geometries must be an array of Geometry objects');
         }
 
-        $this->geometries = $geometries;
+        $this->items = $geometries;
     }
 
     public function getGeometries()
     {
-        return $this->geometries;
+        return $this->items;
     }
 
     public function toWKT()
@@ -44,7 +50,7 @@ public function __toString()
     {
         return implode(',', array_map(function (GeometryInterface $geometry) {
             return $geometry->toWKT();
-        }, $this->geometries));
+        }, $this->items));
     }
 
     public static function fromString($wktArgument)
@@ -58,9 +64,47 @@ public static function fromString($wktArgument)
         }, $geometry_strings));
     }
 
+    public function toArray()
+    {
+        return $this->items;
+    }
+
+    public function getIterator()
+    {
+        return new ArrayIterator($this->items);
+    }
+
+    public function offsetExists($offset)
+    {
+        return isset($this->items[$offset]);
+    }
+
+    public function offsetGet($offset)
+    {
+        return $this->offsetExists($offset) ? $this->items[$offset] : null;
+    }
+
+    public function offsetSet($offset, $value)
+    {
+        if (!($value instanceof GeometryInterface)) {
+            throw new InvalidArgumentException('$value must be an instance of GeometryInterface');
+        }
+
+        if (is_null($offset)) {
+            $this->items[] = $value;
+        } else {
+            $this->items[$offset] = $value;
+        }
+    }
+
+    public function offsetUnset($offset)
+    {
+        unset($this->items[$offset]);
+    }
+
     public function count()
     {
-        return count($this->geometries);
+        return count($this->items);
     }
 
     /**
@@ -71,7 +115,7 @@ public function count()
     public function jsonSerialize()
     {
         $geometries = [];
-        foreach ($this->geometries as $geometry) {
+        foreach ($this->items as $geometry) {
             $geometries[] = $geometry->jsonSerialize();
         }
 

src/Types/LineString.php

@@ -2,7 +2,7 @@
 
 namespace Grimzy\LaravelMysqlSpatial\Types;
 
-class LineString extends PointCollection implements GeometryInterface
+class LineString extends PointCollection
 {
     public function toWKT()
     {
@@ -39,7 +39,7 @@ public function __toString()
     public function jsonSerialize()
     {
         $points = [];
-        foreach ($this->points as $point) {
+        foreach ($this->items as $point) {
             $points[] = $point->jsonSerialize();
         }
 

src/Types/MultiLineString.php

@@ -2,16 +2,10 @@
 
 namespace Grimzy\LaravelMysqlSpatial\Types;
 
-use Countable;
 use InvalidArgumentException;
 
-class MultiLineString extends Geometry implements Countable
+class MultiLineString extends GeometryCollection
 {
-    /**
-     * @var LineString[]
-     */
-    protected $linestrings = [];
-
     /**
      * @param LineString[] $linestrings
      */
@@ -29,12 +23,12 @@ public function __construct(array $linestrings)
             throw new InvalidArgumentException('$linestrings must be an array of LineString');
         }
 
-        $this->linestrings = $linestrings;
+        parent::__construct($linestrings);
     }
 
     public function getLineStrings()
     {
-        return $this->linestrings;
+        return $this->items;
     }
 
     public function toWKT()
@@ -59,9 +53,13 @@ public function __toString()
         }, $this->getLineStrings()));
     }
 
-    public function count()
+    public function offsetSet($offset, $value)
     {
-        return count($this->linestrings);
+        if (!($value instanceof LineString)) {
+            throw new InvalidArgumentException('$value must be an instance of LineString');
+        }
+
+        parent::offsetSet($offset, $value);
     }
 
     /**
@@ -73,7 +71,7 @@ public function jsonSerialize()
     {
         $linestrings = [];
 
-        foreach ($this->linestrings as $linestring) {
+        foreach ($this->items as $linestring) {
             $linestrings[] = $linestring->jsonSerialize();
         }
 

src/Types/MultiPoint.php

@@ -2,7 +2,7 @@
 
 namespace Grimzy\LaravelMysqlSpatial\Types;
 
-class MultiPoint extends PointCollection implements GeometryInterface, \JsonSerializable
+class MultiPoint extends PointCollection
 {
     public function toWKT()
     {
@@ -32,7 +32,7 @@ public function __toString()
     {
         return implode(',', array_map(function (Point $point) {
             return sprintf('(%s)', $point->toPair());
-        }, $this->points));
+        }, $this->items));
     }
 
     /**
@@ -43,7 +43,7 @@ public function __toString()
     public function jsonSerialize()
     {
         $points = [];
-        foreach ($this->points as $point) {
+        foreach ($this->items as $point) {
             $points[] = $point->jsonSerialize();
         }
 

src/Types/MultiPolygon.php

@@ -2,16 +2,10 @@
 
 namespace Grimzy\LaravelMysqlSpatial\Types;
 
-use Countable;
 use InvalidArgumentException;
 
-class MultiPolygon extends Geometry implements Countable
+class MultiPolygon extends GeometryCollection
 {
-    /**
-     * @var Polygon[]
-     */
-    protected $polygons;
-
     /**
      * @param Polygon[] $polygons
      */
@@ -24,7 +18,7 @@ public function __construct(array $polygons)
         if (count($polygons) !== count($validated)) {
             throw new InvalidArgumentException('$polygons must be an array of Polygon');
         }
-        $this->polygons = $polygons;
+        parent::__construct($polygons);
     }
 
     public function toWKT()
@@ -36,7 +30,7 @@ public function __toString()
     {
         return implode(',', array_map(function (Polygon $polygon) {
             return sprintf('(%s)', (string) $polygon);
-        }, $this->polygons));
+        }, $this->items));
     }
 
     public static function fromString($wktArgument)
@@ -49,30 +43,14 @@ public static function fromString($wktArgument)
         }, $polygons));
     }
 
-    /**
-     * (PHP 5 &gt;= 5.1.0)<br/>
-     * Count elements of an object.
-     *
-     * @link http://php.net/manual/en/countable.count.php
-     *
-     * @return int The custom count as an integer.
-     *             </p>
-     *             <p>
-     *             The return value is cast to an integer.
-     */
-    public function count()
-    {
-        return count($this->polygons);
-    }
-
     /**
      * Get the polygons that make up this MultiPolygon.
      *
      * @return array|Polygon[]
      */
     public function getPolygons()
     {
-        return $this->polygons;
+        return $this->items;
     }
 
     /**
@@ -110,6 +88,15 @@ protected static function assembleParts(array $parts)
         return $polygons;
     }
 
+    public function offsetSet($offset, $value)
+    {
+        if (!($value instanceof Polygon)) {
+            throw new InvalidArgumentException('$value must be an instance of Polygon');
+        }
+
+        parent::offsetSet($offset, $value);
+    }
+
     /**
      * Convert to GeoJson MultiPolygon that is jsonable to GeoJSON.
      *
@@ -118,7 +105,7 @@ protected static function assembleParts(array $parts)
     public function jsonSerialize()
     {
         $polygons = [];
-        foreach ($this->polygons as $polygon) {
+        foreach ($this->items as $polygon) {
             $polygons[] = $polygon->jsonSerialize();
         }