PHPC-344: Allow non-root Serializable to encode as BSON array

Author: jmikola

src/bson.c

@@ -634,14 +634,22 @@ void object_to_bson(zval *object, php_phongo_bson_flags_t flags, const char *key
 				tmp_ht->nApplyCount++;
 			}
 
-			bson_append_document_begin(bson, key, key_len, &child);
-			if (instanceof_function(Z_OBJCE_P(object), php_phongo_persistable_ce TSRMLS_CC)) {
-				if (flags & PHONGO_BSON_ADD_CHILD_ODS) {
-					bson_append_binary(&child, PHONGO_ODM_FIELD_NAME, -1, 0x80, (const uint8_t *)Z_OBJCE_P(object)->name, strlen(Z_OBJCE_P(object)->name));
+			/* Persistable objects must always be serialized as BSON documents;
+			 * otherwise, infer based on bsonSerialize()'s return value. */
+			if (instanceof_function(Z_OBJCE_P(object), php_phongo_persistable_ce TSRMLS_CC) || php_phongo_is_array_or_document(&obj_data TSRMLS_CC) == IS_OBJECT) {
+				bson_append_document_begin(bson, key, key_len, &child);
+				if (instanceof_function(Z_OBJCE_P(object), php_phongo_persistable_ce TSRMLS_CC)) {
+					if (flags & PHONGO_BSON_ADD_CHILD_ODS) {
+						bson_append_binary(&child, PHONGO_ODM_FIELD_NAME, -1, 0x80, (const uint8_t *)Z_OBJCE_P(object)->name, strlen(Z_OBJCE_P(object)->name));
+					}
 				}
+				zval_to_bson(obj_data, flags, &child, NULL TSRMLS_CC);
+				bson_append_document_end(bson, &child);
+			} else {
+				bson_append_array_begin(bson, key, key_len, &child);
+				zval_to_bson(obj_data, flags, &child, NULL TSRMLS_CC);
+				bson_append_array_end(bson, &child);
 			}
-			zval_to_bson(obj_data, flags, &child, NULL TSRMLS_CC);
-			bson_append_document_end(bson, &child);
 
 			if (tmp_ht) {
 				tmp_ht->nApplyCount--;

tests/bson/bson-encode-002.phpt

@@ -67,7 +67,7 @@ $bson = fromPHP(array('embed' => new NumericArray));
 echo toJSON($bson), "\n";
 echo "Encoded BSON:\n";
 hex_dump($bson);
-$value = toPHP($bson, array("document" => 'NumericArray'));
+$value = toPHP($bson, array("array" => 'NumericArray'));
 echo "Decoded BSON:\n";
 var_dump($value);
 
@@ -131,9 +131,9 @@ object(NumericArray)#%d (0) {
 }
 
 Testing embedded NumericArray:
-{ "embed" : { "0" : 1, "1" : 2, "2" : 3 } }
+{ "embed" : [ 1, 2, 3 ] }
 Encoded BSON:
-     0 : 26 00 00 00 03 65 6d 62 65 64 00 1a 00 00 00 10  [&....embed......]
+     0 : 26 00 00 00 04 65 6d 62 65 64 00 1a 00 00 00 10  [&....embed......]
     10 : 30 00 01 00 00 00 10 31 00 02 00 00 00 10 32 00  [0......1......2.]
     20 : 03 00 00 00 00 00                                [......]
 NumericArray::bsonUnserialize() was called with data:

tests/bson/bson-fromPHP-001.phpt

@@ -0,0 +1,68 @@
+--TEST--
+BSON\fromPHP(): bsonSerialize() allows array and stdClass
+--SKIPIF--
+<?php require __DIR__ . "/../utils/basic-skipif.inc"?>
+--FILE--
+<?php
+use MongoDB\BSON as BSON;
+
+require_once __DIR__ . "/../utils/basic.inc";
+
+class MyDocument implements BSON\Serializable
+{
+    private $data;
+
+    public function __construct($data = null)
+    {
+        $this->data = $data;
+    }
+
+    public function bsonSerialize()
+    {
+        return $this->data;
+    }
+}
+
+$tests = array(
+    array(1, 2, 3),
+    array('foo' => 'bar'),
+    (object) array(1, 2, 3),
+    (object) array('foo' => 'bar'),
+);
+
+echo "Testing top-level objects\n";
+
+foreach ($tests as $test) {
+    try {
+        echo toJson(fromPHP(new MyDocument($test))), "\n";
+    } catch (MongoDB\Driver\Exception\UnexpectedValueException $e) {
+        echo $e->getMessage(), "\n";
+    }
+}
+
+echo "\nTesting nested objects\n";
+
+foreach ($tests as $test) {
+    try {
+        echo toJson(fromPHP(new MyDocument(array('nested' => new MyDocument($test))))), "\n";
+    } catch (MongoDB\Driver\Exception\UnexpectedValueException $e) {
+        echo $e->getMessage(), "\n";
+    }
+}
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECTF--
+Testing top-level objects
+{ "0" : 1, "1" : 2, "2" : 3 }
+{ "foo" : "bar" }
+{ "0" : 1, "1" : 2, "2" : 3 }
+{ "foo" : "bar" }
+
+Testing nested objects
+{ "nested" : [ 1, 2, 3 ] }
+{ "nested" : { "foo" : "bar" } }
+{ "nested" : { "0" : 1, "1" : 2, "2" : 3 } }
+{ "nested" : { "foo" : "bar" } }
+===DONE===