Require stubs to declare return types for magic methods when possible

kocsismate · kocsismate · commit 47bbfe1fc085 · 2020-10-23T16:33:16.000+02:00
Closes GH-6376
diff --git a/Zend/zend_exceptions.stub.php b/Zend/zend_exceptions.stub.php
@@ -22,10 +22,11 @@ public function getTraceAsString(): string;
 
 class Exception implements Throwable
 {
-    final private function __clone() {}
+    final private function __clone(): void {}
 
     public function __construct(string $message = "", int $code = 0, ?Throwable $previous = null) {}
 
+    /** @return void */
     public function __wakeup() {}
 
     final public function getMessage(): string {}
@@ -56,12 +57,15 @@ final public function getSeverity(): int {}
 class Error implements Throwable
 {
     /** @implementation-alias Exception::__clone */
-    final private function __clone() {}
+    final private function __clone(): void {}
 
     /** @implementation-alias Exception::__construct */
     public function __construct(string $message = "", int $code = 0, ?Throwable $previous = null) {}
 
-    /** @implementation-alias Exception::__wakeup */
+    /**
+     * @return void
+     * @implementation-alias Exception::__wakeup
+     */
     public function __wakeup() {}
 
     /** @implementation-alias Exception::getMessage */
diff --git a/Zend/zend_exceptions_arginfo.h b/Zend/zend_exceptions_arginfo.h
@@ -1,5 +1,5 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: bc49b326136997660887b12f0c59f8a57b17ecaf */
+ * Stub hash: 3699b51b31e509c11435845c7e0d35a2608dd268 */
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Throwable_getMessage, 0, 0, IS_STRING, 0)
 ZEND_END_ARG_INFO()
@@ -20,7 +20,8 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_class_Throwable_getTraceAsString arginfo_class_Throwable_getMessage
 
-#define arginfo_class_Exception___clone arginfo_class_Throwable_getCode
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Exception___clone, 0, 0, IS_VOID, 0)
+ZEND_END_ARG_INFO()
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Exception___construct, 0, 0, 0)
 	ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, message, IS_STRING, 0, "\"\"")
@@ -57,7 +58,7 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_class_ErrorException_getSeverity arginfo_class_Throwable_getLine
 
-#define arginfo_class_Error___clone arginfo_class_Throwable_getCode
+#define arginfo_class_Error___clone arginfo_class_Exception___clone
 
 #define arginfo_class_Error___construct arginfo_class_Exception___construct
 
diff --git a/build/gen_stub.php b/build/gen_stub.php
@@ -359,9 +359,9 @@ interface FunctionOrMethodName {
     public function getDeclaration(): string;
     public function getArgInfoName(): string;
     public function __toString(): string;
-    public function isMagicMethod(): bool;
     public function isMethod(): bool;
     public function isConstructor(): bool;
+    public function isDestructor(): bool;
 }
 
 class FunctionName implements FunctionOrMethodName {
@@ -403,15 +403,15 @@ public function __toString(): string {
         return $this->name->toString();
     }
 
-    public function isMagicMethod(): bool {
+    public function isMethod(): bool {
         return false;
     }
 
-    public function isMethod(): bool {
+    public function isConstructor(): bool {
         return false;
     }
 
-    public function isConstructor(): bool {
+    public function isDestructor(): bool {
         return false;
     }
 }
@@ -443,17 +443,17 @@ public function __toString(): string {
         return "$this->className::$this->methodName";
     }
 
-    public function isMagicMethod(): bool {
-        return strpos($this->methodName, '__') === 0;
-    }
-
     public function isMethod(): bool {
         return true;
     }
 
     public function isConstructor(): bool {
         return $this->methodName === "__construct";
     }
+
+    public function isDestructor(): bool {
+        return $this->methodName === "__destruct";
+    }
 }
 
 class ReturnInfo {
@@ -879,7 +879,7 @@ function parseFunctionLike(
     }
 
     $returnType = $func->getReturnType();
-    if ($returnType === null && !$haveDocReturnType && !$name->isMagicMethod()) {
+    if ($returnType === null && !$haveDocReturnType && !$name->isConstructor() && !$name->isDestructor()) {
         throw new Exception("Missing return type for function $name()");
     }
 
diff --git a/ext/date/php_date.stub.php b/ext/date/php_date.stub.php
@@ -134,13 +134,15 @@ public function getTimestamp();
     /** @return DateInterval|false */
     public function diff(DateTimeInterface $targetObject, bool $absolute = false);
 
+    /** @return void */
     public function __wakeup();
 }
 
 class DateTime implements DateTimeInterface
 {
     public function __construct(string $datetime = "now", ?DateTimeZone $timezone = null) {}
 
+    /** @return void */
     public function __wakeup() {}
 
     /** @return DateTime */
@@ -246,6 +248,7 @@ class DateTimeImmutable implements DateTimeInterface
 {
     public function __construct(string $datetime = "now", ?DateTimeZone $timezone = null) {}
 
+    /** @return void */
     public function __wakeup() {}
 
     /** @return DateTimeZone */
@@ -363,6 +366,7 @@ public static function listAbbreviations() {}
      */
     public static function listIdentifiers(int $timezoneGroup = DateTimeZone::ALL, ?string $countryCode = null) {}
 
+    /** @return void */
     public function __wakeup() {}
 
     /** @return DateTimeZone */
@@ -385,6 +389,7 @@ public static function createFromDateString(string $datetime) {}
      */
     public function format(string $format) {}
 
+    /** @return void */
     public function __wakeup() {}
 
     /** @return DateInterval */
@@ -413,6 +418,7 @@ public function getDateInterval() {}
     /** @return int|null */
     public function getRecurrences() {}
 
+    /** @return void */
     public function __wakeup() {}
 
     /** @return DatePeriod */
diff --git a/ext/date/php_date_arginfo.h b/ext/date/php_date_arginfo.h
@@ -1,5 +1,5 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: 04954b7aac5b3ee8e789b3ddd254ad5eda299c2b */
+ * Stub hash: 07d0e6179d838847d4a5d454f8b56438f8df19c0 */
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_strtotime, 0, 1, MAY_BE_LONG|MAY_BE_FALSE)
 	ZEND_ARG_TYPE_INFO(0, datetime, IS_STRING, 0)
diff --git a/ext/reflection/php_reflection.stub.php b/ext/reflection/php_reflection.stub.php
@@ -19,7 +19,7 @@ interface Reflector extends Stringable
 abstract class ReflectionFunctionAbstract implements Reflector
 {
     /** @implementation-alias ReflectionClass::__clone */
-    final private function __clone() {}
+    final private function __clone(): void {}
 
     /** @return bool */
     public function inNamespace() {}
@@ -199,7 +199,7 @@ public function setAccessible(bool $accessible) {}
 
 class ReflectionClass implements Reflector
 {
-    final private function __clone() {}
+    final private function __clone(): void {}
 
     public function __construct(object|string $objectOrClass) {}
 
@@ -370,7 +370,7 @@ public function __construct(object $object) {}
 class ReflectionProperty implements Reflector
 {
     /** @implementation-alias ReflectionClass::__clone */
-    final private function __clone() {}
+    final private function __clone(): void {}
 
     public function __construct(object|string $class, string $property) {}
 
@@ -435,7 +435,7 @@ public function getAttributes(?string $name = null, int $flags = 0): array {}
 class ReflectionClassConstant implements Reflector
 {
     /** @implementation-alias ReflectionClass::__clone */
-    final private function __clone() {}
+    final private function __clone(): void {}
 
     public function __construct(object|string $class, string $constant) {}
 
@@ -472,7 +472,7 @@ public function getAttributes(?string $name = null, int $flags = 0): array {}
 class ReflectionParameter implements Reflector
 {
     /** @implementation-alias ReflectionClass::__clone */
-    final private function __clone() {}
+    final private function __clone(): void {}
 
     /** @param string|array|object $function */
     public function __construct($function, int|string $param) {}
@@ -551,7 +551,7 @@ public function getAttributes(?string $name = null, int $flags = 0): array {}
 abstract class ReflectionType implements Stringable
 {
     /** @implementation-alias ReflectionClass::__clone */
-    final private function __clone() {}
+    final private function __clone(): void {}
 
     /** @return bool */
     public function allowsNull() {}
@@ -576,7 +576,7 @@ public function getTypes(): array {}
 class ReflectionExtension implements Reflector
 {
     /** @implementation-alias ReflectionClass::__clone */
-    final private function __clone() {}
+    final private function __clone(): void {}
 
     public function __construct(string $name) {}
 
@@ -619,7 +619,7 @@ public function isTemporary() {}
 class ReflectionZendExtension implements Reflector
 {
     /** @implementation-alias ReflectionClass::__clone */
-    final private function __clone() {}
+    final private function __clone(): void {}
 
     public function __construct(string $name) {}
 
@@ -648,7 +648,7 @@ public static function fromArrayElement(array $array, int|string $key): ?Reflect
     public function getId(): string {}
 
     /** @implementation-alias ReflectionClass::__clone */
-    private function __clone() {}
+    private function __clone(): void {}
 
     private function __construct() {}
 }
@@ -661,7 +661,7 @@ public function isRepeated(): bool {}
     public function getArguments(): array {}
     public function newInstance(): object {}
 
-    private function __clone() {}
+    private function __clone(): void {}
 
     private function __construct() {}
 }
diff --git a/ext/reflection/php_reflection_arginfo.h b/ext/reflection/php_reflection_arginfo.h
diff --git a/ext/reflection/tests/ReflectionClass_toString_001.phpt b/ext/reflection/tests/ReflectionClass_toString_001.phpt
diff --git a/sapi/cli/tests/005.phpt b/sapi/cli/tests/005.phpt

Original file line number	Diff line number	Diff line change
`@@ -359,9 +359,9 @@ interface FunctionOrMethodName {`
`359`	`359`	`public function getDeclaration(): string;`
`360`	`360`	`public function getArgInfoName(): string;`
`361`	`361`	`public function __toString(): string;`
`362`		`- public function isMagicMethod(): bool;`
`363`	`362`	`public function isMethod(): bool;`
`364`	`363`	`public function isConstructor(): bool;`
	`364`	`+ public function isDestructor(): bool;`
`365`	`365`	`}`
`366`	`366`
`367`	`367`	`class FunctionName implements FunctionOrMethodName {`
`@@ -403,15 +403,15 @@ public function __toString(): string {`
`403`	`403`	`return $this->name->toString();`
`404`	`404`	`}`
`405`	`405`
`406`		`- public function isMagicMethod(): bool {`
	`406`	`+ public function isMethod(): bool {`
`407`	`407`	`return false;`
`408`	`408`	`}`
`409`	`409`
`410`		`- public function isMethod(): bool {`
	`410`	`+ public function isConstructor(): bool {`
`411`	`411`	`return false;`
`412`	`412`	`}`
`413`	`413`
`414`		`- public function isConstructor(): bool {`
	`414`	`+ public function isDestructor(): bool {`
`415`	`415`	`return false;`
`416`	`416`	`}`
`417`	`417`	`}`
`@@ -443,17 +443,17 @@ public function __toString(): string {`
`443`	`443`	`return "$this->className::$this->methodName";`
`444`	`444`	`}`
`445`	`445`
`446`		`- public function isMagicMethod(): bool {`
`447`		`- return strpos($this->methodName, '__') === 0;`
`448`		`- }`
`449`		`-`
`450`	`446`	`public function isMethod(): bool {`
`451`	`447`	`return true;`
`452`	`448`	`}`
`453`	`449`
`454`	`450`	`public function isConstructor(): bool {`
`455`	`451`	`return $this->methodName === "__construct";`
`456`	`452`	`}`
	`453`	`+`
	`454`	`+ public function isDestructor(): bool {`
	`455`	`+ return $this->methodName === "__destruct";`
	`456`	`+ }`
`457`	`457`	`}`
`458`	`458`
`459`	`459`	`class ReturnInfo {`
`@@ -879,7 +879,7 @@ function parseFunctionLike(`
`879`	`879`	`}`
`880`	`880`
`881`	`881`	`$returnType = $func->getReturnType();`
`882`		`- if ($returnType === null && !$haveDocReturnType && !$name->isMagicMethod()) {`
	`882`	`+ if ($returnType === null && !$haveDocReturnType && !$name->isConstructor() && !$name->isDestructor()) {`
`883`	`883`	`throw new Exception("Missing return type for function $name()");`
`884`	`884`	`}`
`885`	`885`