Add union return types for function stubs

Author: kocsismate

Zend/zend_builtin_functions.stub.php

@@ -7,37 +7,31 @@ function func_num_args(): int {}
 /** @return mixed */
 function func_get_arg(int $arg_num) {}
 
-/** @return array|false */
-function func_get_args() {}
+function func_get_args(): array|false {}
 
 function strlen(string $str): int {}
 
 function strcmp(string $str1, string $str2): int {}
 
-/** @return int|false */
-function strncmp(string $str1, string $str2, int $len) {}
+function strncmp(string $str1, string $str2, int $len): int|false {}
 
 function error_reporting($new_error_level = UNKNOWN): int {}
 
 function define(string $constant_name, $value, bool $case_insensitive = false): bool {}
 
 function defined(string $constant_name): bool {}
 
-/** @return string|false */
-function get_class(object $object = UNKNOWN) {}
+function get_class(object $object = UNKNOWN): string|false {}
 
-/** @return string|false */
-function get_called_class() {}
+function get_called_class(): string|false {}
 
-/** @return string|false */
-function get_parent_class($object = UNKNOWN) {}
+function get_parent_class($object = UNKNOWN): string|false {}
 
 function is_subclass_of($object, string $class_name, bool $allow_string = true): bool {}
 
 function is_a($object, string $class_name, bool $allow_string = false): bool {}
 
-/** @return array|false */
-function get_class_vars(string $class_name) {}
+function get_class_vars(string $class_name): array|false {}
 
 function get_object_vars(object $obj): array {}
 
@@ -103,8 +97,7 @@ function debug_print_backtrace(int $options = 0, int $limit = 0): void {}
 
 function extension_loaded(string $extension_name): bool {}
 
-/** @return array|false */
-function get_extension_funcs(string $extension_name) {}
+function get_extension_funcs(string $extension_name): array|false {}
 
 #if ZEND_DEBUG && defined(ZTS)
 function zend_thread_id(): int {}

Zend/zend_builtin_functions_arginfo.h

@@ -10,7 +10,7 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_func_get_arg, 0, 0, 1)
 	ZEND_ARG_TYPE_INFO(0, arg_num, IS_LONG, 0)
 ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_func_get_args, 0, 0, 0)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_func_get_args, 0, 0, MAY_BE_ARRAY|MAY_BE_FALSE)
 ZEND_END_ARG_INFO()
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_strlen, 0, 1, IS_LONG, 0)
@@ -22,7 +22,7 @@ ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_strcmp, 0, 2, IS_LONG, 0)
 	ZEND_ARG_TYPE_INFO(0, str2, IS_STRING, 0)
 ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_strncmp, 0, 0, 3)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_strncmp, 0, 3, MAY_BE_LONG|MAY_BE_FALSE)
 	ZEND_ARG_TYPE_INFO(0, str1, IS_STRING, 0)
 	ZEND_ARG_TYPE_INFO(0, str2, IS_STRING, 0)
 	ZEND_ARG_TYPE_INFO(0, len, IS_LONG, 0)
@@ -42,13 +42,14 @@ ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_defined, 0, 1, _IS_BOOL, 0)
 	ZEND_ARG_TYPE_INFO(0, constant_name, IS_STRING, 0)
 ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_get_class, 0, 0, 0)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_get_class, 0, 0, MAY_BE_STRING|MAY_BE_FALSE)
 	ZEND_ARG_TYPE_INFO(0, object, IS_OBJECT, 0)
 ZEND_END_ARG_INFO()
 
-#define arginfo_get_called_class arginfo_func_get_args
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_get_called_class, 0, 0, MAY_BE_STRING|MAY_BE_FALSE)
+ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_get_parent_class, 0, 0, 0)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_get_parent_class, 0, 0, MAY_BE_STRING|MAY_BE_FALSE)
 	ZEND_ARG_INFO(0, object)
 ZEND_END_ARG_INFO()
 
@@ -60,7 +61,7 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_is_a arginfo_is_subclass_of
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_get_class_vars, 0, 0, 1)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_get_class_vars, 0, 1, MAY_BE_ARRAY|MAY_BE_FALSE)
 	ZEND_ARG_TYPE_INFO(0, class_name, IS_STRING, 0)
 ZEND_END_ARG_INFO()
 
@@ -175,7 +176,7 @@ ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_extension_loaded, 0, 1, _IS_BOOL
 	ZEND_ARG_TYPE_INFO(0, extension_name, IS_STRING, 0)
 ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_get_extension_funcs, 0, 0, 1)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_get_extension_funcs, 0, 1, MAY_BE_ARRAY|MAY_BE_FALSE)
 	ZEND_ARG_TYPE_INFO(0, extension_name, IS_STRING, 0)
 ZEND_END_ARG_INFO()
 

Zend/zend_generators_arginfo.h

@@ -1,13 +1,15 @@
 /* This is a generated file, edit the .stub.php file instead. */
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Generator_rewind, 0, 0, 0)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Generator_rewind, 0, 0, IS_VOID, 0)
 ZEND_END_ARG_INFO()
 
-#define arginfo_class_Generator_valid arginfo_class_Generator_rewind
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Generator_valid, 0, 0, _IS_BOOL, 0)
+ZEND_END_ARG_INFO()
 
-#define arginfo_class_Generator_current arginfo_class_Generator_rewind
+ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Generator_current, 0, 0, 0)
+ZEND_END_ARG_INFO()
 
-#define arginfo_class_Generator_key arginfo_class_Generator_rewind
+#define arginfo_class_Generator_key arginfo_class_Generator_current
 
 #define arginfo_class_Generator_next arginfo_class_Generator_rewind
 
@@ -19,4 +21,4 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Generator_throw, 0, 0, 1)
 	ZEND_ARG_OBJ_INFO(0, exception, Throwable, 0)
 ZEND_END_ARG_INFO()
 
-#define arginfo_class_Generator_getReturn arginfo_class_Generator_rewind
+#define arginfo_class_Generator_getReturn arginfo_class_Generator_current

ext/bcmath/bcmath.stub.php

@@ -10,8 +10,7 @@ function bcdiv(string $dividend, string $divisor, int $scale = UNKNOWN) : string
 
 function bcmod(string $dividend, string $divisor, int $scale = UNKNOWN) : string {}
 
-/** @return string|false */
-function bcpowmod(string $base, string $exponent, string $modulus, int $scale = UNKNOWN) {}
+function bcpowmod(string $base, string $exponent, string $modulus, int $scale = UNKNOWN): string|false {}
 
 function bcpow(string $base, string $exponent, int $scale = UNKNOWN) : string {}
 

ext/bcmath/bcmath_arginfo.h

@@ -18,7 +18,7 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_bcmod arginfo_bcdiv
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_bcpowmod, 0, 0, 3)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_bcpowmod, 0, 3, MAY_BE_STRING|MAY_BE_FALSE)
 	ZEND_ARG_TYPE_INFO(0, base, IS_STRING, 0)
 	ZEND_ARG_TYPE_INFO(0, exponent, IS_STRING, 0)
 	ZEND_ARG_TYPE_INFO(0, modulus, IS_STRING, 0)

ext/bz2/bz2.stub.php

@@ -6,49 +6,37 @@
  */
  function bzopen($file, string $mode) {}
 
-/**
- * @param resource $bz
- * @return string|false
- */
-function bzread ($bz, int $length = 1024) {}
+/** @param resource $bz */
+function bzread($bz, int $length = 1024): string|false {}
 
-/**
- * @param resource $bz
- * @return int|false
- */
-function bzwrite ($bz, string $str, int $length = UNKNOWN) {}
+/** @param resource $bz */
+function bzwrite($bz, string $str, int $length = UNKNOWN): int|false {}
 
 /**
  * @param resource $bz
  */
-function bzflush ($bz): bool {}
+function bzflush($bz): bool {}
 
 /**
  * @param resource $bz
  */
-function bzclose ($bz): bool {}
+function bzclose($bz): bool {}
 
 /**
  * @param resource $bz
  */
-function bzerrno ($bz): int {}
+function bzerrno($bz): int {}
 
 /**
  * @param resource $bz
  */
-function bzerrstr ($bz): string {}
+function bzerrstr($bz): string {}
 
 /**
  * @param resource $bz
  */
-function bzerror ($bz): array {}
+function bzerror($bz): array {}
 
-/**
- * @return string|int
- */
-function bzcompress (string $source, int $blocksize = 4, int $workfactor = 0) {}
+function bzcompress(string $source, int $blocksize = 4, int $workfactor = 0): string|int {}
 
-/**
- * @return string|int
- */
-function bzdecompress (string $source, int $small = 0) {}
+function bzdecompress(string $source, int $small = 0): string|int|false {}

ext/bz2/bz2_arginfo.h

@@ -5,12 +5,12 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_bzopen, 0, 0, 2)
 	ZEND_ARG_TYPE_INFO(0, mode, IS_STRING, 0)
 ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_bzread, 0, 0, 1)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_bzread, 0, 1, MAY_BE_STRING|MAY_BE_FALSE)
 	ZEND_ARG_INFO(0, bz)
 	ZEND_ARG_TYPE_INFO(0, length, IS_LONG, 0)
 ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_bzwrite, 0, 0, 2)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_bzwrite, 0, 2, MAY_BE_LONG|MAY_BE_FALSE)
 	ZEND_ARG_INFO(0, bz)
 	ZEND_ARG_TYPE_INFO(0, str, IS_STRING, 0)
 	ZEND_ARG_TYPE_INFO(0, length, IS_LONG, 0)
@@ -34,13 +34,13 @@ ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_bzerror, 0, 1, IS_ARRAY, 0)
 	ZEND_ARG_INFO(0, bz)
 ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_bzcompress, 0, 0, 1)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_bzcompress, 0, 1, MAY_BE_STRING|MAY_BE_LONG)
 	ZEND_ARG_TYPE_INFO(0, source, IS_STRING, 0)
 	ZEND_ARG_TYPE_INFO(0, blocksize, IS_LONG, 0)
 	ZEND_ARG_TYPE_INFO(0, workfactor, IS_LONG, 0)
 ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_bzdecompress, 0, 0, 1)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_bzdecompress, 0, 1, MAY_BE_STRING|MAY_BE_LONG|MAY_BE_FALSE)
 	ZEND_ARG_TYPE_INFO(0, source, IS_STRING, 0)
 	ZEND_ARG_TYPE_INFO(0, small, IS_LONG, 0)
 ZEND_END_ARG_INFO()

ext/calendar/calendar.stub.php

@@ -16,8 +16,7 @@ function frenchtojd(int $month, int $day, int $year): int {}
 
 function gregoriantojd(int $month, int $day, int $year): int {}
 
-/** @return int|string */
-function jddayofweek(int $juliandaycount, int $mode = CAL_DOW_DAYNO) {}
+function jddayofweek(int $juliandaycount, int $mode = CAL_DOW_DAYNO): int|string {}
 
 function jdmonthname(int $juliandaycount, int $mode): string {}
 
@@ -35,5 +34,4 @@ function jewishtojd(int $month, int $day, int $year): int {}
 
 function juliantojd(int $month, int $day, int $year): int {}
 
-/** @return int|false */
-function unixtojd(int $timestamp = UNKNOWN) {}
+function unixtojd(int $timestamp = UNKNOWN): int|false {}

ext/calendar/calendar_arginfo.h

@@ -37,7 +37,7 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_gregoriantojd arginfo_frenchtojd
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_jddayofweek, 0, 0, 1)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_jddayofweek, 0, 1, MAY_BE_LONG|MAY_BE_STRING)
 	ZEND_ARG_TYPE_INFO(0, juliandaycount, IS_LONG, 0)
 	ZEND_ARG_TYPE_INFO(0, mode, IS_LONG, 0)
 ZEND_END_ARG_INFO()
@@ -69,6 +69,6 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_juliantojd arginfo_frenchtojd
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_unixtojd, 0, 0, 0)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_unixtojd, 0, 0, MAY_BE_LONG|MAY_BE_FALSE)
 	ZEND_ARG_TYPE_INFO(0, timestamp, IS_LONG, 0)
 ZEND_END_ARG_INFO()

ext/com_dotnet/com_extension.stub.php

@@ -55,8 +55,7 @@ function variant_cast(variant $variant, int $type): variant {}
 
 function com_get_active_object(string $progid, int $code_page = UNKNOWN): variant {}
 
-/** @return string|false */
-function com_create_guid() {}
+function com_create_guid(): string|false {}
 
 function com_event_sink(variant $comobject, object $sinkobject, $sinkinterface = UNKNOWN): bool {}
 

ext/com_dotnet/com_extension_arginfo.h

@@ -85,7 +85,7 @@ ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_com_get_active_object, 0, 1, vari
 	ZEND_ARG_TYPE_INFO(0, code_page, IS_LONG, 0)
 ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_com_create_guid, 0, 0, 0)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_com_create_guid, 0, 0, MAY_BE_STRING|MAY_BE_FALSE)
 ZEND_END_ARG_INFO()
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_com_event_sink, 0, 2, _IS_BOOL, 0)

ext/curl/curl.stub.php

@@ -5,7 +5,6 @@ function curl_close($handle): void {}
 
 /**
  * @param resource $handle
- *
  * @return resource|false
  */
 function curl_copy_handle($handle) {}
@@ -16,19 +15,11 @@ function curl_errno($handle): int {}
 /** @param resource $handle */
 function curl_error($handle): string {}
 
-/**
- * @param resource $handle
- *
- * @return string|false
- */
-function curl_escape($handle, string $string) {}
+/** @param resource $handle */
+function curl_escape($handle, string $string): string|false {}
 
-/**
- * @param resource $handle
- *
- * @return string|bool
- */
-function curl_exec($handle) {}
+/** @param resource $handle */
+function curl_exec($handle): string|bool {}
 
 function curl_file_create(
     string $filename,
@@ -38,14 +29,12 @@ function curl_file_create(
 
 /**
  * @param resource $handle
- *
  * @return mixed
  */
 function curl_getinfo($handle, int $option = UNKNOWN) {}
 
 /**
  * @param resource $handle
- *
  * @return resource|false
  */
 function curl_init(string $url = UNKNOWN) {}
@@ -59,11 +48,7 @@ function curl_multi_add_handle($multi_handle, $handle): int {}
 /** @param resource $multi_handle */
 function curl_multi_close($multi_handle): void {}
 
-/**
- * @param resource $multi_handle
- *
- * @return int|false
- */
+/** @param resource $multi_handle */
 function curl_multi_errno($multi_handle): int {}
 
 /** @param resource $multi_handle */
@@ -72,12 +57,8 @@ function curl_multi_exec($multi_handle, &$still_running): int {}
 /** @param resource $multi_handle */
 function curl_multi_getcontent($multi_handle): ?string {}
 
-/**
- * @param resource $multi_handle
- *
- * @return array|false
- */
-function curl_multi_info_read($multi_handle, &$msgs_in_queue = null) {}
+/** @param resource $multi_handle */
+function curl_multi_info_read($multi_handle, &$msgs_in_queue = null): array|false {}
 
 /** @return resource */
 function curl_multi_init() {}
@@ -136,12 +117,7 @@ function curl_share_strerror(int $error_number): ?string {}
 
 function curl_strerror(int $error_number): ?string {}
 
-/**
- * @param resource $handle
- *
- * @return string|false
- */
-function curl_unescape($handle, string $string) {}
+/** @param resource $handle */
+function curl_unescape($handle, string $string): string|false {}
 
-/** @return array|false */
-function curl_version(int $age = UNKNOWN) {}
+function curl_version(int $age = UNKNOWN): array|false {}