fix ClassEntry typehints (#206)

Author: brettmc

phper-sys/php_wrapper.c

@@ -516,12 +516,24 @@ phper_zend_begin_arg_with_return_obj_info_ex(bool return_reference,
 #define static
 #define const
 #if PHP_VERSION_ID >= 80000
-    ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(info, return_reference, required_num_args, class_name, allow_null)
+    zend_string *zstr = zend_string_init(class_name, strlen(class_name), /*persistent*/ 1);
+    //this macro uses class_name as a literal, so we overwrite it immediately
+    ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(infos, return_reference, required_num_args, class_name, allow_null)
+    ZEND_END_ARG_INFO()
+    zend_internal_arg_info info = infos[0];
+    #if PHP_VERSION_ID >= 80300
+        info.type.ptr = zstr;
+    #else
+        info.type.ptr = ZSTR_VAL(zstr);
+    #endif
+    info.type.type_mask = _ZEND_TYPE_NAME_BIT | (allow_null ? MAY_BE_NULL : 0);
+    return info;
 #else
     ZEND_BEGIN_ARG_INFO_EX(info, 0, return_reference, required_num_args)
-#endif
     ZEND_END_ARG_INFO()
     return info[0];
+#endif
+
 #undef static
 #undef const
 }
@@ -560,10 +572,20 @@ zend_internal_arg_info phper_zend_arg_obj_info(bool pass_by_ref,
 (void)class_name;
 (void)allow_null;
 #if PHP_VERSION_ID >= 80000
-    zend_internal_arg_info info[] = {
-        ZEND_ARG_OBJ_INFO_WITH_DEFAULT_VALUE(pass_by_ref, name, class_name, allow_null, NULL)
+    zend_string *zstr = zend_string_init(class_name, strlen(class_name), /*persistent*/ 1);
+    //this macro uses name and class_name as literals, so we overwrite them immediately
+    zend_internal_arg_info infos[] = {
+        ZEND_ARG_OBJ_INFO(pass_by_ref, name, class_name, allow_null)
     };
-    return info[0];
+    zend_internal_arg_info info = infos[0];
+    info.name = name;
+    #if PHP_VERSION_ID >= 80300
+        info.type.ptr = zstr;
+    #else
+        info.type.ptr = ZSTR_VAL(zstr);
+    #endif
+    info.type.type_mask = _ZEND_TYPE_NAME_BIT | (allow_null ? MAY_BE_NULL : 0);
+    return info;
 #elif PHP_VERSION_ID >= 70200
     zend_internal_arg_info info = {
         .name = name,

tests/integration/src/typehints.rs

@@ -58,6 +58,10 @@ pub fn integrate(module: &mut Module) {
                 .with_type_hint(ArgumentTypeHint::Mixed)
                 .with_default_value("1.23"),
         )
+        .argument(
+            Argument::new("ce")
+                .with_type_hint(ArgumentTypeHint::ClassEntry(String::from("Stringable"))),
+        )
         .return_type(ReturnType::new(ReturnTypeHint::Void));
 }
 
@@ -417,7 +421,7 @@ fn make_arg_typehint_class() -> ClassEntity<()> {
             phper::ok(())
         })
         .argument(
-            Argument::new("classentry")
+            Argument::new("some_class_entry")
                 .with_type_hint(ArgumentTypeHint::ClassEntry(String::from(I_FOO))),
         );
 
@@ -426,7 +430,7 @@ fn make_arg_typehint_class() -> ClassEntity<()> {
             phper::ok(())
         })
         .argument(
-            Argument::new("classentry")
+            Argument::new("some_class_entry")
                 .with_type_hint(ArgumentTypeHint::ClassEntry(String::from(I_FOO)))
                 .allow_null(),
         );

tests/integration/tests/php/typehints.php

@@ -58,9 +58,9 @@
 
     ['testNull', 'null', true, true, '8.2'],
 
-    ['testClassEntry', 'class_name', false, true, '8.0'],
-    ['testClassEntryOptional', 'class_name', false, false, '8.0'],
-    ['testClassEntryNullable', 'class_name', true, true, '8.0'],
+    ['testClassEntry', 'IntegrationTest\\TypeHints\\IFoo', false, true, '8.0'],
+    ['testClassEntryOptional', 'IntegrationTest\\TypeHints\\IFoo', false, false, '8.0'],
+    ['testClassEntryNullable', 'IntegrationTest\\TypeHints\\IFoo', true, true, '8.0'],
 ];
 
 // typehints
@@ -113,8 +113,8 @@
     ['returnMixed', 'mixed', true, '8.0'],
     ['returnNever', 'never', false, '8.1'],
     ['returnVoid', 'void', false],
-    ['returnClassEntry', 'class_name', false, '8.0'],
-    ['returnClassEntryNullable', 'class_name', true, '8.0'],
+    ['returnClassEntry', 'IntegrationTest\\TypeHints\\IFoo', false, '8.0'],
+    ['returnClassEntryNullable', 'IntegrationTest\\TypeHints\\IFoo', true, '8.0'],
 ];
 echo PHP_EOL . 'Testing return typehints' . PHP_EOL;
 $cls = new \IntegrationTest\TypeHints\ReturnTypeHintTest();
@@ -186,13 +186,14 @@ public function setValue($value): void {
 }
 
 $expectedArgs = [
+    // <arg name>, <type>, <default value>
     ['s', 'string', 'foobarbaz'],
     ['i', 'int', 42],
     ['f', 'float', 7.89],
     ['b', 'bool', true],
     ['a', 'array', ['a'=>'b']],
     ['m', 'mixed', 1.23],
-
+    ['ce', 'Stringable'], //default value not supported for ClassEntry
 ];
 if (PHP_VERSION_ID >= 80000) {
     echo PHP_EOL . 'Testing function typehints' . PHP_EOL;
@@ -202,7 +203,9 @@ public function setValue($value): void {
         echo(sprintf("argument %d..", $i));
         assert_eq($input[0], $params[$i]->getName(), sprintf('argument %d has correct name', $i));
         assert_eq($input[1], $params[$i]->getType()->getName(), sprintf('argument %d has correct type', $i));
-        assert_eq($input[2], $params[$i]->getDefaultValue(), sprintf('argument %d has correct default value', $i));
+        if (array_key_exists(2, $input)) {
+            assert_eq($input[2], $params[$i]->getDefaultValue(), sprintf('argument %d has correct default value', $i));
+        }
         echo "PASS" . PHP_EOL;
     }
     assert_eq('void', $reflection->getReturnType()->getName(), 'integration_function_typehints return type is void');