Adding object type-hint and return-type

Zend/tests/bug26698.phpt

@@ -5,7 +5,7 @@ Bug #26698 (Thrown exceptions while evaluting argument to pass as parameter cras
 
 ini_set("report_memleaks", 0);  // the exception thrown in this test results in a memory leak, which is fine
 
-class Object
+class ObjectOne
 {
 	function getNone()
 	{
@@ -23,7 +23,7 @@ class Proxy
 	{
 		try
 		{
-			$res = new Object();
+			$res = new ObjectOne();
 			$this->three($res->getNone());
 		}
 		catch(Exception $e)
@@ -36,7 +36,7 @@ class Proxy
 	{
 		try
 		{
-			$res = new Object();
+			$res = new ObjectOne();
 			$this->three(1, $res->getNone());
 		}
 		catch(Exception $e)
@@ -49,7 +49,7 @@ class Proxy
 	{
 		try
 		{
-			$res = new Object();
+			$res = new ObjectOne();
 			$this->three(1, 2, $res->getNone());
 		}
 		catch(Exception $e)

Zend/tests/bug28444.phpt

@@ -9,7 +9,7 @@ function my_error_handler($errno, $errstr, $errfile, $errline) {
 
 set_error_handler('my_error_handler');
 
-class Object
+class ObjectOne
 {
 	public $x;
 
@@ -26,7 +26,7 @@ class Overloaded
 
 	function __construct($x)
 	{
-		$this->x = new Object($x);
+		$this->x = new ObjectOne($x);
 	}
 
 	function __get($prop)
@@ -47,7 +47,7 @@ var_dump($y->x->x);
 var_dump($y->x->x = 3);
 var_dump($y->y = 3);
 var_dump($y->y);
-var_dump($y->z = new Object(4));
+var_dump($y->z = new ObjectOne(4));
 var_dump($y->z->x);
 $t = $y->z;
 var_dump($t->x = 5);
@@ -56,7 +56,7 @@ var_dump($y->z->x = 6);
 ?>
 ===DONE===
 --EXPECTF--
-object(Object)#%d (1) {
+object(ObjectOne)#%d (1) {
   ["x"]=>
   int(2)
 }
@@ -66,9 +66,9 @@ Overloaded::__set(y,3)
 int(3)
 Overloaded::__get(y)
 int(3)
-string(55) "Object of class Object could not be converted to string"
+string(58) "Object of class ObjectOne could not be converted to string"
 Overloaded::__set(z,)
-object(Object)#%d (1) {
+object(ObjectOne)#%d (1) {
   ["x"]=>
   int(4)
 }

Zend/tests/bug60598.phpt

@@ -6,7 +6,7 @@ define('OBJECT_COUNT', 10000);
 
 $containers = array();
 
-class Object {
+class ObjectOne {
     protected $_guid = 0;
     public function __construct() {
 		global $containers;
@@ -20,7 +20,7 @@ class Object {
 }
 
 for ($i = 0; $i < OBJECT_COUNT; ++$i) {
-    new Object();
+    new ObjectOne();
 }
 
 // You probably won't see this because of the "zend_mm_heap corrupted"

Zend/tests/object_types/missing_return_type_inheritance_in_class.phpt

@@ -0,0 +1,15 @@
+--TEST--
+Missing class method a object return type during inheritance
+--FILE--
+<?php
+
+class One {
+    public function a() : object {}
+}
+
+class Two extends One {
+    public function a() {}
+}
+
+--EXPECTF--
+Fatal error: Declaration of Two::a() must be compatible with One::a(): object in %s on line 9

Zend/tests/object_types/missing_return_type_inheritance_in_interface.phpt

@@ -0,0 +1,15 @@
+--TEST--
+Missing interface method a object return type during inheritance
+--FILE--
+<?php
+
+interface One {
+    public function a() : object {}
+}
+
+interface Two extends One {
+    public function a() {}
+}
+
+--EXPECTF--
+Fatal error: Interface function One::a() cannot contain body in %s on line 4

Zend/tests/object_types/return_type_in_class.phpt

@@ -0,0 +1,26 @@
+--TEST--
+Adding a class method object return type
+--FILE--
+<?php
+
+interface One {
+    public function a() : object;
+}
+
+class Two implements One {
+    public function a() : object {}
+}
+
+$three = new class extends Two {
+    public function a() : object {
+        return 12345;
+    }
+};
+$three->a();
+--EXPECTF--
+
+Fatal error: Uncaught TypeError: Return value of class@anonymous::a() must be an object, integer returned in %s:13
+Stack trace:
+#0 %s(16): class@anonymous->a()
+#1 {main}
+  thrown in %s on line 13

Zend/tests/object_types/return_type_in_function.phpt

@@ -0,0 +1,16 @@
+--TEST--
+Adding a function object return type
+--FILE--
+<?php
+
+function a() : object {
+	return 12345;
+}
+a();
+--EXPECTF--
+
+Fatal error: Uncaught TypeError: Return value of a() must be an object, integer returned in %s:4
+Stack trace:
+#0 %s(6): a()
+#1 {main}
+  thrown in %s on line 4

Zend/tests/object_types/return_type_in_interface.phpt

@@ -0,0 +1,22 @@
+--TEST--
+Adding a interface method object return type
+--FILE--
+<?php
+
+interface One {
+    public function a() : object;
+}
+
+$two = new class implements One {
+    public function a() : object {
+        return 12345;
+    }
+};
+$two->a();
+--EXPECTF--
+
+Fatal error: Uncaught TypeError: Return value of class@anonymous::a() must be an object, integer returned in %s:9
+Stack trace:
+#0 %s(12): class@anonymous->a()
+#1 {main}
+  thrown in %s on line 9

Zend/tests/object_types/return_type_inheritance_in_class.phpt

@@ -0,0 +1,26 @@
+--TEST--
+Adding class method a object return type during inheritance is allowed
+--FILE--
+<?php
+
+class One {
+    public function a() {}
+}
+
+class Two extends One {
+    public function a() : object {}
+}
+
+$three = new class extends Two {
+    public function a() : object {
+        return 12345;
+    }
+};
+$three->a();
+
+--EXPECTF--
+Fatal error: Uncaught TypeError: Return value of class@anonymous::a() must be an object, integer returned in %s:13
+Stack trace:
+#0 %s(16): class@anonymous->a()
+#1 {main}
+  thrown in /%s on line 13

Zend/tests/object_types/return_type_inheritance_in_interface.phpt

@@ -0,0 +1,26 @@
+--TEST--
+Adding interface method a object return type during inheritance is allowed
+--FILE--
+<?php
+
+interface One {
+    public function a();
+}
+
+interface Two extends One {
+    public function a() : object;
+}
+
+$three = new class implements Two {
+    public function a() : object {
+        return 12345;
+    }
+};
+$three->a();
+
+--EXPECTF--
+Fatal error: Uncaught TypeError: Return value of class@anonymous::a() must be an object, integer returned in %s:13
+Stack trace:
+#0 %s(16): class@anonymous->a()
+#1 {main}
+  thrown in /%s on line 13

Zend/tests/object_types/return_type_reflection.phpt

@@ -0,0 +1,31 @@
+--TEST--
+Reflecting object return type
+--FILE--
+<?php
+
+interface One {
+    public function a() : object;
+}
+
+class Two implements One {
+    public function a() : object {}
+}
+
+function a() : object {}
+
+$returnTypeOne = (new ReflectionClass(One::class))->getMethod('a')->getReturnType();
+var_dump($returnTypeOne->isBuiltin(), (string)$returnTypeOne);
+
+$returnTypeTwo = (new ReflectionClass(Two::class))->getMethod('a')->getReturnType();
+var_dump($returnTypeTwo->isBuiltin(), (string)$returnTypeTwo);
+
+$returnTypea = (new ReflectionFunction('a'))->getReturnType();
+var_dump($returnTypea->isBuiltin(), (string)$returnTypea);
+
+--EXPECTF--
+bool(true)
+string(6) "object"
+bool(true)
+string(6) "object"
+bool(true)
+string(6) "object"

Zend/tests/object_types/type_hint_in_class_method.phpt

@@ -0,0 +1,19 @@
+--TEST--
+Adding a class method object type hint
+--FILE--
+<?php
+
+class One {
+    public function a(object $obj) {}
+}
+
+$one = new One();
+$one->a(new One());
+$one->a(123);
+--EXPECTF--
+
+Fatal error: Uncaught TypeError: Argument 1 passed to One::a() must be an object, integer given, called in %s:4
+Stack trace:
+#0 %s(9): One->a(123)
+#1 {main}
+  thrown in %s on line 4

Zend/tests/object_types/type_hint_in_function.phpt

@@ -0,0 +1,17 @@
+--TEST--
+Adding a function object type hint
+--FILE--
+<?php
+
+class A {}
+function a(object $obj) {}
+
+a(new A());
+a(123);
+--EXPECTF--
+
+Fatal error: Uncaught TypeError: Argument 1 passed to a() must be an object, integer given, called in %s.php on line 7 and defined in %s:4
+Stack trace:
+#0 %s(7): a(123)
+#1 {main}
+  thrown in %s on line 4

Zend/tests/object_types/type_hint_reflection.phpt

@@ -0,0 +1,31 @@
+--TEST--
+Reflecting object type hint
+--FILE--
+<?php
+
+interface One {
+    public function a(object $obj);
+}
+
+class Two implements One {
+    public function a(object $obj) {}
+}
+
+function a(object $obj) {}
+
+$typeHintOne = (new ReflectionClass(One::class))->getMethod('a')->getParameters()[0]->getType();
+var_dump($typeHintOne->isBuiltin(), (string)$typeHintOne);
+
+$typeHintTwo = (new ReflectionClass(Two::class))->getMethod('a')->getParameters()[0]->getType();
+var_dump($typeHintTwo->isBuiltin(), (string)$typeHintTwo);
+
+$typeHinta = (new ReflectionFunction('a'))->getParameters()[0]->getType();
+var_dump($typeHinta->isBuiltin(), (string)$typeHinta);
+
+--EXPECTF--
+bool(true)
+string(6) "object"
+bool(true)
+string(6) "object"
+bool(true)
+string(6) "object"

Zend/zend_compile.c

@@ -161,6 +161,7 @@ static const struct reserved_class_name reserved_class_names[] = {
 	{ZEND_STRL("true")},
 	{ZEND_STRL("void")},
 	{ZEND_STRL("iterable")},
+	{ZEND_STRL("object")},
 	{NULL, 0}
 };
 
@@ -206,6 +207,7 @@ static const builtin_type_info builtin_types[] = {
 	{ZEND_STRL("bool"), _IS_BOOL},
 	{ZEND_STRL("void"), IS_VOID},
 	{ZEND_STRL("iterable"), IS_ITERABLE},
+	{ZEND_STRL("object"), IS_OBJECT},
 	{NULL, 0, IS_UNDEF}
 };
 

Zend/zend_execute.c

@@ -616,7 +616,6 @@ static ZEND_COLD void zend_verify_type_error_common(
 {
 	zend_bool is_interface = 0;
 	*fname = ZSTR_VAL(zf->common.function_name);
-
 	if (zf->common.scope) {
 		*fsep =  "::";
 		*fclass = ZSTR_VAL(zf->common.scope->name);
@@ -642,6 +641,10 @@ static ZEND_COLD void zend_verify_type_error_common(
 		}
 	} else {
 		switch (ZEND_TYPE_CODE(arg_info->type)) {
+			case IS_OBJECT:
+				*need_msg = "be an ";
+				*need_kind = "object";
+				break;
 			case IS_CALLABLE:
 				*need_msg = "be callable";
 				*need_kind = "";