PHPC-2244: Return Int64 instances when converting BSON objects to PHP

Author: alcaeus

src/BSON/Document.c

@@ -256,6 +256,8 @@ static PHP_METHOD(MongoDB_BSON_Document, toPHP)
 
 	intern = Z_DOCUMENT_OBJ_P(getThis());
 
+	state.map.int64_as_object = true;
+
 	if (!php_phongo_bson_to_zval_ex(intern->bson, &state)) {
 		zval_ptr_dtor(&state.zchild);
 		php_phongo_bson_typemap_dtor(&state.map);

src/BSON/PackedArray.c

@@ -184,7 +184,8 @@ static PHP_METHOD(MongoDB_BSON_PackedArray, toPHP)
 
 	intern = Z_PACKEDARRAY_OBJ_P(getThis());
 
-	state.is_visiting_array = true;
+	state.is_visiting_array   = true;
+	state.map.int64_as_object = true;
 
 	if (!php_phongo_bson_to_zval_ex(intern->bson, &state)) {
 		zval_ptr_dtor(&state.zchild);

src/phongo_bson.c

@@ -579,9 +579,17 @@ static bool php_phongo_bson_visit_int64(const bson_iter_t* iter ARG_UNUSED, cons
 	php_phongo_field_path_write_item_at_current_level(state->field_path, key);
 
 	if (state->is_visiting_array) {
-		ADD_NEXT_INDEX_INT64(retval, v_int64);
+		if (state->map.int64_as_object) {
+			ADD_NEXT_INDEX_INT64_OBJ(retval, v_int64);
+		} else {
+			ADD_NEXT_INDEX_INT64(retval, v_int64);
+		}
 	} else {
-		ADD_ASSOC_INT64(retval, key, v_int64);
+		if (state->map.int64_as_object) {
+			ADD_ASSOC_INT64_OBJ(retval, key, v_int64);
+		} else {
+			ADD_ASSOC_INT64(retval, key, v_int64);
+		}
 	}
 
 	return false;

src/phongo_bson.h

@@ -62,6 +62,7 @@ typedef struct {
 	php_phongo_bson_typemap_element document;
 	php_phongo_bson_typemap_element array;
 	php_phongo_bson_typemap_element root;
+	bool                            int64_as_object;
 	struct {
 		php_phongo_field_path_map_element** map;
 		size_t                              allocated_size;

src/phongo_compat.h

@@ -121,6 +121,18 @@
 		}                \
 	}
 
+#define ADD_NEXT_INDEX_INT64_OBJ(_zv, _value) \
+	do {                                      \
+		zval zchild;                          \
+		phongo_int64_new(&zchild, (_value));  \
+		add_next_index_zval((_zv), &zchild);  \
+	} while (0);
+#define ADD_ASSOC_INT64_OBJ(_zv, _key, _value)  \
+	do {                                        \
+		zval zchild;                            \
+		phongo_int64_new(&zchild, (_value));    \
+		add_assoc_zval((_zv), (_key), &zchild); \
+	} while (0);
 #if SIZEOF_ZEND_LONG == 8
 #define ADD_INDEX_INT64(_zv, _index, _value) add_index_long((_zv), (_index), (_value))
 #define ADD_NEXT_INDEX_INT64(_zv, _value) add_next_index_long((_zv), (_value))

tests/bson/bson-document-toPHP-012.phpt

@@ -0,0 +1,26 @@
+--TEST--
+MongoDB\BSON\Document::toPHP(): int64 values are returned as Int64 instances
+--FILE--
+<?php
+
+$bson = MongoDB\BSON\Document::fromPHP([
+    'int32' => 123,
+    'int64' => new MongoDB\BSON\Int64(123),
+]);
+
+var_dump($bson->toPHP());
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECTF--
+object(stdClass)#%d (%d) {
+  ["int32"]=>
+  int(123)
+  ["int64"]=>
+  object(MongoDB\BSON\Int64)#%d (1) {
+    ["integer"]=>
+    string(3) "123"
+  }
+}
+===DONE===

tests/bson/bson-packedarray-toPHP-005.phpt

@@ -0,0 +1,26 @@
+--TEST--
+MongoDB\BSON\PackedArray::toPHP(): int64 values are returned as Int64 instances
+--FILE--
+<?php
+
+$bson = MongoDB\BSON\PackedArray::fromPHP([
+    123,
+    new MongoDB\BSON\Int64(123),
+]);
+
+var_dump($bson->toPHP());
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECTF--
+array(2) {
+  [0]=>
+  int(123)
+  [1]=>
+  object(MongoDB\BSON\Int64)#%d (1) {
+    ["integer"]=>
+    string(3) "123"
+  }
+}
+===DONE===

tests/bson/bson-toPHP-017.phpt

@@ -0,0 +1,24 @@
+--TEST--
+MongoDB\BSON\toPHP(): int64 values are returned as int scalars
+--FILE--
+<?php
+
+$bson = MongoDB\BSON\fromPHP([
+    'int32' => 123,
+    // Using a 32-bit value to simplify testing
+    'int64' => new MongoDB\BSON\Int64(123),
+]);
+
+var_dump(MongoDB\BSON\toPHP($bson));
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECTF--
+object(stdClass)#%d (%d) {
+  ["int32"]=>
+  int(123)
+  ["int64"]=>
+  int(123)
+}
+===DONE===