Fix bugs, implement __set_state

Author: TysonAndre

ext/spl/spl_immutablekeyvaluesequence.c

@@ -307,7 +307,7 @@ static HashTable* spl_immutablekeyvaluesequence_object_get_properties(zend_objec
 		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);
+		zend_hash_index_update(ht, i, &tmp);
 	}
 
 	return ht;
@@ -675,14 +675,7 @@ static void spl_cached_entries_init_from_traversable_pairs(spl_cached_entries *a
 	}
 }
 
-PHP_METHOD(ImmutableKeyValueSequence, fromPairs)
-{
-	zval *iterable;
-
-	ZEND_PARSE_PARAMETERS_START(1, 1)
-		Z_PARAM_ITERABLE(iterable)
-	ZEND_PARSE_PARAMETERS_END();
-
+static zend_object* create_from_pairs(zval *iterable) {
 	zend_object *object = spl_immutablekeyvaluesequence_new(spl_ce_ImmutableKeyValueSequence);
 	spl_immutablekeyvaluesequence_object *intern = cached_iterable_from_obj(object);
 	switch (Z_TYPE_P(iterable)) {
@@ -694,6 +687,30 @@ PHP_METHOD(ImmutableKeyValueSequence, fromPairs)
 			break;
 		EMPTY_SWITCH_DEFAULT_CASE();
 	}
+	return object;
+}
+
+PHP_METHOD(ImmutableKeyValueSequence, fromPairs)
+{
+	zval *iterable;
+
+	ZEND_PARSE_PARAMETERS_START(1, 1)
+		Z_PARAM_ITERABLE(iterable)
+	ZEND_PARSE_PARAMETERS_END();
+
+	RETURN_OBJ(create_from_pairs(iterable));
+}
+
+PHP_METHOD(ImmutableKeyValueSequence, __set_state)
+{
+	zend_array *array_ht;
+
+	ZEND_PARSE_PARAMETERS_START(1, 1)
+		Z_PARAM_ARRAY_HT(array_ht)
+	ZEND_PARSE_PARAMETERS_END();
+	zend_object *object = spl_immutablekeyvaluesequence_new(spl_ce_ImmutableKeyValueSequence);
+	spl_immutablekeyvaluesequence_object *intern = cached_iterable_from_obj(object);
+	spl_cached_entries_init_from_array_pairs(&intern->array, array_ht);
 
 	RETURN_OBJ(object);
 }

ext/spl/spl_immutablekeyvaluesequence.stub.php

@@ -7,11 +7,12 @@ final class ImmutableKeyValueSequence implements IteratorAggregate, Countable, J
     public function __construct(iterable $iterator) {}
     public function getIterator(): InternalIterator {}
     public function count(): int {}
-    public static function fromPairs(iterable $pairs): ImmutableKeyValueSequence;
-    public function toPairs(): array;
+    public static function fromPairs(iterable $pairs): ImmutableKeyValueSequence {}
+    public function toPairs(): array {}
 
     public function __serialize(): array {}
     public function __unserialize(array $data): void {}
+    public static function __set_state(array $array): ImmutableKeyValueSequence {}
 
     public function keys(): array {}
     public function values(): array {}

ext/spl/spl_immutablekeyvaluesequence_arginfo.h

@@ -1,5 +1,5 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: d3090bb712370a96756fa04444ef292c4815640a */
+ * Stub hash: 730dc375507a0bea337b9c242d493a2d9cfbf268 */
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_ImmutableKeyValueSequence___construct, 0, 0, 1)
 	ZEND_ARG_TYPE_INFO(0, iterator, IS_ITERABLE, 0)
@@ -24,6 +24,10 @@ ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_ImmutableKeyValueSequence_
 	ZEND_ARG_TYPE_INFO(0, data, IS_ARRAY, 0)
 ZEND_END_ARG_INFO()
 
+ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_class_ImmutableKeyValueSequence___set_state, 0, 1, ImmutableKeyValueSequence, 0)
+	ZEND_ARG_TYPE_INFO(0, array, IS_ARRAY, 0)
+ZEND_END_ARG_INFO()
+
 #define arginfo_class_ImmutableKeyValueSequence_keys arginfo_class_ImmutableKeyValueSequence_toPairs
 
 #define arginfo_class_ImmutableKeyValueSequence_values arginfo_class_ImmutableKeyValueSequence_toPairs
@@ -44,6 +48,7 @@ ZEND_METHOD(ImmutableKeyValueSequence, fromPairs);
 ZEND_METHOD(ImmutableKeyValueSequence, toPairs);
 ZEND_METHOD(ImmutableKeyValueSequence, __serialize);
 ZEND_METHOD(ImmutableKeyValueSequence, __unserialize);
+ZEND_METHOD(ImmutableKeyValueSequence, __set_state);
 ZEND_METHOD(ImmutableKeyValueSequence, keys);
 ZEND_METHOD(ImmutableKeyValueSequence, values);
 ZEND_METHOD(ImmutableKeyValueSequence, keyAt);
@@ -59,6 +64,7 @@ static const zend_function_entry class_ImmutableKeyValueSequence_methods[] = {
 	ZEND_ME(ImmutableKeyValueSequence, toPairs, arginfo_class_ImmutableKeyValueSequence_toPairs, ZEND_ACC_PUBLIC)
 	ZEND_ME(ImmutableKeyValueSequence, __serialize, arginfo_class_ImmutableKeyValueSequence___serialize, ZEND_ACC_PUBLIC)
 	ZEND_ME(ImmutableKeyValueSequence, __unserialize, arginfo_class_ImmutableKeyValueSequence___unserialize, ZEND_ACC_PUBLIC)
+	ZEND_ME(ImmutableKeyValueSequence, __set_state, arginfo_class_ImmutableKeyValueSequence___set_state, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC)
 	ZEND_ME(ImmutableKeyValueSequence, keys, arginfo_class_ImmutableKeyValueSequence_keys, ZEND_ACC_PUBLIC)
 	ZEND_ME(ImmutableKeyValueSequence, values, arginfo_class_ImmutableKeyValueSequence_values, ZEND_ACC_PUBLIC)
 	ZEND_ME(ImmutableKeyValueSequence, keyAt, arginfo_class_ImmutableKeyValueSequence_keyAt, ZEND_ACC_PUBLIC)

ext/spl/tests/CachedIterable/CachedIterable.phpt

@@ -25,23 +25,39 @@ Value: 'x'
 Key: 'second'
 Value: (object) array(
 )
-object(ImmutableKeyValueSequence)#1 (1) {
+object(ImmutableKeyValueSequence)#1 (2) {
   [0]=>
   array(2) {
     [0]=>
     string(5) "first"
     [1]=>
     string(1) "x"
   }
+  [1]=>
+  array(2) {
+    [0]=>
+    string(6) "second"
+    [1]=>
+    object(stdClass)#2 (0) {
+    }
+  }
 }
-array(1) {
+array(2) {
   [0]=>
   array(2) {
     [0]=>
     string(5) "first"
     [1]=>
     string(1) "x"
   }
+  [1]=>
+  array(2) {
+    [0]=>
+    string(6) "second"
+    [1]=>
+    object(stdClass)#2 (0) {
+    }
+  }
 }
 object(ImmutableKeyValueSequence)#3 (0) {
 }

ext/spl/tests/CachedIterable/CachedIterable_set_state.phpt

@@ -0,0 +1,62 @@
+--TEST--
+ImmutableKeyValueSequence::__set_state
+--FILE--
+<?php
+
+function dump_repr($obj) {
+    echo str_replace(" \n", "\n", var_export($obj, true)), "\n";
+}
+dump_repr(ImmutableKeyValueSequence::__set_state([]));
+try {
+    ImmutableKeyValueSequence::__set_state(['first' => 'x']);
+} catch (Throwable $e) {
+    printf("Caught %s: %s\n", $e::class, $e->getMessage());
+}
+$it = ImmutableKeyValueSequence::__set_state([['first', 'x'], [(object)['key' => 'value'], null]]);
+foreach ($it as $key => $value) {
+    printf("key=%s value=%s\n", json_encode($key), json_encode($value));
+}
+dump_repr($it);
+var_dump($it->toPairs());
+
+?>
+--EXPECT--
+ImmutableKeyValueSequence::__set_state(array(
+))
+Caught UnexpectedValueException: Expected to find pair in array but got non-array
+key="first" value="x"
+key={"key":"value"} value=null
+ImmutableKeyValueSequence::__set_state(array(
+   0 =>
+  array (
+    0 => 'first',
+    1 => 'x',
+  ),
+   1 =>
+  array (
+    0 =>
+    (object) array(
+       'key' => 'value',
+    ),
+    1 => NULL,
+  ),
+))
+array(2) {
+  [0]=>
+  array(2) {
+    [0]=>
+    string(5) "first"
+    [1]=>
+    string(1) "x"
+  }
+  [1]=>
+  array(2) {
+    [0]=>
+    object(stdClass)#1 (1) {
+      ["key"]=>
+      string(5) "value"
+    }
+    [1]=>
+    NULL
+  }
+}