PHPLIB-163: __set_state() for BSON array and document models

Author: jmikola

src/Model/BSONArray.php

@@ -16,6 +16,22 @@
  */
 class BSONArray extends ArrayObject implements Serializable, Unserializable
 {
+    /**
+     * Factory method for var_export().
+     *
+     * @see http://php.net/oop5.magic#object.set-state
+     * @see http://php.net/var-export
+     * @param array $properties
+     * @return self
+     */
+    public static function __set_state(array $properties)
+    {
+        $array = new static;
+        $array->exchangeArray($properties);
+
+        return $array;
+    }
+
     /**
      * Serialize the array to BSON.
      *

src/Model/BSONDocument.php

@@ -29,6 +29,22 @@ public function __construct($input = [], $flags = ArrayObject::ARRAY_AS_PROPS, $
         parent::__construct($input, $flags, $iterator_class);
     }
 
+    /**
+     * Factory method for var_export().
+     *
+     * @see http://php.net/oop5.magic#object.set-state
+     * @see http://php.net/var-export
+     * @param array $properties
+     * @return self
+     */
+    public static function __set_state(array $properties)
+    {
+        $document = new static;
+        $document->exchangeArray($properties);
+
+        return $document;
+    }
+
     /**
      * Serialize the document to BSON.
      *

tests/Model/BSONArrayTest.php

@@ -14,4 +14,13 @@ public function testBsonSerializeReindexesKeys()
         $this->assertSame($data, $array->getArrayCopy());
         $this->assertSame(['foo', 'bar'], $array->bsonSerialize());
     }
+
+    public function testSetState()
+    {
+        $data = ['foo', 'bar'];
+
+        $array = BSONArray::__set_state($data);
+        $this->assertInstanceOf('MongoDB\Model\BSONArray', $array);
+        $this->assertSame($data, $array->getArrayCopy());
+    }
 }

tests/Model/BSONDocumentTest.php

@@ -22,4 +22,13 @@ public function testBsonSerializeCastsToObject()
         $this->assertSame($data, $document->getArrayCopy());
         $this->assertEquals((object) [0 => 'foo', 2 => 'bar'], $document->bsonSerialize());
     }
+
+    public function testSetState()
+    {
+        $data = ['foo' => 'bar'];
+
+        $document = BSONDocument::__set_state($data);
+        $this->assertInstanceOf('MongoDB\Model\BSONDocument', $document);
+        $this->assertSame($data, $document->getArrayCopy());
+    }
 }