#171 Add serialization and deserialization support for PHP 8.1 Enums.

Author: seyfahni

msgpack_pack.c

@@ -6,6 +6,10 @@
 #include "ext/standard/php_incomplete_class.h"
 #include "ext/standard/php_var.h"
 
+#if PHP_VERSION_ID >= 80100
+#include "Zend/zend_enum.h"
+#endif
+
 #include "php_msgpack.h"
 #include "msgpack_pack.h"
 #include "msgpack_errors.h"
@@ -410,6 +414,19 @@ static inline void msgpack_serialize_object(smart_str *buf, zval *val, HashTable
         PHP_CLEANUP_CLASS_ATTRIBUTES();
         return;
     }
+    if (ce && (ce->ce_flags & ZEND_ACC_ENUM)) {
+        zval *enum_case_name = zend_enum_fetch_case_name(Z_OBJ_P(val_noref));
+        msgpack_pack_map(buf, 2);
+
+        msgpack_pack_nil(buf);
+        msgpack_pack_long(buf, MSGPACK_SERIALIZE_TYPE_ENUM);
+
+        msgpack_serialize_string(buf, ZSTR_VAL(ce->name), ZSTR_LEN(ce->name));
+        msgpack_serialize_string(buf, Z_STRVAL_P(enum_case_name), Z_STRLEN_P(enum_case_name));
+
+        PHP_CLEANUP_CLASS_ATTRIBUTES();
+        return;
+    }
 #endif
 
 #if PHP_VERSION_ID >= 70400

msgpack_pack.h

@@ -19,6 +19,7 @@ enum msgpack_serialize_type
     MSGPACK_SERIALIZE_TYPE_CUSTOM_OBJECT,
     MSGPACK_SERIALIZE_TYPE_OBJECT,
     MSGPACK_SERIALIZE_TYPE_OBJECT_REFERENCE,
+    MSGPACK_SERIALIZE_TYPE_ENUM,
 };
 
 void msgpack_serialize_var_init(msgpack_serialize_data_t *var_hash);

msgpack_unpack.c

@@ -2,6 +2,10 @@
 #include "php_ini.h"
 #include "ext/standard/php_incomplete_class.h"
 
+#if PHP_VERSION_ID >= 80100
+#include "Zend/zend_enum.h"
+#endif
+
 #include "php_msgpack.h"
 #include "msgpack_pack.h"
 #include "msgpack_unpack.h"
@@ -617,6 +621,7 @@ int msgpack_unserialize_map_item(msgpack_unpack_data *unpack, zval **container,
                     case MSGPACK_SERIALIZE_TYPE_CUSTOM_OBJECT:
                     case MSGPACK_SERIALIZE_TYPE_OBJECT_REFERENCE:
                     case MSGPACK_SERIALIZE_TYPE_OBJECT:
+                    case MSGPACK_SERIALIZE_TYPE_ENUM:
                         unpack->type = Z_LVAL_P(val);
                         break;
                     default:
@@ -674,6 +679,26 @@ int msgpack_unserialize_map_item(msgpack_unpack_data *unpack, zval **container,
                     return 0;
                 }
 
+                case MSGPACK_SERIALIZE_TYPE_ENUM:
+                {
+                    if (Z_TYPE_P(key) != IS_STRING) {
+                        MSGPACK_UNSERIALIZE_FINISH_MAP_ITEM(unpack, key, val);
+                        return MSGPACK_UNPACK_PARSE_ERROR;
+                    }
+
+#if PHP_VERSION_ID < 80100
+                    MSGPACK_WARNING(
+                        "[msgpack] (%s) Class %s is an Enum and not supported below PHP 8.1",
+                        __FUNCTION__, Z_STRVAL_P(key));
+#else
+                    ce = msgpack_unserialize_class(container, Z_STR_P(key), 0);
+                    zend_object *enum_instance = zend_enum_get_case(ce, Z_STR_P(val));
+                    ZVAL_OBJ(*container, enum_instance);
+#endif
+                    MSGPACK_UNSERIALIZE_FINISH_MAP_ITEM(unpack, key, val);
+                    return 0;
+                }
+
                 case MSGPACK_SERIALIZE_TYPE_RECURSIVE:
                 case MSGPACK_SERIALIZE_TYPE_OBJECT:
                 case MSGPACK_SERIALIZE_TYPE_OBJECT_REFERENCE:

tests/issue171.phpt

@@ -0,0 +1,31 @@
+--TEST--
+Issue #171 (Serializing & Unserializing Enum)
+--SKIPIF--
+<?php
+if (!extension_loaded("msgpack")) {
+    exit('skip because msgpack extension is missing');
+}
+if (version_compare(PHP_VERSION, '8.1.0', '<')) {
+    exit('skip Enum tests in PHP older than 8.1.0');
+}
+?>
+--FILE--
+Test
+<?php
+enum TestEnum {
+    case EITHER;
+    case OTHER;
+}
+
+$packed = msgpack_pack(TestEnum::OTHER);
+var_dump(bin2hex($packed));
+
+$unpacked = msgpack_unpack($packed);
+var_dump($unpacked);
+?>
+OK
+--EXPECT--
+Test
+string(36) "82c006a854657374456e756da54f54484552"
+enum(TestEnum::OTHER)
+OK