ext/reflection: make getDocComment() methods return empty string instead of false

Girgias · Girgias · commit d03aa48bfcd9 · 2025-06-24T16:30:32.000+01:00
Returning false is just annoying for non-existent doc comment
diff --git a/ext/reflection/php_reflection.c b/ext/reflection/php_reflection.c
@@ -2035,7 +2035,7 @@ ZEND_METHOD(ReflectionFunctionAbstract, getDocComment)
 		RETURN_STR_COPY(((zend_internal_function *) fptr)->doc_comment);
 	}
 
-	RETURN_FALSE;
+	RETURN_EMPTY_STRING();
 }
 /* }}} */
 
@@ -4006,7 +4006,7 @@ ZEND_METHOD(ReflectionClassConstant, getDocComment)
 	if (ref->doc_comment) {
 		RETURN_STR_COPY(ref->doc_comment);
 	}
-	RETURN_FALSE;
+	RETURN_EMPTY_STRING();
 }
 /* }}} */
 
@@ -4411,7 +4411,7 @@ ZEND_METHOD(ReflectionClass, getDocComment)
 	if (ce->doc_comment) {
 		RETURN_STR_COPY(ce->doc_comment);
 	}
-	RETURN_FALSE;
+	RETURN_EMPTY_STRING();
 }
 /* }}} */
 
@@ -6335,7 +6335,7 @@ ZEND_METHOD(ReflectionProperty, getDocComment)
 	if (ref->prop && ref->prop->doc_comment) {
 		RETURN_STR_COPY(ref->prop->doc_comment);
 	}
-	RETURN_FALSE;
+	RETURN_EMPTY_STRING();
 }
 /* }}} */
 
diff --git a/ext/reflection/php_reflection.stub.php b/ext/reflection/php_reflection.stub.php
@@ -60,7 +60,7 @@ public function getClosureCalledClass(): ?ReflectionClass {}
     public function getClosureUsedVariables(): array {}
 
     /** @tentative-return-type */
-    public function getDocComment(): string|false {}
+    public function getDocComment(): string {}
 
     /** @tentative-return-type */
     public function getEndLine(): int|false {}
@@ -286,7 +286,7 @@ public function getStartLine(): int|false {}
     public function getEndLine(): int|false {}
 
     /** @tentative-return-type */
-    public function getDocComment(): string|false {}
+    public function getDocComment(): string {}
 
     /** @tentative-return-type */
     public function getConstructor(): ?ReflectionMethod {}
@@ -537,7 +537,7 @@ public function getModifiers(): int {}
     public function getDeclaringClass(): ReflectionClass {}
 
     /** @tentative-return-type */
-    public function getDocComment(): string|false {}
+    public function getDocComment(): string {}
 
     /** @tentative-return-type */
     public function setAccessible(bool $accessible): void {}
@@ -615,7 +615,7 @@ public function getModifiers(): int {}
     public function getDeclaringClass(): ReflectionClass {}
 
     /** @tentative-return-type */
-    public function getDocComment(): string|false {}
+    public function getDocComment(): string {}
 
     public function getAttributes(?string $name = null, int $flags = 0): array {}
 
diff --git a/ext/reflection/php_reflection_arginfo.h b/ext/reflection/php_reflection_arginfo.h
diff --git a/ext/reflection/tests/005.phpt b/ext/reflection/tests/005.phpt
@@ -49,6 +49,6 @@ foreach($r->getMethods() as $m)
 --EXPECT--
 string(19) "Comment for class A"
 string(15) "Method A::bla()"
-bool(false)
-bool(false)
+string(0) ""
+string(0) ""
 string(22) "* Comment for A::baz()"
diff --git a/ext/reflection/tests/ReflectionClassConstant_basic1.phpt b/ext/reflection/tests/ReflectionClassConstant_basic1.phpt
@@ -145,7 +145,7 @@ object(ReflectionClass)#3 (1) {
   string(9) "TestClass"
 }
 getDocComment():
-bool(false)
+string(0) ""
 hasType():
 bool(false)
 getType():
@@ -177,7 +177,7 @@ object(ReflectionClass)#3 (1) {
   string(9) "TestClass"
 }
 getDocComment():
-bool(false)
+string(0) ""
 hasType():
 bool(false)
 getType():
@@ -209,7 +209,7 @@ object(ReflectionClass)#3 (1) {
   string(9) "TestClass"
 }
 getDocComment():
-bool(false)
+string(0) ""
 hasType():
 bool(false)
 getType():
diff --git a/ext/reflection/tests/ReflectionClass_getDocComment_001.phpt b/ext/reflection/tests/ReflectionClass_getDocComment_001.phpt
@@ -73,19 +73,19 @@ string(26) "/** My DocComment for B */"
 
 
 ---> Doc comment for class C:
-bool(false)
+string(0) ""
 
 
 ---> Doc comment for class D:
-bool(false)
+string(0) ""
 
 
 ---> Doc comment for class E:
-bool(false)
+string(0) ""
 
 
 ---> Doc comment for class F:
-bool(false)
+string(0) ""
 
 
 ---> Doc comment for class G:
diff --git a/ext/reflection/tests/ReflectionClass_toString_001.phpt b/ext/reflection/tests/ReflectionClass_toString_001.phpt
@@ -119,7 +119,7 @@ Class [ <internal:Reflection> class ReflectionClass implements Stringable, Refle
 
       - Parameters [0] {
       }
-      - Tentative return [ string|false ]
+      - Tentative return [ string ]
     }
 
     Method [ <internal:Reflection> public method getConstructor ] {
diff --git a/ext/reflection/tests/ReflectionEnumUnitCase_getDocComment.phpt b/ext/reflection/tests/ReflectionEnumUnitCase_getDocComment.phpt
@@ -18,6 +18,6 @@ var_dump((new ReflectionClassConstant(Foo::class, 'Baz'))->getDocComment());
 ?>
 --EXPECT--
 string(26) "/** Example doc comment */"
-bool(false)
+string(0) ""
 string(26) "/** Example doc comment */"
-bool(false)
+string(0) ""
diff --git a/ext/reflection/tests/ReflectionFunction_getDocComment.001.phpt b/ext/reflection/tests/ReflectionFunction_getDocComment.001.phpt
@@ -38,5 +38,5 @@ dumpFuncInfo('extract');
 string(%d) "/**
  * my doc comment
  */"
-bool(false)
-bool(false)
+string(0) ""
+string(0) ""
diff --git a/ext/reflection/tests/ReflectionMethod_getDocComment_basic.phpt b/ext/reflection/tests/ReflectionMethod_getDocComment_basic.phpt
@@ -88,7 +88,7 @@ string(%d) "/**
 
 
 ---> Doc comment for B::f():
-bool(false)
+string(0) ""
 
 
 ---> Doc comment for B::privf():
diff --git a/ext/reflection/tests/ReflectionMethod_getDocComment_property_list.phpt b/ext/reflection/tests/ReflectionMethod_getDocComment_property_list.phpt
@@ -36,6 +36,6 @@ string(24) "/**
      * doc 1
      */"
 X::y
-bool(false)
+string(0) ""
 X::z
 string(12) "/** doc 2 */"
diff --git a/ext/reflection/tests/ReflectionProperty_basic2.phpt b/ext/reflection/tests/ReflectionProperty_basic2.phpt
@@ -60,7 +60,7 @@ object(ReflectionClass)#%d (1) {
   string(9) "TestClass"
 }
 getDocComment():
-bool(false)
+string(0) ""
 
 **********************************
 **********************************
@@ -78,7 +78,7 @@ object(ReflectionClass)#%d (1) {
   string(9) "TestClass"
 }
 getDocComment():
-bool(false)
+string(0) ""
 
 **********************************
 **********************************
@@ -116,7 +116,7 @@ object(ReflectionClass)#%d (1) {
   string(9) "TestClass"
 }
 getDocComment():
-bool(false)
+string(0) ""
 
 **********************************
 **********************************
@@ -134,6 +134,6 @@ object(ReflectionClass)#%d (1) {
   string(9) "TestClass"
 }
 getDocComment():
-bool(false)
+string(0) ""
 
 **********************************
diff --git a/ext/reflection/tests/ReflectionProperty_getDocComment_basic.phpt b/ext/reflection/tests/ReflectionProperty_getDocComment_basic.phpt
@@ -50,11 +50,11 @@ string(%d) "/**
 
 
 ---> Doc comment for A::$b:
-bool(false)
+string(0) ""
 
 
 ---> Doc comment for A::$c:
-bool(false)
+string(0) ""
 
 
 ---> Doc comment for A::$d:
@@ -64,7 +64,7 @@ string(%d) "/**
 
 
 ---> Doc comment for A::$e:
-bool(false)
+string(0) ""
 
 
 ---> Doc comment for A::$f:
@@ -74,15 +74,15 @@ string(%d) "/**
 
 
 ---> Doc comment for B::$a:
-bool(false)
+string(0) ""
 
 
 ---> Doc comment for B::$b:
 string(%d) "/** A doc comment for $b */"
 
 
 ---> Doc comment for B::$c:
-bool(false)
+string(0) ""
 
 
 ---> Doc comment for B::$e:
diff --git a/ext/reflection/tests/bug50174.phpt b/ext/reflection/tests/bug50174.phpt
diff --git a/ext/reflection/tests/bug55156.phpt b/ext/reflection/tests/bug55156.phpt
diff --git a/ext/reflection/tests/bug64936.phpt b/ext/reflection/tests/bug64936.phpt

Original file line number	Diff line number	Diff line change
`@@ -2035,7 +2035,7 @@ ZEND_METHOD(ReflectionFunctionAbstract, getDocComment)`
`2035`	`2035`	`RETURN_STR_COPY(((zend_internal_function *) fptr)->doc_comment);`
`2036`	`2036`	`}`
`2037`	`2037`
`2038`		`- RETURN_FALSE;`
	`2038`	`+ RETURN_EMPTY_STRING();`
`2039`	`2039`	`}`
`2040`	`2040`	`/* }}} */`
`2041`	`2041`
`@@ -4006,7 +4006,7 @@ ZEND_METHOD(ReflectionClassConstant, getDocComment)`
`4006`	`4006`	`if (ref->doc_comment) {`
`4007`	`4007`	`RETURN_STR_COPY(ref->doc_comment);`
`4008`	`4008`	`}`
`4009`		`- RETURN_FALSE;`
	`4009`	`+ RETURN_EMPTY_STRING();`
`4010`	`4010`	`}`
`4011`	`4011`	`/* }}} */`
`4012`	`4012`
`@@ -4411,7 +4411,7 @@ ZEND_METHOD(ReflectionClass, getDocComment)`
`4411`	`4411`	`if (ce->doc_comment) {`
`4412`	`4412`	`RETURN_STR_COPY(ce->doc_comment);`
`4413`	`4413`	`}`
`4414`		`- RETURN_FALSE;`
	`4414`	`+ RETURN_EMPTY_STRING();`
`4415`	`4415`	`}`
`4416`	`4416`	`/* }}} */`
`4417`	`4417`
`@@ -6335,7 +6335,7 @@ ZEND_METHOD(ReflectionProperty, getDocComment)`
`6335`	`6335`	`if (ref->prop && ref->prop->doc_comment) {`
`6336`	`6336`	`RETURN_STR_COPY(ref->prop->doc_comment);`
`6337`	`6337`	`}`
`6338`		`- RETURN_FALSE;`
	`6338`	`+ RETURN_EMPTY_STRING();`
`6339`	`6339`	`}`
`6340`	`6340`	`/* }}} */`
`6341`	`6341`
Original file line number	Diff line number	Diff line change
`@@ -119,7 +119,7 @@ Class [ <internal:Reflection> class ReflectionClass implements Stringable, Refle`
`119`	`119`
`120`	`120`	`- Parameters [0] {`
`121`	`121`	`}`
`122`		`- - Tentative return [ string\|false ]`
	`122`	`+ - Tentative return [ string ]`
`123`	`123`	`}`
`124`	`124`
`125`	`125`	`Method [ <internal:Reflection> public method getConstructor ] {`