summarized result iterates over its result when available

Author: transistive

src/Databags/SummarizedResult.php

@@ -13,24 +13,31 @@
 
 namespace Laudis\Neo4j\Databags;
 
-use Laudis\Neo4j\Types\CypherList;
+use ArrayAccess;
+use BadMethodCallException;
+use Generator;
+use function is_iterable;
+use IteratorAggregate;
+use JsonSerializable;
+use function sprintf;
 
 /**
  * A result containing the values and the summary.
  *
  * @template T
  *
  * @psalm-immutable
+ *
+ * @implements ArrayAccess<string, ResultSummary|T>
  */
-final class SummarizedResult
+final class SummarizedResult implements JsonSerializable, ArrayAccess, IteratorAggregate
 {
     private ResultSummary $summary;
     /** @var T */
     private $result;
 
     /**
-     * @param T                  $result
-     * @param CypherList<string> $keys
+     * @param T $result
      */
     public function __construct($result, ResultSummary $summary)
     {
@@ -55,4 +62,45 @@ public function getSummary(): ResultSummary
     {
         return $this->summary;
     }
+
+    public function getIterator(): Generator
+    {
+        if (is_iterable($this->result)) {
+            yield from $this->result;
+        } else {
+            yield 'summary' => $this->summary;
+            yield 'result' => $this->result;
+        }
+    }
+
+    /**
+     * @return array{summary: ResultSummary, result: T}
+     */
+    public function jsonSerialize(): array
+    {
+        return [
+            'summary' => $this->summary,
+            'result' => $this->result,
+        ];
+    }
+
+    public function offsetExists($offset)
+    {
+        return array_key_exists($offset, $this->jsonSerialize());
+    }
+
+    public function offsetGet($offset)
+    {
+        return $this->jsonSerialize()[$offset];
+    }
+
+    public function offsetSet($offset, $value)
+    {
+        throw new BadMethodCallException(sprintf('%s is immutable', __CLASS__));
+    }
+
+    public function offsetUnset($offset)
+    {
+        throw new BadMethodCallException(sprintf('%s is immutable', __CLASS__));
+    }
 }