BC support for Reflection

Author: Girgias

Zend/zend_compile.c

@@ -6114,9 +6114,11 @@ static zend_type zend_compile_single_typename(zend_ast *ast)
 			/* Transform iterable into a type union alias */
 			if (type_code == IS_ITERABLE) {
 				zend_type iterable = (zend_type) ZEND_TYPE_INIT_CLASS(ZSTR_KNOWN(ZEND_STR_TRAVERSABLE), 0, 0);
+				ZEND_TYPE_FULL_MASK(iterable) |= _ZEND_TYPE_NAME_BIT;
 				ZEND_TYPE_FULL_MASK(iterable) |= MAY_BE_ARRAY;
+				/* Set MAY_BE_ITERABLE for BC compat during Reflection */
+				ZEND_TYPE_FULL_MASK(iterable) |= MAY_BE_ITERABLE;
 				/* Inform that the type list is a union type */
-				ZEND_TYPE_FULL_MASK(iterable) |= _ZEND_TYPE_NAME_BIT;
 				ZEND_TYPE_FULL_MASK(iterable) |= _ZEND_TYPE_UNION_BIT;
 				return iterable;
 			}

Zend/zend_type_info.h

@@ -38,6 +38,8 @@
 /* These are used in zend_type, but not for type inference.
  * They are allowed to overlap with types used during inference. */
 #define MAY_BE_CALLABLE             (1 << IS_CALLABLE)
+/* Kept as BC for reflection */
+#define MAY_BE_ITERABLE             (1 << IS_ITERABLE)
 #define MAY_BE_VOID                 (1 << IS_VOID)
 #define MAY_BE_NEVER                (1 << IS_NEVER)
 #define MAY_BE_STATIC               (1 << IS_STATIC)

ext/reflection/php_reflection.c

@@ -1320,6 +1320,7 @@ typedef enum {
 } reflection_type_kind;
 
 /* For backwards compatibility reasons, we need to return T|null style unions
+ * and transformation from iterable to Traversable|array
  * as a ReflectionNamedType. Here we determine what counts as a union type and
  * what doesn't. */
 static reflection_type_kind get_type_kind(zend_type type) {
@@ -1334,6 +1335,10 @@ static reflection_type_kind get_type_kind(zend_type type) {
 	}
 
 	if (ZEND_TYPE_IS_COMPLEX(type)) {
+		/* BC support for 'iterable' type */
+		if (type_mask_without_null == (MAY_BE_ARRAY|MAY_BE_ITERABLE)) {
+			return NAMED_TYPE;
+		}
 		if (type_mask_without_null != 0) {
 			return UNION_TYPE;
 		}
@@ -1362,6 +1367,10 @@ static void reflection_type_factory(zend_type type, zval *object, bool legacy_be
 			reflection_instantiate(reflection_intersection_type_ptr, object);
 			break;
 		case UNION_TYPE:
+			/* Clear fake iterable type */
+			if ((ZEND_TYPE_PURE_MASK(type) & MAY_BE_ITERABLE) != 0) {
+				ZEND_TYPE_FULL_MASK(type) &= ~MAY_BE_ITERABLE;
+			}
 			reflection_instantiate(reflection_union_type_ptr, object);
 			break;
 		case NAMED_TYPE:
@@ -2982,9 +2991,17 @@ ZEND_METHOD(ReflectionType, allowsNull)
 }
 /* }}} */
 
+/* BC for iterable */
+static zend_string *zend_type_to_string_ex(zend_type type) {
+	if (UNEXPECTED((ZEND_TYPE_PURE_MASK(type) & MAY_BE_ITERABLE) != 0)) {
+		return ZSTR_KNOWN(ZEND_STR_ITERABLE);
+	}
+	return zend_type_to_string(type);
+}
+
 static zend_string *zend_type_to_string_without_null(zend_type type) {
 	ZEND_TYPE_FULL_MASK(type) &= ~MAY_BE_NULL;
-	return zend_type_to_string(type);
+	return zend_type_to_string_ex(type);
 }
 
 /* {{{ Return the text of the type hint */
@@ -2998,7 +3015,7 @@ ZEND_METHOD(ReflectionType, __toString)
 	}
 	GET_REFLECTION_OBJECT_PTR(param);
 
-	RETURN_STR(zend_type_to_string(param->type));
+	RETURN_STR(zend_type_to_string_ex(param->type));
 }
 /* }}} */
 
@@ -3016,7 +3033,7 @@ ZEND_METHOD(ReflectionNamedType, getName)
 	if (param->legacy_behavior) {
 		RETURN_STR(zend_type_to_string_without_null(param->type));
 	}
-	RETURN_STR(zend_type_to_string(param->type));
+	RETURN_STR(zend_type_to_string_ex(param->type));
 }
 /* }}} */
 
@@ -3079,6 +3096,9 @@ ZEND_METHOD(ReflectionUnionType, getTypes)
 	if (type_mask & MAY_BE_CALLABLE) {
 		append_type_mask(return_value, MAY_BE_CALLABLE);
 	}
+	if (type_mask & MAY_BE_ITERABLE) {
+		append_type_mask(return_value, MAY_BE_ITERABLE);
+	}
 	if (type_mask & MAY_BE_OBJECT) {
 		append_type_mask(return_value, MAY_BE_OBJECT);
 	}

ext/reflection/tests/ReflectionClass_isArray.phpt

@@ -21,7 +21,7 @@ Deprecated: Method ReflectionParameter::isArray() is deprecated in %s on line %d
 bool(true)
 
 Deprecated: Method ReflectionParameter::isArray() is deprecated in %s on line %d
-bool(true)
+bool(false)
 
 Deprecated: Method ReflectionParameter::isArray() is deprecated in %s on line %d
 bool(false)

ext/reflection/tests/ReflectionType_001.phpt

@@ -95,7 +95,7 @@ foreach ($reflector->getProperties() as $name => $property) {
             printf("public %s $%s;\n", $type->getName(), $property->getName());
         } else {
             echo 'public ', implode('|', $type->getTypes()),
-                ' $', $property->getName(), "\n";
+                ' $', $property->getName(), ";\n";
         }
     } else printf("public $%s;\n", $property->getName());
 }
@@ -221,7 +221,7 @@ string(4) "Test"
 public int $int;
 public string $string;
 public array $arr;
-public Traversable|array $iterable
+public iterable $iterable;
 public stdClass $std;
 public OtherThing $other;
 public $mixed;

ext/reflection/tests/ReflectionType_possible_types.phpt

@@ -33,5 +33,5 @@ string(6) "string"
 string(4) "bool"
 string(5) "array"
 string(8) "callable"
-string(17) "Traversable|array"
+string(8) "iterable"
 string(8) "StdClass"

ext/reflection/tests/bug72661.phpt

@@ -7,4 +7,4 @@ function test(iterable $arg) { }
 var_dump((string)(new ReflectionParameter("test", 0))->getType());
 ?>
 --EXPECT--
-string(17) "Traversable|array"
+string(8) "iterable"