Implement json_encode, fix reference counting

Author: TysonAndre

ext/spl/config.m4

@@ -2,3 +2,4 @@ PHP_NEW_EXTENSION(spl, php_spl.c spl_functions.c spl_engine.c spl_iterators.c sp
 PHP_INSTALL_HEADERS([ext/spl], [php_spl.h spl_array.h spl_directory.h spl_engine.h spl_exceptions.h spl_functions.h spl_iterators.h spl_observer.h spl_dllist.h spl_heap.h spl_fixedarray.h spl_cachediterable.h])
 PHP_ADD_EXTENSION_DEP(spl, pcre, true)
 PHP_ADD_EXTENSION_DEP(spl, standard, true)
+PHP_ADD_EXTENSION_DEP(spl, json, true)

ext/spl/spl_cachediterable.c

@@ -304,6 +304,8 @@ static HashTable* spl_cachediterable_object_get_properties(zend_object *obj)
 	/* Initialize properties array */
 	for (size_t i = 0; i < len; i++) {
 		zval tmp;
+		Z_TRY_ADDREF_P(&entries[i].key);
+		Z_TRY_ADDREF_P(&entries[i].value);
 		ZVAL_ARR(&tmp, zend_new_pair(&entries[i].key, &entries[i].value));
 		zend_hash_index_update(ht, i++, &tmp);
 	}
@@ -720,6 +722,33 @@ PHP_METHOD(CachedIterable, valueAt)
 	RETURN_COPY(&intern->array.entries[offset].value);
 }
 
+PHP_METHOD(CachedIterable, jsonSerialize)
+{
+	/* json_encoder.c will always encode objects as {"0":..., "1":...}, and detects recursion if an object returns its internal property array */
+	ZEND_PARSE_PARAMETERS_NONE();
+	spl_cachediterable_object *intern = Z_CACHEDITERABLE_P(ZEND_THIS);
+	size_t len = intern->array.size;
+	if (!len) {
+		RETURN_EMPTY_ARRAY();
+	}
+
+	zval_pair *entries = intern->array.entries;
+	zend_array *values = zend_new_array(len);
+	/* Initialize return array */
+	zend_hash_real_init_packed(values);
+
+	/* Go through values and add values to the return array */
+	ZEND_HASH_FILL_PACKED(values) {
+		for (size_t i = 0; i < len; i++) {
+			zval tmp;
+			Z_TRY_ADDREF_P(&entries[i].key);
+			Z_TRY_ADDREF_P(&entries[i].value);
+			ZVAL_ARR(&tmp, zend_new_pair(&entries[i].key, &entries[i].value));
+			ZEND_HASH_FILL_ADD(&tmp);
+		}
+	} ZEND_HASH_FILL_END();
+	RETURN_ARR(values);
+}
 
 PHP_MINIT_FUNCTION(spl_cachediterable)
 {
@@ -736,6 +765,7 @@ PHP_MINIT_FUNCTION(spl_cachediterable)
 
 	REGISTER_SPL_IMPLEMENTS(CachedIterable, Aggregate);
 	REGISTER_SPL_IMPLEMENTS(CachedIterable, Countable);
+	REGISTER_SPL_IMPLEMENTS(CachedIterable, JsonSerializable);
 
 	spl_ce_CachedIterable->ce_flags |= ZEND_ACC_FINAL | ZEND_ACC_NO_DYNAMIC_PROPERTIES;
 	spl_ce_CachedIterable->get_iterator = spl_cachediterable_get_iterator;

ext/spl/spl_cachediterable.stub.php

@@ -1,7 +1,7 @@
 <?php
 
 /** @generate-function-entries */
-final class CachedIterable implements IteratorAggregate, Countable
+final class CachedIterable implements IteratorAggregate, Countable, JsonSerializable
 {
     public function __construct(iterable $iterator) {}
     public function getIterator(): InternalIterator {}
@@ -15,4 +15,6 @@ public function keys(): array {}
     public function values(): array {}
     public function keyAt(int $offset): mixed {}
     public function valueAt(int $offset): mixed {}
+
+    public function jsonSerialize(): array {}
 }

ext/spl/spl_cachediterable_arginfo.h

@@ -1,5 +1,5 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: ef7b757105d968778ef91cfebadfa51b559e2f7e */
+ * Stub hash: c1b5d7c534af712125691bf95c8210787fd012bf */
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_CachedIterable___construct, 0, 0, 1)
 	ZEND_ARG_TYPE_INFO(0, iterator, IS_ITERABLE, 0)
@@ -32,6 +32,8 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_class_CachedIterable_valueAt arginfo_class_CachedIterable_keyAt
 
+#define arginfo_class_CachedIterable_jsonSerialize arginfo_class_CachedIterable___serialize
+
 
 ZEND_METHOD(CachedIterable, __construct);
 ZEND_METHOD(CachedIterable, getIterator);
@@ -43,6 +45,7 @@ ZEND_METHOD(CachedIterable, keys);
 ZEND_METHOD(CachedIterable, values);
 ZEND_METHOD(CachedIterable, keyAt);
 ZEND_METHOD(CachedIterable, valueAt);
+ZEND_METHOD(CachedIterable, jsonSerialize);
 
 
 static const zend_function_entry class_CachedIterable_methods[] = {
@@ -56,5 +59,6 @@ static const zend_function_entry class_CachedIterable_methods[] = {
 	ZEND_ME(CachedIterable, values, arginfo_class_CachedIterable_values, ZEND_ACC_PUBLIC)
 	ZEND_ME(CachedIterable, keyAt, arginfo_class_CachedIterable_keyAt, ZEND_ACC_PUBLIC)
 	ZEND_ME(CachedIterable, valueAt, arginfo_class_CachedIterable_valueAt, ZEND_ACC_PUBLIC)
+	ZEND_ME(CachedIterable, jsonSerialize, arginfo_class_CachedIterable_jsonSerialize, ZEND_ACC_PUBLIC)
 	ZEND_FE_END
 };

ext/spl/spl_iterators.h

@@ -20,6 +20,7 @@
 #include "php.h"
 #include "php_spl.h"
 #include "ext/pcre/php_pcre.h"
+#include "ext/json/php_json.h"
 
 #define spl_ce_Traversable   zend_ce_traversable
 #define spl_ce_Iterator      zend_ce_iterator
@@ -28,6 +29,7 @@
 #define spl_ce_Serializable  zend_ce_serializable
 #define spl_ce_Countable     zend_ce_countable
 #define spl_ce_Stringable    zend_ce_stringable
+#define spl_ce_JsonSerializable    php_json_serializable_ce
 
 extern PHPAPI zend_class_entry *spl_ce_RecursiveIterator;
 extern PHPAPI zend_class_entry *spl_ce_RecursiveIteratorIterator;

ext/spl/tests/CachedIterable/CachedIterable_serialization.phpt

@@ -24,6 +24,11 @@ $x = 'modified'; // no effect, this is copied by value
 var_dump($it->__serialize());
 $it = new CachedIterable([]);
 var_dump($it->__serialize());
+
+$it = CachedIterable::fromPairs([[new stdClass(), &$x]]);
+echo "json encoded: " . var_export(json_encode($it), true) . "\n";
+echo "json encoded empty: " . var_export(json_encode($it), true) . "\n";
+var_dump($it);
 ?>
 --EXPECT--
 Caught Error: Cannot create dynamic property CachedIterable::$dynamicProp
@@ -49,4 +54,16 @@ array(2) {
   int(123)
 }
 array(0) {
+}
+json encoded: '[[{},"modified"]]'
+json encoded empty: '[[{},"modified"]]'
+object(CachedIterable)#6 (1) {
+  [0]=>
+  array(2) {
+    [0]=>
+    object(stdClass)#4 (0) {
+    }
+    [1]=>
+    string(8) "modified"
+  }
 }