Release 1.6.0 — PHP 8.2+, serialization, and bug fixes

- Drop PHP < 8.2 support, require PHP >= 8.2
- Implement __serialize/__unserialize on all data structures using the O:
  format, replacing the deprecated Serializable interface (C: format)
- Fix sort/sorted/ksort/ksorted to accept null comparators (#134)
- Save and restore global compare FCI around sort callbacks to support
  nested comparators (#48)
- Guard allocate methods against negative capacity values (#33)
- Update CI matrix for PHP 8.2–8.5, PHPUnit 11
- Update package.xml and composer.json for PHP 8.2+ and tests ^1.6
- Remove legacy Serializable interface, arginfo.h, and PHP < 8.2 compat code

Thanks to @simPod, @ndossche, and @NorthNick for their contributions.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Author: rudi-augment

.github/workflows/main.yml

@@ -15,9 +15,6 @@ jobs:
       fail-fast: false
       matrix:
         php:
-          - "7.4"
-          - "8.0"
-          - "8.1"
           - "8.2"
           - "8.3"
           - "8.4"

composer.json

@@ -12,10 +12,10 @@
     ],
     "minimum-stability": "dev",
     "require": {
-        "php": ">= 7.4.0"
+        "php": ">= 8.2.0"
     },
     "require-dev": {
-        "php-ds/tests": "^1.5"
+        "php-ds/tests": "^1.8"
     },
     "scripts": {
         "test"   : "php test.php",

config.m4

@@ -74,7 +74,6 @@ dnl Classes
   PHP_ADD_BUILD_DIR($ext_builddir/src/php/handlers, 1)
 
   PHP_ADD_EXTENSION_DEP(ds, spl)
-  PHP_ADD_EXTENSION_DEP(ds, json)
 fi
 
 

config.w32

@@ -89,11 +89,4 @@ if (PHP_DS != "no") {
     ]);
 
     ADD_EXTENSION_DEP('ds', 'spl');
-    var dll = get_define('PHPDLL');
-    if (null != dll.match(/^php7/)) {
-        // only require dynamic json extension for PHP 7
-        // json is built statically in PHP 8
-        // https://github.com/php/php-src/pull/5495
-        ADD_EXTENSION_DEP('ds', 'json');
-    }
 }

package.xml

@@ -153,7 +153,7 @@
     <dependencies>
         <required>
             <php>
-                <min>7.4.0</min>
+                <min>8.2.0</min>
             </php>
             <pearinstaller>
                 <min>1.4.0b1</min>

phpunit.xml

@@ -1,6 +1,6 @@
 <phpunit
-    backupGlobals           = "false"
-    backupStaticAttributes  = "false"
+    backupGlobals="false"
+    failOnWarning="false"
     >
     <testsuites>
         <testsuite name="all">

src/common.h

@@ -184,6 +184,10 @@ int name##_unserialize(                 \
     index, \
     max - 1)
 
+#define CAPACITY_INVALID(n) ds_throw_exception( \
+    spl_ce_OutOfRangeException, \
+    "Capacity must be non-negative, %ld given", (long) n)
+
 #define OFFSET_OUT_OF_BOUNDS() ds_throw_exception( \
     spl_ce_OutOfBoundsException, \
     "Offset out of bounds")
@@ -241,15 +245,13 @@ int name##_unserialize(                 \
     "Immutable objects may not be changed")
 
 // https://bugs.php.net/bug.php?id=80816
-#if PHP_VERSION_ID >= 80100
 #define spl_ce_Aggregate     zend_ce_aggregate
 #define spl_ce_ArrayAccess   zend_ce_arrayaccess
 #define spl_ce_Countable     zend_ce_countable
 #define spl_ce_Iterator      zend_ce_iterator
 #define spl_ce_Serializable  zend_ce_serializable
 #define spl_ce_Stringable    zend_ce_stringable
 #define spl_ce_Traversable   zend_ce_traversable
-#endif
 
 /**
  *

src/ds/ds_htable.c

@@ -183,11 +183,7 @@ static inline bool implements_hashable(zval *key) {
 
     } else {
         zval equals;
-#if PHP_VERSION_ID >= 80000
         zend_call_method_with_1_params(Z_OBJ_P(a), Z_OBJCE_P(a), NULL, "equals", &equals, b);
-#else
-        zend_call_method_with_1_params(a, Z_OBJCE_P(a), NULL, "equals", &equals, b);
-#endif        
         switch (Z_TYPE(equals)) {
             case IS_TRUE:
                 return true;
@@ -275,11 +271,7 @@ static uint32_t get_object_hash(zval *obj)
 {
     if (implements_hashable(obj)) {
         zval hash;
-#if PHP_VERSION_ID >= 80000
         zend_call_method_with_0_params(Z_OBJ_P(obj), Z_OBJCE_P(obj), NULL, "hash", &hash);
-#else
-        zend_call_method_with_0_params(obj, Z_OBJCE_P(obj), NULL, "hash", &hash);
-#endif         
 
         switch (Z_TYPE(hash)) {
             case IS_LONG:

src/php/arginfo.h

@@ -82,8 +82,6 @@ ZEND_ARG_TYPE_INFO(0, i, IS_LONG, 0) \
 ZEND_ARG_VARIADIC_INFO(0, v) \
 ZEND_END_ARG_INFO()
 
-#if PHP_VERSION_ID >= 80100
-
 #define ARGINFO_OFFSET_GET(name) \
     ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_TYPE_INFO_EX(arginfo_##name, 0, 1, IS_MIXED, 0) \
 	ZEND_ARG_TYPE_INFO(0, offset, IS_MIXED, 0) \
@@ -100,102 +98,21 @@ ZEND_END_ARG_INFO()
 	ZEND_ARG_TYPE_INFO(0, offset, IS_MIXED, 0) \
     ZEND_END_ARG_INFO()
 
-#elif PHP_VERSION_ID >= 80000
-
-#define ARGINFO_OFFSET_GET(name) \
-    ZEND_BEGIN_ARG_INFO_EX(arginfo_##name, 0, 0, 1) \
-	ZEND_ARG_TYPE_INFO(0, offset, IS_MIXED, 0) \
-    ZEND_END_ARG_INFO()
-
-#define ARGINFO_OFFSET_SET(name) \
-    ZEND_BEGIN_ARG_INFO_EX(arginfo_##name, 0, 0, 2) \
-	ZEND_ARG_TYPE_INFO(0, offset, IS_MIXED, 0) \
-	ZEND_ARG_TYPE_INFO(0, value, IS_MIXED, 0) \
-    ZEND_END_ARG_INFO()
-
-#define ARGINFO_OFFSET_UNSET(name) \
-    ZEND_BEGIN_ARG_INFO_EX(arginfo_##name, 0, 0, 1) \
-	ZEND_ARG_TYPE_INFO(0, offset, IS_MIXED, 0) \
-    ZEND_END_ARG_INFO()
-
-#else
-
-#define ARGINFO_OFFSET_GET(name) \
-    ZEND_BEGIN_ARG_INFO_EX(arginfo_##name, 0, 0, 1) \
-    ZEND_ARG_INFO(0, offset) \
-    ZEND_END_ARG_INFO()
-
-#define ARGINFO_OFFSET_SET(name) \
-    ZEND_BEGIN_ARG_INFO_EX(arginfo_##name, 0, 0, 2) \
-    ZEND_ARG_INFO(0, offset) \
-    ZEND_ARG_INFO(0, value) \
-    ZEND_END_ARG_INFO()
-
-#define ARGINFO_OFFSET_UNSET(name) \
-    ZEND_BEGIN_ARG_INFO_EX(arginfo_##name, 0, 0, 1) \
-    ZEND_ARG_INFO(0, offset) \
-    ZEND_END_ARG_INFO()
-
-#endif
-
-#if PHP_VERSION_ID >= 80100
-
 #define ARGINFO_NONE_RETURN_TYPE(name, type) \
     ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_TYPE_INFO_EX(arginfo_##name, 0, 0, type, 0) \
     ZEND_END_ARG_INFO()
-#else
-
-#define ARGINFO_NONE_RETURN_TYPE(name, type) \
-    ZEND_BEGIN_ARG_INFO_EX(arginfo_##name, 0, 0, 0) \
-    ZEND_END_ARG_INFO()
-
-#endif
 
-#if PHP_VERSION_ID >= 80000
 #define DS_BEGIN_ARG_WITH_RETURN_DS_INFO_EX(name, pass_by_ref, required_num_args, class_name, allow_null) \
     static const zend_internal_arg_info arginfo_##name[] = { \
         { (const char*)(zend_uintptr_t)(required_num_args), ZEND_TYPE_INIT_CLASS_CONST(PHP_DS_NS_NAME#class_name, allow_null, 0), pass_by_ref},
-#elif PHP_VERSION_ID >= 70200
-#define DS_BEGIN_ARG_WITH_RETURN_DS_INFO_EX(name, pass_by_ref, required_num_args, class_name, allow_null) \
-    static const zend_internal_arg_info arginfo_##name[] = { \
-        { (const char*)(zend_uintptr_t)(required_num_args), ZEND_TYPE_ENCODE_CLASS_CONST(PHP_DS_NS_NAME#class_name, allow_null), pass_by_ref, 0 },
-#else
-#define DS_BEGIN_ARG_WITH_RETURN_DS_INFO_EX(name, pass_by_ref, required_num_args, class_name, allow_null) \
-    static const zend_internal_arg_info arginfo_##name[] = { \
-        { (const char*)(zend_uintptr_t)(required_num_args), PHP_DS_NS_NAME#class_name, IS_OBJECT, pass_by_ref, allow_null, 0 },
-#endif
 
-#if PHP_VERSION_ID >= 80000
 #define DS_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(name, pass_by_ref, required_num_args, class_name, allow_null) \
     static const zend_internal_arg_info arginfo_##name[] = { \
         { (const char*)(zend_uintptr_t)(required_num_args), ZEND_TYPE_INIT_CLASS_CONST(class_name, allow_null, 0), pass_by_ref},
-#elif PHP_VERSION_ID >= 70200
-#define DS_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(name, pass_by_ref, required_num_args, class_name, allow_null) \
-	static const zend_internal_arg_info arginfo_##name[] = { \
-		{ (const char*)(zend_uintptr_t)(required_num_args), ZEND_TYPE_ENCODE_CLASS_CONST(class_name, allow_null), pass_by_ref, 0 },
-#else
-#define DS_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(name, pass_by_ref, required_num_args, class_name, allow_null) \
-	static const zend_internal_arg_info arginfo_##name[] = { \
-		{ (const char*)(zend_uintptr_t)(required_num_args), class_name, IS_OBJECT, pass_by_ref, allow_null, 0 },
-#endif
 
-#if PHP_VERSION_ID >= 80100
 #define DS_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(name, pass_by_ref, required_num_args, type, allow_null) \
     static const zend_internal_arg_info arginfo_##name[] = { \
         { (const char*)(zend_uintptr_t)(required_num_args), ZEND_TYPE_INIT_CODE(type, allow_null, _ZEND_ARG_INFO_FLAGS(pass_by_ref, 0, 0)) },
-#elif PHP_VERSION_ID >= 80000
-#define DS_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(name, pass_by_ref, required_num_args, type, allow_null) \
-    static const zend_internal_arg_info arginfo_##name[] = { \
-        { (const char*)(zend_uintptr_t)(required_num_args), ZEND_TYPE_INIT_CODE(type, allow_null, _ZEND_ARG_INFO_FLAGS(pass_by_ref, 0)) },
-#elif PHP_VERSION_ID >= 70200
-#define DS_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(name, pass_by_ref, required_num_args, type, allow_null) \
-	static const zend_internal_arg_info arginfo_##name[] = { \
-		{ (const char*)(zend_uintptr_t)(required_num_args), ZEND_TYPE_ENCODE(type, allow_null), pass_by_ref, 0 },
-#else
-#define DS_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(name, pass_by_ref, required_num_args, type, allow_null) \
-	static const zend_internal_arg_info arginfo_##name[] = { \
-		{ (const char*)(zend_uintptr_t)(required_num_args), NULL, type, pass_by_ref, allow_null, 0 },
-#endif
 
 #define ARGINFO_ZVAL_RETURN_BOOL(name, z) \
     DS_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(name, 0, 1, _IS_BOOL, 0) \

src/php/classes/php_collection_ce.h

@@ -15,14 +15,18 @@ PHP_DS_COLLECTION_ME(cls, copy) \
 PHP_DS_COLLECTION_ME(cls, count) \
 PHP_DS_COLLECTION_ME(cls, isEmpty) \
 PHP_DS_COLLECTION_ME(cls, jsonSerialize) \
-PHP_DS_COLLECTION_ME(cls, toArray)
+PHP_DS_COLLECTION_ME(cls, toArray) \
+PHP_DS_COLLECTION_ME(cls, __serialize) \
+PHP_DS_COLLECTION_ME(cls, __unserialize)
 
 ARGINFO_NONE_RETURN_DS(     Collection_copy, Collection);
 ARGINFO_NONE(               Collection_clear);
 ARGINFO_NONE_RETURN_LONG(   Collection_count);
 ARGINFO_NONE_RETURN_BOOL(   Collection_isEmpty);
 ARGINFO_NONE_RETURN_TYPE(   Collection_jsonSerialize, IS_MIXED);
 ARGINFO_NONE_RETURN_ARRAY(  Collection_toArray);
+ARGINFO_NONE_RETURN_ARRAY(  Collection___serialize);
+ARGINFO_ZVAL(               Collection___unserialize, data);
 
 void php_ds_register_collection();