Add new serialization methods for SplFixedArray

Author: kocsismate

ext/spl/spl_fixedarray.c

@@ -102,13 +102,18 @@ static void spl_fixedarray_init_elems(spl_fixedarray *array, zend_long from, zen
 	}
 }
 
+static void spl_fixedarray_init_non_empty_struct(spl_fixedarray *array, zend_long size)
+{
+	array->size = 0; /* reset size in case ecalloc() fails */
+	array->elements = safe_emalloc(size, sizeof(zval), 0);
+	array->size = size;
+	array->should_rebuild_properties = true;
+}
+
 static void spl_fixedarray_init(spl_fixedarray *array, zend_long size)
 {
 	if (size > 0) {
-		array->size = 0; /* reset size in case ecalloc() fails */
-		array->elements = safe_emalloc(size, sizeof(zval), 0);
-		array->size = size;
-		array->should_rebuild_properties = true;
+		spl_fixedarray_init_non_empty_struct(array, size);
 		spl_fixedarray_init_elems(array, 0, size);
 	} else {
 		spl_fixedarray_default_ctor(array);
@@ -582,6 +587,67 @@ PHP_METHOD(SplFixedArray, __wakeup)
 	}
 }
 
+PHP_METHOD(SplFixedArray, __serialize)
+{
+	spl_fixedarray_object *intern = Z_SPLFIXEDARRAY_P(ZEND_THIS);
+	zval *current, tmp;
+
+	if (zend_parse_parameters_none() == FAILURE) {
+		RETURN_THROWS();
+	}
+
+	array_init(return_value);
+
+	/* elements */
+	array_init_size(&tmp, intern->array.size);
+
+	for (zend_long i = 0; i < intern->array.size; i++) {
+		current = &intern->array.elements[i];
+		zend_hash_next_index_insert(Z_ARRVAL(tmp), current);
+		Z_TRY_ADDREF_P(current);
+	}
+
+	zend_hash_next_index_insert(Z_ARRVAL_P(return_value), &tmp);
+
+	/* members */
+	ZVAL_ARR(&tmp, zend_proptable_to_symtable(
+		zend_std_get_properties(&intern->std), /* always_duplicate */ 1));
+	zend_hash_next_index_insert(Z_ARRVAL_P(return_value), &tmp);
+}
+
+PHP_METHOD(SplFixedArray, __unserialize)
+{
+	spl_fixedarray_object *intern = Z_SPLFIXEDARRAY_P(ZEND_THIS);
+	HashTable *data;
+	zval *storage_zv, *members_zv, *elem;
+
+	if (zend_parse_parameters(ZEND_NUM_ARGS(), "h", &data) == FAILURE) {
+		RETURN_THROWS();
+	}
+
+	if (intern->array.size == 0) {
+		storage_zv = zend_hash_index_find(data, 0);
+		members_zv = zend_hash_index_find(data, 1);
+		if (!storage_zv || !members_zv ||
+			Z_TYPE_P(storage_zv) != IS_ARRAY || Z_TYPE_P(members_zv) != IS_ARRAY
+		) {
+			zend_throw_exception(spl_ce_UnexpectedValueException,
+				"Incomplete or ill-typed serialization data", 0);
+			RETURN_THROWS();
+		}
+
+		zend_long size = zend_hash_num_elements(Z_ARRVAL_P(storage_zv));
+		spl_fixedarray_init_non_empty_struct(&intern->array, size);
+
+		zend_long i = 0;
+		ZEND_HASH_FOREACH_VAL(Z_ARRVAL_P(storage_zv), elem) {
+			ZVAL_COPY(&intern->array.elements[i++], elem);
+		} ZEND_HASH_FOREACH_END();
+
+		object_properties_load(&intern->std, Z_ARRVAL_P(members_zv));
+	}
+}
+
 PHP_METHOD(SplFixedArray, count)
 {
 	zval *object = ZEND_THIS;

ext/spl/spl_fixedarray.stub.php

@@ -9,6 +9,10 @@ public function __construct(int $size = 0) {}
     /** @tentative-return-type */
     public function __wakeup(): void {}
 
+    public function __serialize(): array {}
+
+    public function __unserialize(array $data): void {}
+
     /** @tentative-return-type */
     public function count(): int {}
 

ext/spl/spl_fixedarray_arginfo.h

@@ -13,6 +13,8 @@ $array[2] = 42;
 $array[3] = $obj;
 $array[4] = range(1, 5);
 
+$array->foo = "bar";
+
 $ser = serialize($array);
 echo "$ser\n";
 $unser = unserialize($ser);
@@ -24,10 +26,23 @@ var_dump($unser[0], $unser[1], $unser[2], $unser[3], $unser[4]);
 
 $unser[4] = 'quux';
 var_dump($unser[4]);
+var_dump($unser->foo);
+
+$array = new SplFixedArray(5);
+$array->__unserialize([
+    [null],
+    [
+        "foo" => "bar",
+    ],
+]);
+var_dump($array);
 
 ?>
---EXPECT--
-O:13:"SplFixedArray":5:{i:0;s:3:"foo";i:1;N;i:2;i:42;i:3;O:8:"stdClass":1:{s:4:"prop";s:5:"value";}i:4;a:5:{i:0;i:1;i:1;i:2;i:2;i:3;i:3;i:4;i:4;i:5;}}
+--EXPECTF--
+Deprecated: Creation of dynamic property SplFixedArray::$foo is deprecated in %s on line %d
+O:13:"SplFixedArray":2:{i:0;a:5:{i:0;s:3:"foo";i:1;N;i:2;i:42;i:3;O:8:"stdClass":1:{s:4:"prop";s:5:"value";}i:4;a:5:{i:0;i:1;i:1;i:2;i:2;i:3;i:3;i:4;i:4;i:5;}}i:1;a:1:{s:3:"foo";s:3:"bar";}}
+
+Deprecated: Creation of dynamic property SplFixedArray::$foo is deprecated in %s on line %d
 count: 5
 getSize(): 5
 string(3) "foo"
@@ -50,3 +65,16 @@ array(5) {
   int(5)
 }
 string(4) "quux"
+string(3) "bar"
+object(SplFixedArray)#5 (5) {
+  [0]=>
+  NULL
+  [1]=>
+  NULL
+  [2]=>
+  NULL
+  [3]=>
+  NULL
+  [4]=>
+  NULL
+}