Declare tentative return types for ext/standard (php#7065)

kocsismate · web-flow · commit 48981f4f1e34 · 2021-05-28T15:46:04.000+02:00
diff --git a/Zend/tests/bug21478.phpt b/Zend/tests/bug21478.phpt
@@ -3,7 +3,7 @@ Bug #21478 (Zend/zend_alloc.c :: shutdown_memory_manager produces segfault)
 --FILE--
 <?php
 class debugfilter extends php_user_filter {
-  function filter($in, $out, &$consumed, $closing) {
+  function filter($in, $out, &$consumed, $closing): int {
     while ($bucket = stream_bucket_make_writeable($in)) {
       $bucket->data = strtoupper($bucket->data);
       stream_bucket_append($out, $bucket);
diff --git a/Zend/tests/bug78406.phpt b/Zend/tests/bug78406.phpt
@@ -10,7 +10,7 @@ if (!class_exists(SampleFilter::class)) {
     {
         private $data = '';
 
-        public function filter($in, $out, &$consumed, $closing)
+        public function filter($in, $out, &$consumed, $closing): int
         {
             while ($bucket = stream_bucket_make_writeable($in))
             {
diff --git a/ext/opcache/tests/bug64353.phpt b/ext/opcache/tests/bug64353.phpt
@@ -9,7 +9,7 @@ opcache
 --FILE--
 <?php
 class BugLoader extends php_user_filter {
-    public function filter($in, $out, &$consumed, $closing) {
+    public function filter($in, $out, &$consumed, $closing): int {
         if (!class_exists("Test")) {
             eval("class Test extends ArrayObject {}");
         }
diff --git a/ext/opcache/tests/bug74596.phpt b/ext/opcache/tests/bug74596.phpt
@@ -32,7 +32,7 @@ file_put_contents(__DIR__ . "/bug74596_2.php", "ok\n");
 
 class ufilter extends php_user_filter
 {
-    function filter($in, $out, &$consumed, $closing)
+    function filter($in, $out, &$consumed, $closing): int
     {
         include_once __DIR__ . "/bug74596_1.php";
         while ($bucket = stream_bucket_make_writeable($in)) {
diff --git a/ext/opcache/tests/jit/reg_alloc_001.phpt b/ext/opcache/tests/jit/reg_alloc_001.phpt
@@ -16,7 +16,7 @@ class Caster
     const EXCLUDE_PRIVATE = 32;
     const EXCLUDE_STRICT = 512;
 
-    public static function filter(array $a, $filter)
+    public static function filter(array $a, $filter): int
     {
         foreach ($a as $k => $v) {
             if (!isset($k[1])) {
diff --git a/ext/standard/dir.stub.php b/ext/standard/dir.stub.php
@@ -5,20 +5,20 @@
 class Directory
 {
     /**
-     * @return void
+     * @tentative-return-type
      * @implementation-alias closedir
      */
-    public function close() {}
+    public function close(): void {}
 
     /**
-     * @return void
+     * @tentative-return-type
      * @implementation-alias rewinddir
      */
-    public function rewind() {}
+    public function rewind(): void {}
 
     /**
-     * @return string|false
+     * @tentative-return-type
      * @implementation-alias readdir
      */
-    public function read() {}
+    public function read(): string|false {}
 }
diff --git a/ext/standard/dir_arginfo.h b/ext/standard/dir_arginfo.h
@@ -1,12 +1,13 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: 1fd5cc5147c7272006e59d63d68c12caec84589f */
+ * Stub hash: e3d46788bb18dc90a0922e5738442b2932dd53f6 */
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Directory_close, 0, 0, 0)
+ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_TYPE_INFO_EX(arginfo_class_Directory_close, 0, 0, IS_VOID, 0)
 ZEND_END_ARG_INFO()
 
 #define arginfo_class_Directory_rewind arginfo_class_Directory_close
 
-#define arginfo_class_Directory_read arginfo_class_Directory_close
+ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_TYPE_MASK_EX(arginfo_class_Directory_read, 0, 0, MAY_BE_STRING|MAY_BE_FALSE)
+ZEND_END_ARG_INFO()
 
 
 ZEND_FUNCTION(closedir);
diff --git a/ext/standard/tests/directory/DirectoryClass_basic_001.phpt b/ext/standard/tests/directory/DirectoryClass_basic_001.phpt
@@ -43,18 +43,21 @@ Class [ <internal%s> class Directory ] {
 
       - Parameters [0] {
       }
+      - Tentative return [ void ]
     }
 
     Method [ <internal:standard> public method rewind ] {
 
       - Parameters [0] {
       }
+      - Tentative return [ void ]
     }
 
     Method [ <internal:standard> public method read ] {
 
       - Parameters [0] {
       }
+      - Tentative return [ string|false ]
     }
   }
 }
diff --git a/ext/standard/tests/file/bug39551.phpt b/ext/standard/tests/file/bug39551.phpt
@@ -6,7 +6,7 @@ Bug #39551 (Segfault with stream_bucket_new in user filter)
 $bucket = stream_bucket_new(fopen('php://temp', 'w+'), '');
 
 class bucketFilter {
-    public function filter($in, $out, &$consumed, $closing ){
+    public function filter($in, $out, &$consumed, $closing ): int {
 
         $bucket = stream_bucket_new(fopen('php://temp', 'w+'), '');
         stream_bucket_append($out, $bucket);
diff --git a/ext/standard/tests/file/userfilters.phpt b/ext/standard/tests/file/userfilters.phpt
@@ -4,7 +4,7 @@ stream userfilter test
 <?php
 
 class testfilter extends php_user_filter {
-  function filter($in, $out, &$consumed, $closing) {
+  function filter($in, $out, &$consumed, $closing): int {
     while ($bucket = stream_bucket_make_writeable($in)) {
       $bucket->data = strtoupper($bucket->data);
       $consumed += strlen($bucket->data);
@@ -13,8 +13,9 @@ class testfilter extends php_user_filter {
     return PSFS_PASS_ON;
   }
 
-  function oncreate() {
+  function oncreate(): bool {
     echo "params: {$this->params}\n";
+    return true;
   }
 }
 
diff --git a/ext/standard/tests/filters/bug35916.phpt b/ext/standard/tests/filters/bug35916.phpt
@@ -7,21 +7,24 @@ $file = __DIR__ . "/bug35916.txt";
 
 class strtoupper_filter extends php_user_filter
 {
-        function filter($in, $out, &$consumed, $closing)
-        {
-        while($bucket=stream_bucket_make_writeable($in)) {
+    function filter($in, $out, &$consumed, $closing): int
+    {
+        while ($bucket=stream_bucket_make_writeable($in)) {
             $bucket->data = strtoupper($bucket->data);
             $consumed += $bucket->datalen;
             stream_bucket_append($out, $bucket);
             stream_bucket_append($out, $bucket);
-                }
-        return PSFS_PASS_ON;
         }
-    function onCreate()
+        return PSFS_PASS_ON;
+    }
+
+    function onCreate(): bool
     {
         echo "fffffffffff\n";
+        return true;
     }
-    function onClose()
+
+    function onClose(): void
     {
         echo "hello\n";
     }
diff --git a/ext/standard/tests/filters/bug46164-1.phpt b/ext/standard/tests/filters/bug46164-1.phpt
@@ -3,7 +3,7 @@ Bug #46164 - 1 (stream_filter_remove() closes the stream)
 --FILE--
 <?php
 class user_filter extends php_user_filter {
-    function filter($in, $out, &$consumed, $closing) {
+    function filter($in, $out, &$consumed, $closing): int {
         while($bucket = stream_bucket_make_writeable($in)) {
             $consumed += $bucket->datalen;
             stream_bucket_append($out, $bucket);
diff --git a/ext/standard/tests/filters/bug46164-2.phpt b/ext/standard/tests/filters/bug46164-2.phpt
@@ -3,7 +3,7 @@ Bug #46164 - 2 (stream_filter_remove() closes the stream)
 --FILE--
 <?php
 class user_filter extends php_user_filter {
-    function filter($in, $out, &$consumed, $closing) {
+    function filter($in, $out, &$consumed, $closing): int {
         while($bucket = stream_bucket_make_writeable($in)) {
             $consumed += $bucket->datalen;
             stream_bucket_append($out, $bucket);
diff --git a/ext/standard/tests/filters/bug72941.phpt b/ext/standard/tests/filters/bug72941.phpt
@@ -4,7 +4,7 @@ Bug #72941 (Modifying bucket->data by-ref has no effect any longer)
 <?php
 class rotate_filter_nw extends php_user_filter
 {
-    function filter($in, $out, &$consumed, $closing)
+    function filter($in, $out, &$consumed, $closing): int
     {
         while ($bucket = stream_bucket_make_writeable($in)) {
             $this->rotate($bucket->data);
diff --git a/ext/standard/tests/filters/bug73586.phpt b/ext/standard/tests/filters/bug73586.phpt
@@ -4,7 +4,7 @@ Bug #73586 (php_user_filter::$stream is not set to the stream the filter is work
 <?php
 class append_filter extends php_user_filter {
     public $stream;
-    function filter($in, $out, &$consumed, $closing) {
+    function filter($in, $out, &$consumed, $closing): int {
         while ($bucket = stream_bucket_make_writeable($in)) {
             $consumed += $bucket->datalen;
             stream_bucket_append($out, $bucket);
@@ -25,7 +25,7 @@ stream_copy_to_stream($fin, STDOUT);
 <?php
 class append_filter extends php_user_filter {
     public $stream;
-    function filter($in, $out, &$consumed, $closing) {
+    function filter($in, $out, &$consumed, $closing): int {
         while ($bucket = stream_bucket_make_writeable($in)) {
             $consumed += $bucket->datalen;
             stream_bucket_append($out, $bucket);
diff --git a/ext/standard/tests/filters/filter_errors_user.phpt b/ext/standard/tests/filters/filter_errors_user.phpt
@@ -5,18 +5,18 @@ Filter errors: user filter
 require 'filter_errors.inc';
 
 class test_filter0 extends php_user_filter {
-    function filter($in, $out, &$consumed, $closing) {
+    function filter($in, $out, &$consumed, $closing): int {
         return PSFS_ERR_FATAL;
     }
 }
 class test_filter1 extends php_user_filter {
-    function filter($in, $out, &$consumed, $closing) {
+    function filter($in, $out, &$consumed, $closing): int {
         $bucket = stream_bucket_make_writeable($in);
         return PSFS_ERR_FATAL;
     }
 }
 class test_filter2 extends php_user_filter {
-    function filter($in, $out, &$consumed, $closing) {
+    function filter($in, $out, &$consumed, $closing): int {
         while ($bucket = stream_bucket_make_writeable($in)) {
             $consumed += $bucket->datalen;
             stream_bucket_append($out, $bucket);
@@ -25,7 +25,7 @@ class test_filter2 extends php_user_filter {
     }
 }
 class test_filter3 extends php_user_filter {
-    function filter($in, $out, &$consumed, $closing) {
+    function filter($in, $out, &$consumed, $closing): int {
         if (!$closing) {
             $bucket = stream_bucket_new($this->stream, "42");
             stream_bucket_append($out, $bucket);
@@ -34,7 +34,7 @@ class test_filter3 extends php_user_filter {
     }
 }
 class test_filter4 extends php_user_filter {
-    function filter($in, $out, &$consumed, $closing) {
+    function filter($in, $out, &$consumed, $closing): int {
         if (!$closing) {
             $bucket = stream_bucket_new($this->stream, "42");
         }
diff --git a/ext/standard/tests/filters/php_user_filter_01.phpt b/ext/standard/tests/filters/php_user_filter_01.phpt
@@ -3,15 +3,15 @@ class php_user_filter#1
 --FILE--
 <?php
 class foo extends php_user_filter {
-    function filter($in, $out, &$consumed, $closing) {}
-    function onCreate() {}
-    function onClose() {}
+    function filter($in, $out, &$consumed, $closing): int {}
+    function onCreate(): bool {}
+    function onClose(): void {}
 }
 class bar extends php_user_filter {
-    function filter($in, $out, &$consumed) {}
-    function onCreate() {}
-    function onClose() {}
+    function filter($in, $out, &$consumed): int {}
+    function onCreate(): bool {}
+    function onClose(): void {}
 }
 ?>
 --EXPECTF--
-Fatal error: Declaration of bar::filter($in, $out, &$consumed) must be compatible with php_user_filter::filter($in, $out, &$consumed, bool $closing) in %s on line %d
+Fatal error: Declaration of bar::filter($in, $out, &$consumed): int must be compatible with php_user_filter::filter($in, $out, &$consumed, bool $closing): int in %s on line %d
diff --git a/ext/standard/tests/filters/php_user_filter_02.phpt b/ext/standard/tests/filters/php_user_filter_02.phpt
@@ -3,10 +3,10 @@ class php_user_filter#2
 --FILE--
 <?php
 class foo extends php_user_filter {
-    function filter($in, $out, $consumed, $closing) {}
-    function onCreate() {}
-    function onClose() {}
+    function filter($in, $out, $consumed, $closing): int {}
+    function onCreate(): bool {}
+    function onClose(): void {}
 }
 ?>
 --EXPECTF--
-Fatal error: Declaration of foo::filter($in, $out, $consumed, $closing) must be compatible with php_user_filter::filter($in, $out, &$consumed, bool $closing) in %s on line %d
+Fatal error: Declaration of foo::filter($in, $out, $consumed, $closing): int must be compatible with php_user_filter::filter($in, $out, &$consumed, bool $closing): int in %s on line %d
diff --git a/ext/standard/tests/filters/php_user_filter_03.phpt b/ext/standard/tests/filters/php_user_filter_03.phpt
@@ -3,10 +3,10 @@ class php_user_filter#3
 --FILE--
 <?php
 class foo extends php_user_filter {
-    function filter($in, $out, &$consumed, $closing) {}
-    function onCreate($var) {}
-    function onClose() {}
+    function filter($in, $out, &$consumed, $closing): int {}
+    function onCreate($var): bool {}
+    function onClose(): void {}
 }
 ?>
 --EXPECTF--
-Fatal error: Declaration of foo::onCreate($var) must be compatible with php_user_filter::onCreate() in %s on line %d
+Fatal error: Declaration of foo::onCreate($var): bool must be compatible with php_user_filter::onCreate(): bool in %s on line %d
diff --git a/ext/standard/tests/filters/php_user_filter_onCreate_failure.phpt b/ext/standard/tests/filters/php_user_filter_onCreate_failure.phpt
@@ -4,7 +4,7 @@ php_user_filter onCreate() returns false
 <?php
 
 class my_filter extends php_user_filter {
-    function onCreate() {
+    function onCreate(): bool {
         return false;
     }
 }
diff --git a/ext/standard/tests/filters/read.phpt b/ext/standard/tests/filters/read.phpt
@@ -4,7 +4,7 @@ stream filter - reading
 <?php
 echo "-TEST\n";
 class strtoupper_filter extends php_user_filter {
-    function filter($in, $out, &$consumed, $closing)
+    function filter($in, $out, &$consumed, $closing): int
     {
         $output = 0;
         while ($bucket = stream_bucket_make_writeable($in)) {
@@ -38,7 +38,7 @@ echo "Done\n";
 <?PHP
 ECHO "-TEST\N";
 CLASS STRTOUPPER_FILTER EXTENDS PHP_USER_FILTER {
-    FUNCTION FILTER($IN, $OUT, &$CONSUMED, $CLOSING)
+    FUNCTION FILTER($IN, $OUT, &$CONSUMED, $CLOSING): INT
     {
         $OUTPUT = 0;
         WHILE ($BUCKET = STREAM_BUCKET_MAKE_WRITEABLE($IN)) {
diff --git a/ext/standard/tests/streams/bug77069.phpt b/ext/standard/tests/streams/bug77069.phpt
@@ -5,7 +5,7 @@ Bug #77069 (stream filter loses final block of data)
 class MyFilter extends php_user_filter {
     private $data = '';
 
-    public function filter($in, $out, &$consumed, $closing) {
+    public function filter($in, $out, &$consumed, $closing): int {
         $return = PSFS_FEED_ME;
 
         // While input data is available, continue to read it.
diff --git a/ext/standard/tests/streams/bug78506.phpt b/ext/standard/tests/streams/bug78506.phpt
@@ -4,7 +4,7 @@ Bug #78506: Error in a php_user_filter::filter() is not reported
 <?php
 
 class MyFilter extends php_user_filter {
-    public function filter($in, $out, &$consumed, $closing)
+    public function filter($in, $out, &$consumed, $closing): int
     {
         stream_bucket_make_writeable($in);
         return PSFS_ERR_FATAL;
diff --git a/ext/standard/tests/streams/bug79984.phpt b/ext/standard/tests/streams/bug79984.phpt
@@ -5,18 +5,18 @@ Bug #79984 (Stream filter is not called with closing arg)
 
 class F extends php_user_filter
 {
-    public function onCreate()
+    public function onCreate(): bool
     {
         echo 'filter onCreate' . PHP_EOL;
         return true;
     }
 
-    public function onClose()
+    public function onClose(): void
     {
         echo 'filter onClose' . PHP_EOL;
     }
 
-    public function filter($in, $out, &$consumed, $closing)
+    public function filter($in, $out, &$consumed, $closing): int
     {
         while ($bucket = stream_bucket_make_writeable($in)) {
             $bucket->data = strtoupper($bucket->data);
diff --git a/ext/standard/tests/streams/stream_filter_register.phpt b/ext/standard/tests/streams/stream_filter_register.phpt
@@ -6,12 +6,12 @@ User Group: PHP-WVL & PHPGent #PHPTestFest
 --FILE--
 <?php
 class foo extends php_user_filter {
-  function filter($in, $out, &$consumed, $closing) {
+  function filter($in, $out, &$consumed, $closing): int {
   }
 }
 
 class bar extends php_user_filter {
-  function filter($in, $out, &$consumed, $closing) {
+  function filter($in, $out, &$consumed, $closing): int {
   }
 }
 
diff --git a/ext/standard/tests/streams/stream_multi_filters_close.phpt b/ext/standard/tests/streams/stream_multi_filters_close.phpt
diff --git a/ext/standard/tests/streams/user_streams_consumed_bug.phpt b/ext/standard/tests/streams/user_streams_consumed_bug.phpt
diff --git a/ext/standard/user_filters.stub.php b/ext/standard/user_filters.stub.php
diff --git a/ext/standard/user_filters_arginfo.h b/ext/standard/user_filters_arginfo.h

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ if (!class_exists(SampleFilter::class)) {`
`10`	`10`	`{`
`11`	`11`	`private $data = '';`
`12`	`12`
`13`		`- public function filter($in, $out, &$consumed, $closing)`
	`13`	`+ public function filter($in, $out, &$consumed, $closing): int`
`14`	`14`	`{`
`15`	`15`	`while ($bucket = stream_bucket_make_writeable($in))`
`16`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ opcache`
`9`	`9`	`--FILE--`
`10`	`10`	`<?php`
`11`	`11`	`class BugLoader extends php_user_filter {`
`12`		`- public function filter($in, $out, &$consumed, $closing) {`
	`12`	`+ public function filter($in, $out, &$consumed, $closing): int {`
`13`	`13`	`if (!class_exists("Test")) {`
`14`	`14`	`eval("class Test extends ArrayObject {}");`
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ file_put_contents(__DIR__ . "/bug74596_2.php", "ok\n");`
`32`	`32`
`33`	`33`	`class ufilter extends php_user_filter`
`34`	`34`	`{`
`35`		`- function filter($in, $out, &$consumed, $closing)`
	`35`	`+ function filter($in, $out, &$consumed, $closing): int`
`36`	`36`	`{`
`37`	`37`	`include_once __DIR__ . "/bug74596_1.php";`
`38`	`38`	`while ($bucket = stream_bucket_make_writeable($in)) {`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ class Caster`
`16`	`16`	`const EXCLUDE_PRIVATE = 32;`
`17`	`17`	`const EXCLUDE_STRICT = 512;`
`18`	`18`
`19`		`- public static function filter(array $a, $filter)`
	`19`	`+ public static function filter(array $a, $filter): int`
`20`	`20`	`{`
`21`	`21`	`foreach ($a as $k => $v) {`
`22`	`22`	`if (!isset($k[1])) {`
Original file line number	Diff line number	Diff line change
`@@ -43,18 +43,21 @@ Class [ <internal%s> class Directory ] {`
`43`	`43`
`44`	`44`	`- Parameters [0] {`
`45`	`45`	`}`
	`46`	`+ - Tentative return [ void ]`
`46`	`47`	`}`
`47`	`48`
`48`	`49`	`Method [ <internal:standard> public method rewind ] {`
`49`	`50`
`50`	`51`	`- Parameters [0] {`
`51`	`52`	`}`
	`53`	`+ - Tentative return [ void ]`
`52`	`54`	`}`
`53`	`55`
`54`	`56`	`Method [ <internal:standard> public method read ] {`
`55`	`57`
`56`	`58`	`- Parameters [0] {`
`57`	`59`	`}`
	`60`	`+ - Tentative return [ string\|false ]`
`58`	`61`	`}`
`59`	`62`	`}`
`60`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ stream userfilter test`
`4`	`4`	`<?php`
`5`	`5`
`6`	`6`	`class testfilter extends php_user_filter {`
`7`		`- function filter($in, $out, &$consumed, $closing) {`
	`7`	`+ function filter($in, $out, &$consumed, $closing): int {`
`8`	`8`	`while ($bucket = stream_bucket_make_writeable($in)) {`
`9`	`9`	`$bucket->data = strtoupper($bucket->data);`
`10`	`10`	`$consumed += strlen($bucket->data);`
`@@ -13,8 +13,9 @@ class testfilter extends php_user_filter {`
`13`	`13`	`return PSFS_PASS_ON;`
`14`	`14`	`}`
`15`	`15`
`16`		`- function oncreate() {`
	`16`	`+ function oncreate(): bool {`
`17`	`17`	`echo "params: {$this->params}\n";`
	`18`	`+ return true;`
`18`	`19`	`}`
`19`	`20`	`}`
`20`	`21`