Declare true return types

Zend/Optimizer/zend_func_infos.h

@@ -7,9 +7,7 @@ static const func_info_t func_infos[] = {
 	F1("get_class_methods", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_OF_STRING),
 	F1("get_included_files", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_OF_STRING),
 	FN("set_error_handler", MAY_BE_STRING|MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_OF_STRING|MAY_BE_ARRAY_OF_OBJECT|MAY_BE_OBJECT|MAY_BE_NULL),
-	F0("restore_error_handler", MAY_BE_TRUE),
 	FN("set_exception_handler", MAY_BE_STRING|MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_OF_STRING|MAY_BE_ARRAY_OF_OBJECT|MAY_BE_OBJECT|MAY_BE_NULL),
-	F0("restore_exception_handler", MAY_BE_TRUE),
 	F1("get_declared_classes", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_OF_STRING),
 	F1("get_declared_traits", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_OF_STRING),
 	F1("get_declared_interfaces", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_OF_STRING),
@@ -268,10 +266,8 @@ static const func_info_t func_infos[] = {
 #endif
 	F1("mysqli_affected_rows", MAY_BE_LONG|MAY_BE_STRING),
 	F1("mysqli_character_set_name", MAY_BE_STRING),
-	F0("mysqli_close", MAY_BE_TRUE),
 	F1("mysqli_connect", MAY_BE_OBJECT|MAY_BE_FALSE),
 	F1("mysqli_connect_error", MAY_BE_STRING|MAY_BE_NULL),
-	F0("mysqli_debug", MAY_BE_TRUE),
 	F1("mysqli_error", MAY_BE_STRING),
 	F1("mysqli_error_list", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_OF_ARRAY),
 	F1("mysqli_fetch_field", MAY_BE_OBJECT|MAY_BE_FALSE),
@@ -300,7 +296,6 @@ static const func_info_t func_infos[] = {
 	F1("mysqli_real_escape_string", MAY_BE_STRING),
 	F1("mysqli_reap_async_query", MAY_BE_OBJECT|MAY_BE_BOOL),
 	F1("mysqli_stmt_affected_rows", MAY_BE_LONG|MAY_BE_STRING),
-	F0("mysqli_stmt_close", MAY_BE_TRUE),
 	F1("mysqli_stmt_error", MAY_BE_STRING),
 	F1("mysqli_stmt_error_list", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_OF_ARRAY),
 	F1("mysqli_stmt_get_result", MAY_BE_OBJECT|MAY_BE_FALSE),
@@ -311,7 +306,6 @@ static const func_info_t func_infos[] = {
 	F1("mysqli_stmt_result_metadata", MAY_BE_OBJECT|MAY_BE_FALSE),
 	F1("mysqli_stmt_sqlstate", MAY_BE_STRING),
 	F1("mysqli_sqlstate", MAY_BE_STRING),
-	F0("mysqli_ssl_set", MAY_BE_TRUE),
 	F1("mysqli_stat", MAY_BE_STRING|MAY_BE_FALSE),
 	F1("mysqli_store_result", MAY_BE_OBJECT|MAY_BE_FALSE),
 	F1("mysqli_use_result", MAY_BE_OBJECT|MAY_BE_FALSE),
@@ -438,7 +432,6 @@ static const func_info_t func_infos[] = {
 	F1("socket_addrinfo_explain", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_STRING|MAY_BE_ARRAY_OF_LONG|MAY_BE_ARRAY_OF_STRING|MAY_BE_ARRAY_OF_ARRAY),
 	FN("sodium_crypto_kx_client_session_keys", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_OF_STRING),
 	FN("sodium_crypto_kx_server_session_keys", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_OF_STRING),
-	F0("sodium_crypto_generichash_update", MAY_BE_TRUE),
 #if defined(crypto_secretstream_xchacha20poly1305_ABYTES)
 	FN("sodium_crypto_secretstream_xchacha20poly1305_init_push", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_OF_STRING),
 #endif
@@ -455,20 +448,9 @@ static const func_info_t func_infos[] = {
 	F1("ob_get_clean", MAY_BE_STRING|MAY_BE_FALSE),
 	F1("ob_list_handlers", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_OF_STRING),
 	F1("ob_get_status", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_KEY_STRING|MAY_BE_ARRAY_OF_LONG|MAY_BE_ARRAY_OF_STRING|MAY_BE_ARRAY_OF_ARRAY),
-	F0("krsort", MAY_BE_TRUE),
-	F0("ksort", MAY_BE_TRUE),
-	F0("asort", MAY_BE_TRUE),
-	F0("arsort", MAY_BE_TRUE),
-	F0("sort", MAY_BE_TRUE),
-	F0("usort", MAY_BE_TRUE),
-	F0("uasort", MAY_BE_TRUE),
-	F0("uksort", MAY_BE_TRUE),
-	F0("array_walk", MAY_BE_TRUE),
-	F0("array_walk_recursive", MAY_BE_TRUE),
 	F1("compact", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_STRING|MAY_BE_ARRAY_OF_ANY|MAY_BE_ARRAY_OF_REF),
 	FN("array_fill", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_OF_ANY),
 	F1("array_fill_keys", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_KEY_STRING|MAY_BE_ARRAY_OF_ANY|MAY_BE_ARRAY_OF_REF),
-	F0("shuffle", MAY_BE_TRUE),
 	F1("array_replace", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_KEY_STRING|MAY_BE_ARRAY_OF_ANY|MAY_BE_ARRAY_OF_REF),
 	F1("array_replace_recursive", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_KEY_STRING|MAY_BE_ARRAY_OF_ANY|MAY_BE_ARRAY_OF_REF),
 	FN("array_keys", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_OF_LONG|MAY_BE_ARRAY_OF_STRING),
@@ -544,12 +526,6 @@ static const func_info_t func_infos[] = {
 	F1("md5_file", MAY_BE_STRING|MAY_BE_FALSE),
 	F1("sha1", MAY_BE_STRING),
 	F1("sha1_file", MAY_BE_STRING|MAY_BE_FALSE),
-#if defined(HAVE_SYSLOG_H)
-	F0("closelog", MAY_BE_TRUE),
-#endif
-#if defined(HAVE_SYSLOG_H)
-	F0("syslog", MAY_BE_TRUE),
-#endif
 #if defined(HAVE_INET_NTOP)
 	F1("inet_ntop", MAY_BE_STRING|MAY_BE_FALSE),
 #endif
@@ -639,9 +615,7 @@ static const func_info_t func_infos[] = {
 	F1("image_type_to_extension", MAY_BE_STRING|MAY_BE_FALSE),
 	F1("getimagesize", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_KEY_STRING|MAY_BE_ARRAY_OF_LONG|MAY_BE_ARRAY_OF_STRING|MAY_BE_FALSE),
 	F1("getimagesizefromstring", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_KEY_STRING|MAY_BE_ARRAY_OF_LONG|MAY_BE_ARRAY_OF_STRING|MAY_BE_FALSE),
-	F0("phpinfo", MAY_BE_TRUE),
 	F1("phpversion", MAY_BE_STRING|MAY_BE_FALSE),
-	F0("phpcredits", MAY_BE_TRUE),
 	F1("php_sapi_name", MAY_BE_STRING|MAY_BE_FALSE),
 	F1("php_uname", MAY_BE_STRING),
 	F1("php_ini_scanned_files", MAY_BE_STRING|MAY_BE_FALSE),

Zend/zend_builtin_functions.stub.php

@@ -102,14 +102,12 @@ function user_error(string $message, int $error_level = E_USER_NOTICE): bool {}
 /** @return callable|null */
 function set_error_handler(?callable $callback, int $error_levels = E_ALL) {}
 
-/** @return true */
-function restore_error_handler(): bool {}
+function restore_error_handler(): true {}
 
 /** @return callable|null */
 function set_exception_handler(?callable $callback) {}
 
-/** @return true */
-function restore_exception_handler(): bool {}
+function restore_exception_handler(): true {}
 
 /**
  * @return array<int, string>

build/gen_stub.php

@@ -188,6 +188,11 @@ public static function fromNode(Node $node): SimpleType {
                 return new SimpleType($node->toLowerString(), true);
             }
 
+            if ($node->toLowerString() === 'true') {
+                // TODO PHP-Parser doesn't yet recognize true as a stand-alone built-in type
+                return new SimpleType($node->toLowerString(), true);
+            }
+
             if ($node->toLowerString() === 'self') {
                 throw new Exception('The exact class name must be used instead of "self"');
             }
@@ -380,6 +385,8 @@ public function toTypeCode(): string {
                 return "IS_NULL";
             case "false":
                 return "IS_FALSE";
+            case "true":
+                return "IS_TRUE";
             default:
                 throw new Exception("Not implemented: $this->name");
         }
@@ -393,6 +400,8 @@ public function toTypeMask(): string {
                 return "MAY_BE_NULL";
             case "false":
                 return "MAY_BE_FALSE";
+            case "true":
+                return "MAY_BE_TRUE";
             case "bool":
                 return "MAY_BE_BOOL";
             case "int":
@@ -443,6 +452,8 @@ public function toOptimizerTypeMaskForArrayValue(): string {
                 return "MAY_BE_ARRAY_OF_NULL";
             case "false":
                 return "MAY_BE_ARRAY_OF_FALSE";
+            case "true":
+                return "MAY_BE_ARRAY_OF_TRUE";
             case "bool":
                 return "MAY_BE_ARRAY_OF_FALSE|MAY_BE_ARRAY_OF_TRUE";
             case "int":
@@ -472,8 +483,6 @@ public function toOptimizerTypeMask(): string {
         }
 
         switch ($this->name) {
-            case "true":
-                return "MAY_BE_TRUE";
             case "resource":
                 return "MAY_BE_RESOURCE";
             case "callable":

ext/mysqli/mysqli.stub.php

@@ -749,8 +749,7 @@ function mysqli_change_user(mysqli $mysql, string $username, string $password, ?
 /** @refcount 1 */
 function mysqli_character_set_name(mysqli $mysql): string {}
 
-/** @return true */
-function mysqli_close(mysqli $mysql): bool {} // TODO make return type void
+function mysqli_close(mysqli $mysql): true {} // TODO make return type void
 
 function mysqli_commit(mysqli $mysql, int $flags = 0, ?string $name = null): bool {}
 
@@ -776,8 +775,7 @@ function mysqli_data_seek(mysqli_result $result, int $offset): bool {}
 
 function mysqli_dump_debug_info(mysqli $mysql): bool {}
 
-/** @return true */
-function mysqli_debug(string $options): bool {} // TODO make return type void
+function mysqli_debug(string $options): true {} // TODO make return type void
 
 function mysqli_errno(mysqli $mysql): int {}
 
@@ -976,8 +974,7 @@ function mysqli_stmt_bind_param(mysqli_stmt $statement, string $types, mixed &..
 
 function mysqli_stmt_bind_result(mysqli_stmt $statement, mixed &...$vars): bool {}
 
-/** @return true */
-function mysqli_stmt_close(mysqli_stmt $statement): bool {}
+function mysqli_stmt_close(mysqli_stmt $statement): true {}
 
 function mysqli_stmt_data_seek(mysqli_stmt $statement, int $offset): void {}
 
@@ -1036,15 +1033,14 @@ function mysqli_stmt_sqlstate(mysqli_stmt $statement): string {}
 /** @refcount 1 */
 function mysqli_sqlstate(mysqli $mysql): string {}
 
-/** @return true */
 function mysqli_ssl_set(
     mysqli $mysql,
     ?string $key,
     ?string $certificate,
     ?string $ca_certificate,
     ?string $ca_path,
     ?string $cipher_algos
-): bool {} // TODO make return type void
+): true {} // TODO make return type void
 
 /** @refcount 1 */
 function mysqli_stat(mysqli $mysql): string|false {}

ext/sodium/libsodium.stub.php

@@ -152,8 +152,7 @@ function sodium_crypto_generichash_keygen(): string {}
 /** @sensitive-param $key */
 function sodium_crypto_generichash_init(string $key = "", int $length = SODIUM_CRYPTO_GENERICHASH_BYTES): string {}
 
-/** @return true */
-function sodium_crypto_generichash_update(string &$state, string $message): bool {}
+function sodium_crypto_generichash_update(string &$state, string $message): true {}
 
 function sodium_crypto_generichash_final(string &$state, int $length = SODIUM_CRYPTO_GENERICHASH_BYTES): string {}