Implement JsonSerializable in lazy BSON classes

Author: alcaeus

src/Model/LazyBSONArray.php

@@ -23,6 +23,7 @@
 use CallbackFilterIterator;
 use Countable;
 use IteratorAggregate;
+use JsonSerializable;
 use MongoDB\BSON\PackedArray;
 use MongoDB\Codec\CodecLibrary;
 use MongoDB\Codec\LazyBSONCodecLibrary;
@@ -37,6 +38,7 @@
 use function count;
 use function is_array;
 use function is_numeric;
+use function iterator_to_array;
 use function max;
 use function MongoDB\recursive_copy;
 use function sprintf;
@@ -54,7 +56,7 @@
  * @template-implements ArrayAccess<int, TValue>
  * @template-implements IteratorAggregate<int, TValue>
  */
-final class LazyBSONArray implements ArrayAccess, Countable, IteratorAggregate
+final class LazyBSONArray implements ArrayAccess, Countable, IteratorAggregate, JsonSerializable
 {
     /** @var PackedArray<TValue> */
     private PackedArray $bson;
@@ -184,6 +186,11 @@ function ($value, int $offset) use (&$seen) {
         );
     }
 
+    public function jsonSerialize(): array
+    {
+        return iterator_to_array($this->getIterator());
+    }
+
     /** @param mixed $offset */
     public function offsetExists($offset): bool
     {

src/Model/LazyBSONDocument.php

@@ -24,6 +24,7 @@
 use Countable;
 use Iterator;
 use IteratorAggregate;
+use JsonSerializable;
 use MongoDB\BSON\Document;
 use MongoDB\Codec\CodecLibrary;
 use MongoDB\Codec\LazyBSONCodecLibrary;
@@ -38,6 +39,7 @@
 use function is_array;
 use function is_object;
 use function is_string;
+use function iterator_to_array;
 use function MongoDB\recursive_copy;
 use function sprintf;
 use function trigger_error;
@@ -54,7 +56,7 @@
  * @template-implements ArrayAccess<string, TValue>
  * @template-implements IteratorAggregate<string, TValue>
  */
-final class LazyBSONDocument implements ArrayAccess, Countable, IteratorAggregate
+final class LazyBSONDocument implements ArrayAccess, Countable, IteratorAggregate, JsonSerializable
 {
     /** @var Document<TValue> */
     private Document $bson;
@@ -218,6 +220,11 @@ function ($value, string $key) use (&$seen) {
         );
     }
 
+    public function jsonSerialize(): array
+    {
+        return iterator_to_array($this->getIterator());
+    }
+
     /** @param mixed $offset */
     public function offsetExists($offset): bool
     {

tests/Model/LazyBSONArrayTest.php

@@ -11,8 +11,10 @@
 use stdClass;
 
 use function iterator_to_array;
+use function json_encode;
 use function serialize;
 use function unserialize;
+use const JSON_THROW_ON_ERROR;
 
 class LazyBSONArrayTest extends TestCase
 {
@@ -273,4 +275,14 @@ public function testSerialization(): void
 
         $this->assertEquals(['foobar', 'baz', 'yay!'], iterator_to_array($unserialized));
     }
+
+    public function testJsonSerialize(): void
+    {
+        $array = new LazyBSONArray(PackedArray::fromPHP(['foo', 'bar', 'baz']));
+        $array[0] = 'foobar';
+        $array[3] = 'yay!';
+        unset($array[1]);
+
+        $this->assertJsonStringEqualsJsonString('["foobar","baz","yay!"]', json_encode($array, JSON_THROW_ON_ERROR));
+    }
 }

tests/Model/LazyBSONDocumentTest.php

@@ -11,8 +11,10 @@
 use stdClass;
 
 use function iterator_to_array;
+use function json_encode;
 use function serialize;
 use function unserialize;
+use const JSON_THROW_ON_ERROR;
 
 class LazyBSONDocumentTest extends TestCase
 {
@@ -323,4 +325,14 @@ public function testSerialization(): void
 
         $this->assertEquals(['foo' => 'foobar', 'baz' => 'yay!'], iterator_to_array($unserialized));
     }
+
+    public function testJsonSerialize(): void
+    {
+        $document = new LazyBSONDocument(Document::fromPHP(['foo' => 'bar', 'bar' => 'baz']));
+        $document['foo'] = 'foobar';
+        $document['baz'] = 'yay!';
+        unset($document['bar']);
+
+        $this->assertJsonStringEqualsJsonString('{"foo":"foobar","baz":"yay!"}', json_encode($document, JSON_THROW_ON_ERROR));
+    }
 }