PHPC-1092: Don't reset hash on successive get_properties calls

This removes a call to zend_hash_clean() on successive calls to a BSON object's get_properties handler, which can lead to an infinite loop when iterating the object's properties with foreach on PHP 7.x.

For historical reference, the original call to zend_hash_clean() was introduced in ad1f3f0 for #607 (PHPC-939).

Author: jmikola

php_phongo.h

@@ -196,7 +196,6 @@ zend_bool phongo_writeconcernerror_init(zval *return_value, bson_t *bson TSRMLS_
         ALLOC_HASHTABLE(props);                                                 \
         zend_hash_init((props), (size), NULL, ZVAL_PTR_DTOR, 0);                \
     } else if ((intern)->properties) {                                          \
-        zend_hash_clean((intern)->properties);                                  \
         (props) = (intern)->properties;                                         \
     } else {                                                                    \
         ALLOC_HASHTABLE(props);                                                 \

tests/bson/bson-binary-get_properties-001.phpt

@@ -0,0 +1,20 @@
+--TEST--
+MongoDB\BSON\Binary get_properties handler (get_object_vars)
+--FILE--
+<?php
+
+$binary = new MongoDB\BSON\Binary('foobar', MongoDB\BSON\Binary::TYPE_GENERIC);
+
+var_dump(get_object_vars($binary));
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+array(2) {
+  ["data"]=>
+  string(6) "foobar"
+  ["type"]=>
+  int(0)
+}
+===DONE===

tests/bson/bson-binary-get_properties-002.phpt

@@ -0,0 +1,21 @@
+--TEST--
+MongoDB\BSON\Binary get_properties handler (foreach)
+--FILE--
+<?php
+
+$binary = new MongoDB\BSON\Binary('foobar', MongoDB\BSON\Binary::TYPE_GENERIC);
+
+foreach ($binary as $key => $value) {
+    var_dump($key);
+    var_dump($value);
+}
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+string(4) "data"
+string(6) "foobar"
+string(4) "type"
+int(0)
+===DONE===

tests/bson/bson-dbpointer-get_properties-001.phpt

@@ -0,0 +1,21 @@
+--TEST--
+MongoDB\BSON\DBPointer get_properties handler (get_object_vars)
+--FILE--
+<?php
+
+$document = MongoDB\BSON\toPHP(MongoDB\BSON\fromJSON('{"dbptr":{"$dbPointer":{"$ref":"phongo.test","$id":{"$oid":"5a2e78accd485d55b405ac12"}}}}'));
+$dbptr = $document->dbptr;
+
+var_dump(get_object_vars($dbptr));
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+array(2) {
+  ["ref"]=>
+  string(11) "phongo.test"
+  ["id"]=>
+  string(24) "5a2e78accd485d55b405ac12"
+}
+===DONE===

tests/bson/bson-dbpointer-get_properties-002.phpt

@@ -0,0 +1,22 @@
+--TEST--
+MongoDB\BSON\DBPointer get_properties handler (foreach)
+--FILE--
+<?php
+
+$document = MongoDB\BSON\toPHP(MongoDB\BSON\fromJSON('{"dbptr":{"$dbPointer":{"$ref":"phongo.test","$id":{"$oid":"5a2e78accd485d55b405ac12"}}}}'));
+$dbptr = $document->dbptr;
+
+foreach ($dbptr as $key => $value) {
+    var_dump($key);
+    var_dump($value);
+}
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+string(3) "ref"
+string(11) "phongo.test"
+string(2) "id"
+string(24) "5a2e78accd485d55b405ac12"
+===DONE===

tests/bson/bson-decimal128-get_properties-001.phpt

@@ -0,0 +1,20 @@
+--TEST--
+MongoDB\BSON\Decimal128 get_properties handler (get_object_vars)
+--SKIPIF--
+<?php if (!class_exists('MongoDB\BSON\Decimal128')) { die('skip MongoDB\BSON\Decimal128 is not available'); } ?>
+--FILE--
+<?php
+
+$decimal = new MongoDB\BSON\Decimal128('1234.5678');
+
+var_dump(get_object_vars($decimal));
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+array(1) {
+  ["dec"]=>
+  string(9) "1234.5678"
+}
+===DONE===

tests/bson/bson-decimal128-get_properties-002.phpt

@@ -0,0 +1,21 @@
+--TEST--
+MongoDB\BSON\Decimal128 get_properties handler (foreach)
+--SKIPIF--
+<?php if (!class_exists('MongoDB\BSON\Decimal128')) { die('skip MongoDB\BSON\Decimal128 is not available'); } ?>
+--FILE--
+<?php
+
+$decimal = new MongoDB\BSON\Decimal128('1234.5678');
+
+foreach ($decimal as $key => $value) {
+    var_dump($key);
+    var_dump($value);
+}
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+string(3) "dec"
+string(9) "1234.5678"
+===DONE===

tests/bson/bson-javascript-get_properties-001.phpt

@@ -0,0 +1,34 @@
+--TEST--
+MongoDB\BSON\Javascript get_properties handler (get_object_vars)
+--FILE--
+<?php
+
+$tests = [
+    new MongoDB\BSON\Javascript('function foo(bar) { return bar; }'),
+    new MongoDB\BSON\Javascript('function foo() { return bar; }', ['bar' => 42]),
+];
+
+foreach ($tests as $test) {
+    var_dump(get_object_vars($test));
+}
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECTF--
+array(2) {
+  ["code"]=>
+  string(33) "function foo(bar) { return bar; }"
+  ["scope"]=>
+  NULL
+}
+array(2) {
+  ["code"]=>
+  string(30) "function foo() { return bar; }"
+  ["scope"]=>
+  object(stdClass)#%d (%d) {
+    ["bar"]=>
+    int(42)
+  }
+}
+===DONE===

tests/bson/bson-javascript-get_properties-002.phpt

@@ -0,0 +1,33 @@
+--TEST--
+MongoDB\BSON\Javascript get_properties handler (foreach)
+--FILE--
+<?php
+
+$tests = [
+    new MongoDB\BSON\Javascript('function foo(bar) { return bar; }'),
+    new MongoDB\BSON\Javascript('function foo() { return bar; }', ['bar' => 42]),
+];
+
+foreach ($tests as $test) {
+    foreach ($test as $key => $value) {
+        var_dump($key);
+        var_dump($value);
+    }
+}
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECTF--
+string(4) "code"
+string(33) "function foo(bar) { return bar; }"
+string(5) "scope"
+NULL
+string(4) "code"
+string(30) "function foo() { return bar; }"
+string(5) "scope"
+object(stdClass)#%d (%d) {
+  ["bar"]=>
+  int(42)
+}
+===DONE===

tests/bson/bson-objectid-get_properties-001.phpt

@@ -0,0 +1,18 @@
+--TEST--
+MongoDB\BSON\ObjectId get_properties handler (get_object_vars)
+--FILE--
+<?php
+
+$oid = new MongoDB\BSON\ObjectId('53e2a1c40640fd72175d4603');
+
+var_dump(get_object_vars($oid));
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+array(1) {
+  ["oid"]=>
+  string(24) "53e2a1c40640fd72175d4603"
+}
+===DONE===