PHPC-121: Use BSON\Serialize::bsonSerialize() during serialization

Author: bjori

src/bson.c

@@ -569,6 +569,33 @@ void object_to_bson(zval *object, const char *key, long key_len, bson_t *bson TS
 	}
 
 	if (instanceof_function(Z_OBJCE_P(object), php_phongo_type_ce TSRMLS_CC)) {
+		if (instanceof_function(Z_OBJCE_P(object), php_phongo_serializable_ce TSRMLS_CC)) {
+			zval *retval = NULL;
+
+			zend_call_method_with_0_params(&object, NULL, NULL, BSON_SERIALIZE_FUNC_NAME, &retval);
+			if (retval) {
+				bson_t      child;
+				HashTable  *tmp_ht;
+
+				convert_to_array_ex(&retval);
+				tmp_ht = HASH_OF(retval);
+
+				if (tmp_ht) {
+					tmp_ht->nApplyCount++;
+				}
+
+				bson_append_array_begin(bson, key, key_len, &child);
+				zval_to_bson(retval, PHONGO_BSON_NONE, &child, NULL TSRMLS_CC);
+				bson_append_array_end(bson, &child);
+
+				if (tmp_ht) {
+					tmp_ht->nApplyCount--;
+				}
+				zval_ptr_dtor(&retval);
+			}
+			return;
+		}
+
 		if (instanceof_function(Z_OBJCE_P(object), php_phongo_objectid_ce TSRMLS_CC)) {
 			bson_oid_t oid;
 
@@ -831,22 +858,26 @@ void php_phongo_bson_typemap_to_state(zval *typemap, php_phongo_bson_typemap *ma
 		zend_class_entry      *array_ce = NULL, *document_ce = NULL;
 
 		classname = php_array_fetchl_string(typemap, "array", sizeof("array")-1, &classname_len, &classname_free);
-		array_ce = zend_fetch_class(classname, classname_len, ZEND_FETCH_CLASS_AUTO TSRMLS_CC);
+		if (classname_len) {
+			array_ce = zend_fetch_class(classname, classname_len, ZEND_FETCH_CLASS_AUTO TSRMLS_CC);
 
-		if (instanceof_function(array_ce, php_phongo_unserializable_ce TSRMLS_CC)) {
-			map->array = array_ce;
-		}
-		if (classname_free) {
-			efree(classname);
+			if (instanceof_function(array_ce, php_phongo_unserializable_ce TSRMLS_CC)) {
+				map->array = array_ce;
+			}
+			if (classname_free) {
+				efree(classname);
+			}
 		}
 
 		classname = php_array_fetchl_string(typemap, "document", sizeof("document")-1, &classname_len, &classname_free);
-		document_ce = zend_fetch_class(classname, classname_len, ZEND_FETCH_CLASS_AUTO TSRMLS_CC);
-		if (instanceof_function(document_ce, php_phongo_unserializable_ce TSRMLS_CC)) {
-			map->document = document_ce;
-		}
-		if (classname_free) {
-			efree(classname);
+		if (classname_len) {
+			document_ce = zend_fetch_class(classname, classname_len, ZEND_FETCH_CLASS_AUTO TSRMLS_CC);
+			if (instanceof_function(document_ce, php_phongo_unserializable_ce TSRMLS_CC)) {
+				map->document = document_ce;
+			}
+			if (classname_free) {
+				efree(classname);
+			}
 		}
 	}
 }

tests/bson/bson-encode-002.phpt

@@ -0,0 +1,70 @@
+--TEST--
+BSON encoding: Encoding objects into BSON representation
+--SKIPIF--
+<?php require "tests/utils/basic-skipif.inc"?>
+--FILE--
+<?php 
+require_once "tests/utils/basic.inc";
+
+class MyClass implements BSON\Serializable, BSON\Unserializable, BSON\Type {
+    function bsonSerialize() {
+        return array(
+            "random" => "class",
+            "data"
+        );
+    }
+    function bsonUnserialize(array $data) {
+        var_dump(__METHOD__, $data);
+    }
+}
+class MyClass2 implements BSON\Serializable, BSON\Unserializable, BSON\Type {
+    function bsonSerialize() {
+        return array(
+            1, 2, 3,
+        );
+    }
+    function bsonUnserialize(array $data) {
+        var_dump(__METHOD__, $data);
+    }
+}
+
+$tests = array(
+    array("stuff" => new MyClass),
+    array("stuff" => new MyClass2),
+);
+
+foreach($tests as $n => $test) {
+    $s = BSON\fromArray($test);
+    echo "Test#{$n} ", BSON\toJSON($s), "\n";
+    hex_dump($s);
+    BSON\toArray($s, array("array" => get_class($test["stuff"])));
+}
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+Test#0 { "stuff" : [ "class", "data" ] }
+     0 : 2f 00 00 00 04 73 74 75 66 66 00 23 00 00 00 02  [/....stuff.#....]
+    10 : 72 61 6e 64 6f 6d 00 06 00 00 00 63 6c 61 73 73  [random.....class]
+    20 : 00 02 30 00 05 00 00 00 64 61 74 61 00 00 00     [..0.....data...]
+string(24) "MyClass::bsonUnserialize"
+array(2) {
+  ["random"]=>
+  string(5) "class"
+  [0]=>
+  string(4) "data"
+}
+Test#1 { "stuff" : [ 1, 2, 3 ] }
+     0 : 26 00 00 00 04 73 74 75 66 66 00 1a 00 00 00 10  [&....stuff......]
+    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                                [......]
+string(25) "MyClass2::bsonUnserialize"
+array(3) {
+  [0]=>
+  int(1)
+  [1]=>
+  int(2)
+  [2]=>
+  int(3)
+}
+===DONE===