Expose optional return types to userland

Author: kocsismate

Zend/tests/type_declarations/variance/optional_return_type/incompatible_return_type.phpt

@@ -0,0 +1,28 @@
+--TEST--
+Test that a notice is emitted when the return type/value of the overriding method is incompatible with the optional return type/value of the overridden method
+--FILE--
+<?php
+class Foo
+{
+    #[OptionalReturnType]
+    public function x(): string|false
+    {
+        return "x";
+    }
+}
+
+class Bar extends Foo
+{
+    public function x(): array
+    {
+        return [];
+    }
+}
+
+$bar = new Bar();
+var_dump($bar->x());
+?>
+--EXPECTF--
+Strict Standards: Declaration of Bar::x(): array should be compatible with Foo::x(): string|false in %s on line %d
+array(0) {
+}

Zend/tests/type_declarations/variance/optional_return_type/incompatible_return_type2.phpt

@@ -0,0 +1,28 @@
+--TEST--
+Test that a notice is emitted when the return type/value of the overriding method is incompatible with the optional return type/value of the overridden method
+--FILE--
+<?php
+class Foo
+{
+    #[OptionalReturnType]
+    public function x(): string|false
+    {
+        return "x";
+    }
+}
+
+class Bar extends Foo
+{
+    public function x()
+    {
+        return [];
+    }
+}
+
+$bar = new Bar();
+var_dump($bar->x());
+?>
+--EXPECTF--
+Strict Standards: Declaration of Bar::x() should be compatible with Foo::x(): string|false in %s on line %d
+array(0) {
+}

Zend/tests/type_declarations/variance/optional_return_type/incompatible_return_type3.phpt

@@ -0,0 +1,34 @@
+--TEST--
+Test that the OptionalReturnType attribute is not inherited
+--FILE--
+<?php
+class Foo
+{
+    #[OptionalReturnType]
+    public function x(): string|false
+    {
+        return "x";
+    }
+}
+
+class Bar extends Foo
+{
+    public function x(): array
+    {
+        return [];
+    }
+}
+
+class Baz extends Bar
+{
+    public function x()
+    {
+        return [];
+    }
+}
+
+?>
+--EXPECTF--
+Strict Standards: Declaration of Bar::x(): array should be compatible with Foo::x(): string|false in %s on line %d
+
+Fatal error: Declaration of Baz::x() must be compatible with Bar::x(): array in %s on line %d

Zend/tests/type_declarations/variance/optional_return_type/missing_return_type.phpt

@@ -0,0 +1,17 @@
+--TEST--
+Test that a compile error is emitted if the OptionalReturnType attribute is used when the method doesn't have a return type
+--FILE--
+<?php
+
+class Foo
+{
+    #[OptionalReturnType]
+    public function x()
+    {
+        return "x";
+    }
+}
+
+?>
+--EXPECTF--
+Fatal error: OptionalReturnType attribute cannot be used when a method doesn't have any return type in %s on line %d

Zend/tests/type_declarations/variance/optional_return_type/suppressed_incompatible_return_type.phpt

@@ -0,0 +1,28 @@
+--TEST--
+Test that the notice can be suppressed when the return type/value of the overriding method is incompatible with the optional return type/value of the overridden method
+--FILE--
+<?php
+class Foo
+{
+    #[OptionalReturnType]
+    public function x(): string|false
+    {
+        return "x";
+    }
+}
+
+class Bar extends Foo
+{
+    #[SuppressOptionalReturnTypeNotice]
+    public function x(): array
+    {
+        return [];
+    }
+}
+
+$bar = new Bar();
+var_dump($bar->x());
+?>
+--EXPECTF--
+array(0) {
+}

Zend/tests/type_declarations/variance/optional_return_type/suppressed_incompatible_return_type2.phpt

@@ -0,0 +1,28 @@
+--TEST--
+Test that the notice can be suppressed when the return type/value of the overriding method is incompatible with the optional return type/value of the overridden method
+--FILE--
+<?php
+class Foo
+{
+    #[OptionalReturnType]
+    public function x(): string|false
+    {
+        return "x";
+    }
+}
+
+class Bar extends Foo
+{
+    #[SuppressOptionalReturnTypeNotice]
+    public function x()
+    {
+        return [];
+    }
+}
+
+$bar = new Bar();
+var_dump($bar->x());
+?>
+--EXPECTF--
+array(0) {
+}

Zend/tests/type_declarations/variance/optional_return_type/suppressed_incompatible_return_type3.phpt

@@ -0,0 +1,38 @@
+--TEST--
+Test that the notice can be suppressed when the return type/value of the overriding method is incompatible with the optional return type/value of the overridden method
+--FILE--
+<?php
+class Foo
+{
+    #[OptionalReturnType]
+    public function bar(): string|false
+    {
+        return "x";
+    }
+}
+
+class Bar extends Foo
+{
+    #[OptionalReturnType]
+    #[SuppressOptionalReturnTypeNotice]
+    public function x(): array
+    {
+        return [];
+    }
+}
+
+class Baz extends Bar
+{
+    public function x(): array|false
+    {
+        return [];
+    }
+}
+
+$baz = new Baz();
+var_dump($baz->x());
+?>
+--EXPECTF--
+Strict Standards: Declaration of Baz::x(): array|false should be compatible with Bar::x(): array in %s on line %d
+array(0) {
+}

Zend/tests/type_declarations/variance/optional_return_type/suppressed_incompatible_return_type4.phpt

@@ -0,0 +1,37 @@
+--TEST--
+Test that the notice can be suppressed when the return type/value of the overriding method is incompatible with the optional return type/value of the overridden method
+--FILE--
+<?php
+class Foo
+{
+    #[OptionalReturnType]
+    public function x(): string|false
+    {
+        return "x";
+    }
+}
+
+class Bar extends Foo
+{
+    public function x(): array
+    {
+        return [];
+    }
+}
+
+class Baz extends Bar
+{
+    #[SuppressOptionalReturnTypeNotice]
+    public function x(): array
+    {
+        return [];
+    }
+}
+
+$baz = new Baz();
+var_dump($baz->x());
+?>
+--EXPECTF--
+Strict Standards: Declaration of Bar::x(): array should be compatible with Foo::x(): string|false in %s on line %d
+array(0) {
+}

Zend/zend_attributes.c

@@ -24,6 +24,8 @@
 #include "zend_smart_str.h"
 
 ZEND_API zend_class_entry *zend_ce_attribute;
+ZEND_API zend_class_entry *zend_ce_optional_return_type_attribute;
+ZEND_API zend_class_entry *zend_ce_suppress_optional_return_type_notice_attribute;
 
 static HashTable internal_attributes;
 
@@ -55,6 +57,20 @@ void validate_attribute(zend_attribute *attr, uint32_t target, zend_class_entry
 	}
 }
 
+void validate_optional_return_type_attribute(zend_attribute *attr, uint32_t target, zend_class_entry *scope)
+{
+	if (target != ZEND_ATTRIBUTE_TARGET_METHOD) {
+		zend_error(E_COMPILE_ERROR, "Only methods can be marked with #[OptionalReturnType]");
+	}
+}
+
+void validate_suppress_optional_return_type_notice_attribute(zend_attribute *attr, uint32_t target, zend_class_entry *scope)
+{
+	if (target != ZEND_ATTRIBUTE_TARGET_METHOD) {
+		zend_error(E_COMPILE_ERROR, "Only methods can be marked with #[SuppressOptionalReturnTypeNotice]");
+	}
+}
+
 ZEND_METHOD(Attribute, __construct)
 {
 	zend_long flags = ZEND_ATTRIBUTE_TARGET_ALL;
@@ -67,6 +83,16 @@ ZEND_METHOD(Attribute, __construct)
 	ZVAL_LONG(OBJ_PROP_NUM(Z_OBJ_P(ZEND_THIS), 0), flags);
 }
 
+ZEND_METHOD(OptionalReturnType, __construct)
+{
+	ZEND_PARSE_PARAMETERS_NONE();
+}
+
+ZEND_METHOD(SuppressOptionalReturnTypeNotice, __construct)
+{
+	ZEND_PARSE_PARAMETERS_NONE();
+}
+
 static zend_attribute *get_attribute(HashTable *attributes, zend_string *lcname, uint32_t offset)
 {
 	if (attributes) {
@@ -278,6 +304,14 @@ void zend_register_attribute_ce(void)
 	zend_declare_class_constant_long(zend_ce_attribute, ZEND_STRL("TARGET_PARAMETER"), ZEND_ATTRIBUTE_TARGET_PARAMETER);
 	zend_declare_class_constant_long(zend_ce_attribute, ZEND_STRL("TARGET_ALL"), ZEND_ATTRIBUTE_TARGET_ALL);
 	zend_declare_class_constant_long(zend_ce_attribute, ZEND_STRL("IS_REPEATABLE"), ZEND_ATTRIBUTE_IS_REPEATABLE);
+
+	zend_ce_optional_return_type_attribute = register_class_OptionalReturnType();
+	attr = zend_internal_attribute_register(zend_ce_optional_return_type_attribute, ZEND_ATTRIBUTE_TARGET_METHOD);
+    attr->validator = validate_optional_return_type_attribute;
+
+	zend_ce_suppress_optional_return_type_notice_attribute = register_class_SuppressOptionalReturnTypeNotice();
+	attr = zend_internal_attribute_register(zend_ce_suppress_optional_return_type_notice_attribute, ZEND_ATTRIBUTE_TARGET_METHOD);
+    attr->validator = validate_suppress_optional_return_type_notice_attribute;
 }
 
 void zend_attributes_shutdown(void)

Zend/zend_attributes.stub.php

@@ -8,3 +8,13 @@ final class Attribute
 
     public function __construct(int $flags = Attribute::TARGET_ALL) {}
 }
+
+final class OptionalReturnType
+{
+    public function __construct() {}
+}
+
+final class SuppressOptionalReturnTypeNotice
+{
+    public function __construct() {}
+}

Zend/zend_attributes_arginfo.h

@@ -1,19 +1,38 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: 0183e750e66999862a7688ecb251017110d06d1f */
+ * Stub hash: cf3fa04933ca9509925d14fe5e994932b39dd757 */
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Attribute___construct, 0, 0, 0)
 	ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, flags, IS_LONG, 0, "Attribute::TARGET_ALL")
 ZEND_END_ARG_INFO()
 
+ZEND_BEGIN_ARG_INFO_EX(arginfo_class_OptionalReturnType___construct, 0, 0, 0)
+ZEND_END_ARG_INFO()
+
+#define arginfo_class_SuppressOptionalReturnTypeNotice___construct arginfo_class_OptionalReturnType___construct
+
 
 ZEND_METHOD(Attribute, __construct);
+ZEND_METHOD(OptionalReturnType, __construct);
+ZEND_METHOD(SuppressOptionalReturnTypeNotice, __construct);
 
 
 static const zend_function_entry class_Attribute_methods[] = {
 	ZEND_ME(Attribute, __construct, arginfo_class_Attribute___construct, ZEND_ACC_PUBLIC)
 	ZEND_FE_END
 };
 
+
+static const zend_function_entry class_OptionalReturnType_methods[] = {
+	ZEND_ME(OptionalReturnType, __construct, arginfo_class_OptionalReturnType___construct, ZEND_ACC_PUBLIC)
+	ZEND_FE_END
+};
+
+
+static const zend_function_entry class_SuppressOptionalReturnTypeNotice_methods[] = {
+	ZEND_ME(SuppressOptionalReturnTypeNotice, __construct, arginfo_class_SuppressOptionalReturnTypeNotice___construct, ZEND_ACC_PUBLIC)
+	ZEND_FE_END
+};
+
 static zend_class_entry *register_class_Attribute(void)
 {
 	zend_class_entry ce, *class_entry;
@@ -30,3 +49,25 @@ static zend_class_entry *register_class_Attribute(void)
 
 	return class_entry;
 }
+
+static zend_class_entry *register_class_OptionalReturnType(void)
+{
+	zend_class_entry ce, *class_entry;
+
+	INIT_CLASS_ENTRY(ce, "OptionalReturnType", class_OptionalReturnType_methods);
+	class_entry = zend_register_internal_class_ex(&ce, NULL);
+	class_entry->ce_flags |= ZEND_ACC_FINAL;
+
+	return class_entry;
+}
+
+static zend_class_entry *register_class_SuppressOptionalReturnTypeNotice(void)
+{
+	zend_class_entry ce, *class_entry;
+
+	INIT_CLASS_ENTRY(ce, "SuppressOptionalReturnTypeNotice", class_SuppressOptionalReturnTypeNotice_methods);
+	class_entry = zend_register_internal_class_ex(&ce, NULL);
+	class_entry->ce_flags |= ZEND_ACC_FINAL;
+
+	return class_entry;
+}