made all values array-like

Author: transistive

src/Contracts/CypherContainerInterface.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Laudis Neo4j package.
+ *
+ * (c) Laudis technologies <http://laudis.tech>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Laudis\Neo4j\Contracts;
+
+use ArrayAccess;
+use IteratorAggregate;
+use JsonSerializable;
+
+/**
+ * @template TKey
+ * @template TValue
+ *
+ * @template-extends ArrayAccess<TKey, TValue>
+ * @template-extends IteratorAggregate<TKey, TValue>
+ */
+interface CypherContainerInterface extends JsonSerializable, ArrayAccess, IteratorAggregate
+{
+}

src/Types/AbstractCypherContainer.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Laudis Neo4j package.
+ *
+ * (c) Laudis technologies <http://laudis.tech>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Laudis\Neo4j\Types;
+
+use BadMethodCallException;
+use function get_class;
+use InvalidArgumentException;
+use Laudis\Neo4j\Contracts\CypherContainerInterface;
+use function sprintf;
+
+/**
+ * @implements CypherContainerInterface<string, CypherContainerInterface|scalar|null>
+ */
+abstract class AbstractCypherContainer implements CypherContainerInterface
+{
+    public function jsonSerialize()
+    {
+        $tbr = [];
+
+        foreach ($this as $key => $value) {
+            $tbr[$key] = $value;
+        }
+
+        return $tbr;
+    }
+
+    /**
+     * @psalm-suppress UnusedVariable
+     */
+    public function offsetExists($offset): bool
+    {
+        foreach ($this as $key => $value) {
+            if ($key === $offset) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    public function offsetGet($offset)
+    {
+        foreach ($this as $key => $value) {
+            if ($key === $offset) {
+                return $value;
+            }
+        }
+
+        throw new InvalidArgumentException("Offset: $offset does not exists for class: ".static::class);
+    }
+
+    public function offsetSet($offset, $value): void
+    {
+        throw new BadMethodCallException(sprintf('%s is immutable', get_class($this)));
+    }
+
+    public function offsetUnset($offset): void
+    {
+        throw new BadMethodCallException(sprintf('%s is immutable', get_class($this)));
+    }
+}

src/Types/Cartesian3DPoint.php

@@ -13,10 +13,9 @@
 
 namespace Laudis\Neo4j\Types;
 
-use JsonSerializable;
 use Laudis\Neo4j\Contracts\PointInterface;
 
-final class Cartesian3DPoint implements PointInterface, JsonSerializable
+final class Cartesian3DPoint extends AbstractCypherContainer implements PointInterface
 {
     private float $z;
     private float $x;
@@ -62,14 +61,12 @@ public function getSrid(): int
         return $this->srid;
     }
 
-    public function jsonSerialize()
+    public function getIterator()
     {
-        return [
-            'x' => $this->getX(),
-            'y' => $this->getY(),
-            'z' => $this->getZ(),
-            'crs' => $this->getCrs(),
-            'srid' => $this->getSrid(),
-        ];
+        yield 'x' => $this->getX();
+        yield 'y' => $this->getY();
+        yield 'z' => $this->getZ();
+        yield 'crs' => $this->getCrs();
+        yield 'srid' => $this->getSrid();
     }
 }

src/Types/CartesianPoint.php

@@ -13,10 +13,9 @@
 
 namespace Laudis\Neo4j\Types;
 
-use JsonSerializable;
 use Laudis\Neo4j\Contracts\PointInterface;
 
-final class CartesianPoint implements PointInterface, JsonSerializable
+final class CartesianPoint extends AbstractCypherContainer implements PointInterface
 {
     private float $x;
     private float $y;
@@ -55,13 +54,11 @@ public function getSrid(): int
         return $this->srid;
     }
 
-    public function jsonSerialize()
+    public function getIterator()
     {
-        return [
-            'x' => $this->getX(),
-            'y' => $this->getY(),
-            'crs' => $this->getCrs(),
-            'srid' => $this->getSrid(),
-        ];
+        yield 'x' => $this->getX();
+        yield 'y' => $this->getY();
+        yield 'crs' => $this->getCrs();
+        yield 'srid' => $this->getSrid();
     }
 }

src/Types/CypherList.php

@@ -13,21 +13,17 @@
 
 namespace Laudis\Neo4j\Types;
 
-use ArrayAccess;
 use BadMethodCallException;
 use Ds\Vector;
-use Generator;
-use IteratorAggregate;
-use JsonSerializable;
+use Laudis\Neo4j\Contracts\CypherContainerInterface;
 use Traversable;
 
 /**
  * @template T
  *
- * @implements IteratorAggregate<T>
- * @implements ArrayAccess<int, T>
+ * @implements CypherContainerInterface<int, T>
  */
-final class CypherList implements IteratorAggregate, ArrayAccess, JsonSerializable
+final class CypherList implements CypherContainerInterface
 {
     /** @var Vector<T> */
     private Vector $vector;
@@ -66,11 +62,9 @@ public function toArray(): array
         return $this->vector->toArray();
     }
 
-    /**
-     * @return Generator<T>|Traversable<T>
-     */
     public function getIterator()
     {
+        /** @var Traversable<int, T> */
         return $this->vector->getIterator();
     }
 

src/Types/CypherMap.php

@@ -13,24 +13,21 @@
 
 namespace Laudis\Neo4j\Types;
 
-use ArrayAccess;
 use BadMethodCallException;
 use Ds\Map;
 use Ds\Pair;
 use Ds\Sequence;
 use Ds\Set;
-use IteratorAggregate;
-use JsonSerializable;
+use Laudis\Neo4j\Contracts\CypherContainerInterface;
 use OutOfBoundsException;
 use Traversable;
 
 /**
  * @template T
  *
- * @implements ArrayAccess<string, T>
- * @implements IteratorAggregate<T>
+ * @implements CypherContainerInterface<string, T>
  */
-final class CypherMap implements ArrayAccess, IteratorAggregate, JsonSerializable
+final class CypherMap implements CypherContainerInterface
 {
     /** @var Map<string, T> */
     private Map $map;
@@ -69,8 +66,9 @@ public function toArray(): array
         return $this->map->toArray();
     }
 
-    public function getIterator(): Traversable
+    public function getIterator()
     {
+        /** @var Traversable<string, T> */
         return $this->map->getIterator();
     }
 

src/Types/Date.php

@@ -15,9 +15,8 @@
 
 use DateTimeImmutable;
 use Exception;
-use JsonSerializable;
 
-final class Date implements JsonSerializable
+final class Date extends AbstractCypherContainer
 {
     private int $days;
 
@@ -39,8 +38,8 @@ public function toDateTime(): DateTimeImmutable
         return (new DateTimeImmutable('@0'))->modify(sprintf('+%s days', $this->days));
     }
 
-    public function jsonSerialize()
+    public function getIterator()
     {
-        return ['days' => $this->days];
+        yield 'days' => $this->days;
     }
 }

src/Types/DateTime.php

@@ -16,11 +16,10 @@
 use DateTimeImmutable;
 use DateTimeZone;
 use Exception;
-use JsonSerializable;
 use Laudis\Neo4j\Exception\TimezoneOffsetException;
 use function sprintf;
 
-final class DateTime implements JsonSerializable
+final class DateTime extends AbstractCypherContainer
 {
     private int $seconds;
     private int $nanoseconds;
@@ -67,12 +66,10 @@ public function toDateTime(): DateTimeImmutable
         throw new TimezoneOffsetException($message);
     }
 
-    public function jsonSerialize()
+    public function getIterator()
     {
-        return [
-            'seconds' => $this->seconds,
-            'nanoseconds' => $this->nanoseconds,
-            'tzOffsetSeconds' => $this->tzOffsetSeconds,
-        ];
+        yield 'seconds' => $this->seconds;
+        yield 'nanoseconds' => $this->nanoseconds;
+        yield 'tzOffsetSeconds' => $this->tzOffsetSeconds;
     }
 }

src/Types/Duration.php

@@ -13,11 +13,12 @@
 
 namespace Laudis\Neo4j\Types;
 
+use ArrayIterator;
 use DateInterval;
 use Exception;
-use JsonSerializable;
+use Traversable;
 
-final class Duration implements JsonSerializable
+final class Duration extends AbstractCypherContainer
 {
     private int $months;
     private int $days;
@@ -60,13 +61,11 @@ public function toDateInterval(): DateInterval
         return new DateInterval(sprintf('P%dM%dDT%dS', $this->months, $this->days, $this->seconds));
     }
 
-    public function jsonSerialize()
+    public function getIterator()
     {
-        return [
-            'months' => $this->months,
-            'days' => $this->days,
-            'seconds' => $this->seconds,
-            'nanoseconds' => $this->nanoseconds,
-        ];
+        yield 'months' => $this->months;
+        yield 'days' => $this->days;
+        yield 'seconds' => $this->seconds;
+        yield 'nanoseconds' => $this->nanoseconds;
     }
 }

src/Types/LocalDateTime.php

@@ -15,10 +15,9 @@
 
 use DateTimeImmutable;
 use Exception;
-use JsonSerializable;
 use function sprintf;
 
-final class LocalDateTime implements JsonSerializable
+final class LocalDateTime extends AbstractCypherContainer
 {
     private int $seconds;
     private int $nanoseconds;
@@ -48,8 +47,9 @@ public function toDateTime(): DateTimeImmutable
                     ->modify(sprintf('+%s microseconds', $this->nanoseconds / 1000));
     }
 
-    public function jsonSerialize()
+    public function getIterator()
     {
-        return ['seconds' => $this->seconds, 'nanoseconds' => $this->nanoseconds];
+        yield 'seconds' => $this->seconds;
+        yield 'nanoseconds' => $this->nanoseconds;
     }
 }