From dcbbf8a98fc07a15c2b1b23bf9467e87ee10d1c2 Mon Sep 17 00:00:00 2001 From: Shish Date: Sat, 31 Jan 2026 11:19:15 +0000 Subject: [PATCH] regen --- generated/8.1/filesystem.php | 11 +- generated/8.1/funchand.php | 3 +- generated/8.1/image.php | 6 +- generated/8.1/info.php | 32 +- generated/8.1/mbstring.php | 51 ++- generated/8.1/misc.php | 13 +- generated/8.1/network.php | 4 +- generated/8.1/outcontrol.php | 4 +- generated/8.1/pcntl.php | 2 +- generated/8.1/pspell.php | 47 ++- generated/8.1/strings.php | 5 +- generated/8.1/uodbc.php | 21 +- generated/8.1/xml.php | 5 +- generated/8.2/filesystem.php | 11 +- generated/8.2/funchand.php | 3 +- generated/8.2/image.php | 6 +- generated/8.2/info.php | 32 +- generated/8.2/mbstring.php | 51 ++- generated/8.2/misc.php | 13 +- generated/8.2/network.php | 4 +- generated/8.2/outcontrol.php | 4 +- generated/8.2/pcntl.php | 2 +- generated/8.2/pspell.php | 47 ++- generated/8.2/strings.php | 5 +- generated/8.2/uodbc.php | 21 +- generated/8.2/xml.php | 5 +- generated/8.3/filesystem.php | 11 +- generated/8.3/funchand.php | 3 +- generated/8.3/image.php | 6 +- generated/8.3/info.php | 32 +- generated/8.3/mbstring.php | 51 ++- generated/8.3/misc.php | 13 +- generated/8.3/network.php | 4 +- generated/8.3/outcontrol.php | 4 +- generated/8.3/pcntl.php | 2 +- generated/8.3/pspell.php | 47 ++- generated/8.3/strings.php | 5 +- generated/8.3/uodbc.php | 21 +- generated/8.3/xml.php | 5 +- generated/8.4/array.php | 6 +- generated/8.4/filesystem.php | 11 +- generated/8.4/filter.php | 57 ++- generated/8.4/funchand.php | 3 +- generated/8.4/image.php | 6 +- generated/8.4/info.php | 32 +- generated/8.4/mbstring.php | 51 ++- generated/8.4/misc.php | 13 +- generated/8.4/network.php | 4 +- generated/8.4/outcontrol.php | 10 +- generated/8.4/pcntl.php | 2 +- generated/8.4/pgsql.php | 8 +- generated/8.4/pspell.php | 47 ++- generated/8.4/sodium.php | 26 +- generated/8.4/strings.php | 5 +- generated/8.4/uodbc.php | 21 +- generated/8.4/xml.php | 4 +- generated/8.5/array.php | 6 +- generated/8.5/cubrid.php | 587 ------------------------------- generated/8.5/dir.php | 4 +- generated/8.5/eio.php | 74 +--- generated/8.5/filesystem.php | 20 +- generated/8.5/filter.php | 57 ++- generated/8.5/funchand.php | 3 +- generated/8.5/functionsList.php | 2 +- generated/8.5/ibmDb2.php | 119 ------- generated/8.5/image.php | 10 +- generated/8.5/info.php | 32 +- generated/8.5/ldap.php | 6 +- generated/8.5/mbstring.php | 51 ++- generated/8.5/misc.php | 15 +- generated/8.5/mysql.php | 5 - generated/8.5/network.php | 4 +- generated/8.5/openssl.php | 32 +- generated/8.5/outcontrol.php | 10 +- generated/8.5/pcntl.php | 31 +- generated/8.5/pcre.php | 3 - generated/8.5/pgsql.php | 10 +- generated/8.5/posix.php | 6 +- generated/8.5/ps.php | 8 - generated/8.5/pspell.php | 47 ++- generated/8.5/rector-migrate.php | 2 +- generated/8.5/rpminfo.php | 9 +- generated/8.5/sem.php | 2 - generated/8.5/session.php | 34 +- generated/8.5/sodium.php | 28 +- generated/8.5/ssh2.php | 123 ------- generated/8.5/strings.php | 5 +- generated/8.5/uodbc.php | 21 +- generated/8.5/xdiff.php | 30 ++ generated/8.5/xml.php | 4 +- generated/8.5/yaml.php | 15 +- generated/8.5/zlib.php | 17 +- 92 files changed, 1077 insertions(+), 1273 deletions(-) diff --git a/generated/8.1/filesystem.php b/generated/8.1/filesystem.php index ad1f3707..b7c549b8 100644 --- a/generated/8.1/filesystem.php +++ b/generated/8.1/filesystem.php @@ -406,7 +406,7 @@ function file_put_contents(string $filename, $data, int $flags = 0, $context = n * * * - * @param resource $context + * @param resource $context Search for the file in the include_path. * @return list Returns the file in an array. Each element of the array corresponds to a * line in the file, with the newline still attached. Upon failure, * file returns FALSE. @@ -429,7 +429,7 @@ function file(string $filename, int $flags = 0, $context = null): array /** - * + * Gets the last access time of the given file. * * @param string $filename Path to the file. * @return int Returns the time the file was last accessed. @@ -1022,7 +1022,9 @@ function ftruncate($stream, int $size): void /** - * + * fwrite writes the contents of + * string to the file stream pointed to by + * handle. * * @param resource $handle A file system pointer resource * that is typically created using fopen. @@ -1031,7 +1033,8 @@ function ftruncate($stream, int $size): void * stop after length bytes have been written or * the end of string is reached, whichever comes * first. - * @return 0|positive-int + * @return 0|positive-int fwrite returns the number of bytes + * written. * @throws FilesystemException * */ diff --git a/generated/8.1/funchand.php b/generated/8.1/funchand.php index 1569f372..2c04487a 100644 --- a/generated/8.1/funchand.php +++ b/generated/8.1/funchand.php @@ -5,7 +5,8 @@ use Safe\Exceptions\FunchandException; /** - * + * Registers the given callback to be executed when a + * tick is called. * * @param callable(): void $callback The function to register. * @param mixed $args diff --git a/generated/8.1/image.php b/generated/8.1/image.php index 7f6aa731..222aa46b 100644 --- a/generated/8.1/image.php +++ b/generated/8.1/image.php @@ -1079,8 +1079,10 @@ function imagecrop(\GdImage $image, array $rectangle): \GdImage * @param \GdImage $image A GdImage object, returned by one of the image creation functions, * such as imagecreatetruecolor. * @param int $mode One of the following constants: - * @param float $threshold - * @param int $color + * @param float $threshold Same as IMG_CROP_TRANSPARENT. + * Before PHP 7.4.0, the bundled libgd fell back to IMG_CROP_SIDES, + * if the image had no transparent color. + * @param int $color Crops out a transparent background. * @return \GdImage Returns a cropped image object on success. * If the complete image was cropped, imagecrop returns FALSE. * @throws ImageException diff --git a/generated/8.1/info.php b/generated/8.1/info.php index 74883146..59578bb0 100644 --- a/generated/8.1/info.php +++ b/generated/8.1/info.php @@ -232,7 +232,8 @@ function get_cfg_var(string $option) /** - * + * Gets the current include_path + * configuration option value. * * @return string Returns the path, as a string. * @throws InfoException @@ -273,7 +274,7 @@ function getlastmod(): int /** - * + * Gets the group ID of the current script. * * @return int Returns the group ID of the current script. * @throws InfoException @@ -327,7 +328,7 @@ function getmypid(): int /** - * + * Gets the user ID of the current script. * * @return int Returns the user ID of the current script. * @throws InfoException @@ -347,9 +348,22 @@ function getmyuid(): int /** * Parses options passed to the script. * - * @param string $short_options - * @param array $long_options - * @param int|null $rest_index + * @param string $short_options Each character in this string will be used as option characters and + * matched against options passed to the script starting with a single + * hyphen (-). + * + * For example, an option string "x" recognizes an + * option -x. + * + * Only a-z, A-Z and 0-9 are allowed. + * @param array $long_options An array of options. Each element in this array will be used as option + * strings and matched against options passed to the script starting with + * two hyphens (--). + * + * For example, an longopts element "opt" recognizes an + * option --opt. + * @param int|null $rest_index If the rest_index parameter is present, then the + * index where argument parsing stopped will be written to this variable. * @return array|array|array This function will return an array of option / argument pairs. * @throws InfoException * @@ -434,7 +448,11 @@ function ini_set(string $option, $value): string /** - * + * Returns a lowercase string that describes the type of interface + * (the Server API, SAPI) that PHP is using. For example, in CLI PHP this + * string will be "cli" whereas with Apache it may have several different + * values depending on the exact SAPI used. Possible values are listed + * below. * * @return non-empty-string Returns the interface type, as a lowercase string. * diff --git a/generated/8.1/mbstring.php b/generated/8.1/mbstring.php index f574c435..70e7ff37 100644 --- a/generated/8.1/mbstring.php +++ b/generated/8.1/mbstring.php @@ -219,14 +219,16 @@ function mb_ereg_replace_callback(string $pattern, callable $callback, string $s /** - * + * Scans string for matches to + * pattern, then replaces the matched text + * with replacement * * @param string $pattern The regular expression pattern. * * Multibyte characters may be used in pattern. * @param string $replacement The replacement text. * @param string $string The string being checked. - * @param null|string $options + * @param null|string $options The search option. See mb_regex_set_options for explanation. * @return null|string The resultant string on success. * If string is not valid for the current encoding, NULL * is returned. @@ -249,9 +251,17 @@ function mb_ereg_replace(string $pattern, string $replacement, string $string, ? /** + * Retrieve the result from the last multibyte regular expression match * - * - * @return array + * @return array An array + * including the sub-string of matched part by last + * mb_ereg_search, + * mb_ereg_search_pos, + * mb_ereg_search_regs. If there are some + * matches, the first element will have the matched sub-string, the + * second element will have the first part grouped with brackets, + * the third element will have the second part grouped with + * brackets, and so on. It returns FALSE on error. * @throws MbstringException * */ @@ -301,7 +311,12 @@ function mb_ereg_search_init(string $string, ?string $pattern = null, ?string $o * * @param null|string $pattern The search pattern. * @param null|string $options The search option. See mb_regex_set_options for explanation. - * @return array + * @return array mb_ereg_search_regs executes the multibyte + * regular expression match, and if there are some matched part, it + * returns an array including substring of matched part as first + * element, the first grouped part with brackets as second element, + * the second grouped part as third element, and so on. + * It returns FALSE on error. * @throws MbstringException * */ @@ -323,7 +338,8 @@ function mb_ereg_search_regs(?string $pattern = null, ?string $options = null): /** - * + * mb_ereg_search_setpos sets the starting + * point of a match for mb_ereg_search. * * @param int $offset The position to set. If it is negative, it counts from the end of the string. * @throws MbstringException @@ -340,12 +356,14 @@ function mb_ereg_search_setpos(int $offset): void /** - * + * Scans string for matches to + * pattern, then replaces the matched text + * with replacement. * * @param string $pattern The regular expression pattern. Multibyte characters may be used. The case will be ignored. * @param string $replacement The replacement text. * @param string $string The searched string. - * @param null|string $options + * @param null|string $options The search option. See mb_regex_set_options for explanation. * @return string The resultant string. * If string is not valid for the current encoding, NULL * is returned. @@ -368,7 +386,7 @@ function mb_eregi_replace(string $pattern, string $replacement, string $string, /** - * + * mb_get_info returns the internal setting parameters of mbstring. * * @param string $type If type is not specified or is specified as "all", * "internal_encoding", "http_input", @@ -526,7 +544,11 @@ function mb_parse_str(string $string, ?array &$result): void * @param null|string $encoding The encoding * parameter is the character encoding. If it is omitted or NULL, the internal character * encoding value will be used. - * @return bool|string + * @return bool|string If encoding is set, then + * Returns TRUE on success. + * In this case, the internal character encoding is NOT changed. + * If encoding is omitted, then + * the current character encoding name for a multibyte regex is returned. * @throws MbstringException * */ @@ -617,11 +639,16 @@ function mb_send_mail(string $to, string $subject, string $message, $additional_ /** - * + * Split a multibyte + * string using regular expression + * pattern and returns the result as an + * array. * * @param string $pattern The regular expression pattern. * @param string $string The string being split. - * @param int $limit + * @param int $limit If optional parameter limit is specified, + * it will be split in limit elements as + * maximum. * @return list The result as an array. * @throws MbstringException * diff --git a/generated/8.1/misc.php b/generated/8.1/misc.php index 66effb1c..da9c2ace 100644 --- a/generated/8.1/misc.php +++ b/generated/8.1/misc.php @@ -70,7 +70,8 @@ function highlight_file(string $filename, bool $return = false) /** - * + * Outputs or returns html markup for a syntax highlighted version of the given PHP code + * using the colors defined in the built-in syntax highlighter for PHP. * * @param string $string The PHP code to be highlighted. This should include the opening tag. * @param bool $return Set this parameter to TRUE to make this function return the @@ -93,7 +94,8 @@ function highlight_string(string $string, bool $return = false) /** - * + * Returns the system's high resolution time, counted from an arbitrary point in time. + * The delivered timestamp is monotonic and can not be adjusted. * * @param bool $as_number Whether the high resolution time should be returned as array * or number. @@ -374,7 +376,9 @@ function sapi_windows_generate_ctrl_event(int $event, int $pid = 0): void * * Setting a NULL handler causes the process to ignore * CTRL+C events, but not CTRL+BREAK events. - * @param bool $add + * @param bool $add The CTRL event which has been received; + * either PHP_WINDOWS_EVENT_CTRL_C + * or PHP_WINDOWS_EVENT_CTRL_BREAK. * @throws MiscException * */ @@ -419,7 +423,8 @@ function sapi_windows_vt100_support($stream, ?bool $enable = null): void /** - * + * Delays the program execution for the given number of + * seconds. * * @param int $seconds Halt time in seconds. * @return int Returns zero on success. diff --git a/generated/8.1/network.php b/generated/8.1/network.php index f644b206..f6ddd6cd 100644 --- a/generated/8.1/network.php +++ b/generated/8.1/network.php @@ -429,7 +429,9 @@ function header_register_callback(callable $callback): void /** - * + * This function converts a 32bit IPv4, or 128bit IPv6 address (if PHP + * was built with IPv6 support enabled) into an address family appropriate + * string representation. * * @param string $ip A 32bit IPv4, or 128bit IPv6 address. * @return string Returns a string representation of the address. diff --git a/generated/8.1/outcontrol.php b/generated/8.1/outcontrol.php index 8d3c4946..2e094bc8 100644 --- a/generated/8.1/outcontrol.php +++ b/generated/8.1/outcontrol.php @@ -211,8 +211,8 @@ function ob_get_clean(): string * compressed web pages. ob_gzhandler determines * what type of content encoding the browser will accept and will return * its output accordingly. - * @param int $chunk_size - * @param int $flags + * @param int $chunk_size Contents of the output buffer. + * @param int $flags Bitmask of PHP_OUTPUT_HANDLER_* constants. * @throws OutcontrolException * */ diff --git a/generated/8.1/pcntl.php b/generated/8.1/pcntl.php index b82093a9..0493ec61 100644 --- a/generated/8.1/pcntl.php +++ b/generated/8.1/pcntl.php @@ -126,7 +126,7 @@ function pcntl_signal_dispatch(): void * Note that when you set a handler to an object method, that object's * reference count is increased which makes it persist until you either * change the handler to something else, or your script ends. - * @param bool $restart_syscalls + * @param bool $restart_syscalls The signal being handled. * @throws PcntlException * */ diff --git a/generated/8.1/pspell.php b/generated/8.1/pspell.php index 7ef3d259..826a9ce3 100644 --- a/generated/8.1/pspell.php +++ b/generated/8.1/pspell.php @@ -5,7 +5,11 @@ use Safe\Exceptions\PspellException; /** - * + * pspell_add_to_personal adds a word to the personal + * wordlist. If you used pspell_new_config with + * pspell_config_personal to open the dictionary, + * you can save the wordlist later with + * pspell_save_wordlist. * * @param int $dictionary An PSpell\Dictionary instance. * @param string $word The added word. @@ -23,7 +27,9 @@ function pspell_add_to_personal(int $dictionary, string $word): void /** - * + * pspell_add_to_session adds a word to the wordlist + * associated with the current session. It is very similar to + * pspell_add_to_personal * * @param int $dictionary An PSpell\Dictionary instance. * @param string $word The added word. @@ -41,7 +47,9 @@ function pspell_add_to_session(int $dictionary, string $word): void /** - * + * pspell_clear_session clears the current session. + * The current wordlist becomes blank, and, for example, if you try to save + * it with pspell_save_wordlist, nothing happens. * * @param int $dictionary An PSpell\Dictionary instance. * @throws PspellException @@ -142,7 +150,9 @@ function pspell_config_dict_dir(int $config, string $directory): void /** - * + * pspell_config_ignore should be used on a config + * before calling pspell_new_config. This function + * allows short words to be skipped by the spell checker. * * @param int $config An PSpell\Config instance. * @param int $min_length Words less than min_length characters will be skipped. @@ -160,7 +170,10 @@ function pspell_config_ignore(int $config, int $min_length): void /** - * + * pspell_config_mode should be used on a config + * before calling pspell_new_config. This function + * determines how many suggestions will be returned by + * pspell_suggest. * * @param int $config An PSpell\Config instance. * @param int $mode The mode parameter is the mode in which spellchecker will work. @@ -303,7 +316,13 @@ function pspell_config_save_repl(int $config, bool $save): void /** - * + * pspell_new_config opens up a new dictionary with + * settings specified in a config, created with + * pspell_config_create and modified with + * pspell_config_* functions. This method provides you + * with the most flexibility and has all the functionality provided by + * pspell_new and + * pspell_new_personal. * * @param int $config The config parameter is the one returned by * pspell_config_create when the config was created. @@ -466,7 +485,10 @@ function pspell_new(string $language, string $spelling = "", string $jargon = "" /** - * + * pspell_save_wordlist saves the personal wordlist from + * the current session. The location of files to be saved specified with + * pspell_config_personal and (optionally) + * pspell_config_repl. * * @param int $dictionary An PSpell\Dictionary instance. * @throws PspellException @@ -483,7 +505,16 @@ function pspell_save_wordlist(int $dictionary): void /** - * + * pspell_store_replacement stores a replacement pair for + * a word, so that replacement can be returned by + * pspell_suggest later. In order to be able to take + * advantage of this function, you have to use + * pspell_new_personal to open the dictionary. In order + * to permanently save the replacement pair, you have to + * use pspell_config_personal and + * pspell_config_repl to set the path where to save your + * custom wordlists, and then use pspell_save_wordlist + * for the changes to be written to disk. * * @param int $dictionary An PSpell\Dictionary instance. * @param string $misspelled The misspelled word. diff --git a/generated/8.1/strings.php b/generated/8.1/strings.php index 79c88c4c..4b673a75 100644 --- a/generated/8.1/strings.php +++ b/generated/8.1/strings.php @@ -68,7 +68,10 @@ function md5_file(string $filename, bool $binary = false): string /** - * + * Calculates the sha1 hash of the file specified by + * filename using the + * US Secure Hash Algorithm 1, + * and returns that hash. The hash is a 40-character hexadecimal number. * * @param string $filename The filename of the file to hash. * @param bool $binary When TRUE, returns the digest in raw binary format with a length of diff --git a/generated/8.1/uodbc.php b/generated/8.1/uodbc.php index 2262edd0..3afbd818 100644 --- a/generated/8.1/uodbc.php +++ b/generated/8.1/uodbc.php @@ -277,7 +277,17 @@ function odbc_commit($odbc): void /** - * + * The connection id returned by this functions is needed by other + * ODBC functions. You can have multiple connections open at once as long as + * they either use different db or different credentials. + * + * With some ODBC drivers, executing a complex stored procedure may + * fail with an error similar to: "Cannot open a cursor on a stored + * procedure that has anything other than a single select statement + * in it". Using SQL_CUR_USE_ODBC may avoid that error. Also, some + * drivers don't support the optional row_number parameter in + * odbc_fetch_row. SQL_CUR_USE_ODBC might help + * in that case, too. * * @param string $dsn The database source name for the connection. Alternatively, a * DSN-less connection string can be used. @@ -1002,7 +1012,14 @@ function odbc_setoption($odbc, int $which, int $option, int $value): void * * @param resource $odbc The ODBC connection object, * see odbc_connect for details. - * @param int $type + * @param int $type When the type argument is SQL_BEST_ROWID, + * odbc_specialcolumns returns the + * column or columns that uniquely identify each row in the table. + * + * When the type argument is SQL_ROWVER, + * odbc_specialcolumns returns the column or columns in the + * specified table, if any, that are automatically updated by the data source + * when any value in the row is updated by any transaction. * @param string $catalog The catalog ('qualifier' in ODBC 2 parlance). * @param string $schema The schema ('owner' in ODBC 2 parlance). * @param string $table The table. diff --git a/generated/8.1/xml.php b/generated/8.1/xml.php index 8193e2b5..8b53cf72 100644 --- a/generated/8.1/xml.php +++ b/generated/8.1/xml.php @@ -7,7 +7,7 @@ /** * Frees the given XML parser. * - * @param \XMLParser $parser + * @param \XMLParser $parser A reference to the XML parser to free. * @throws XmlException * */ @@ -191,7 +191,8 @@ function xml_set_default_handler(\XMLParser $parser, callable $handler): void * * * - * @param callable $end_handler + * @param callable $end_handler The first parameter, parser, is a + * reference to the XML parser calling the handler. * @throws XmlException * */ diff --git a/generated/8.2/filesystem.php b/generated/8.2/filesystem.php index 3ce33ca6..677241be 100644 --- a/generated/8.2/filesystem.php +++ b/generated/8.2/filesystem.php @@ -406,7 +406,7 @@ function file_put_contents(string $filename, $data, int $flags = 0, $context = n * * * - * @param null|resource $context + * @param null|resource $context Search for the file in the include_path. * @return list Returns the file in an array. Each element of the array corresponds to a * line in the file, with the newline still attached. Upon failure, * file returns FALSE. @@ -429,7 +429,7 @@ function file(string $filename, int $flags = 0, $context = null): array /** - * + * Gets the last access time of the given file. * * @param string $filename Path to the file. * @return int Returns the time the file was last accessed. @@ -1022,7 +1022,9 @@ function ftruncate($stream, int $size): void /** - * + * fwrite writes the contents of + * data to the file stream pointed to by + * stream. * * @param resource $stream A file system pointer resource * that is typically created using fopen. @@ -1030,7 +1032,8 @@ function ftruncate($stream, int $size): void * @param 0|null|positive-int $length If length is an integer, writing will stop * after length bytes have been written or the * end of data is reached, whichever comes first. - * @return 0|positive-int + * @return 0|positive-int fwrite returns the number of bytes + * written. * @throws FilesystemException * */ diff --git a/generated/8.2/funchand.php b/generated/8.2/funchand.php index 1569f372..2c04487a 100644 --- a/generated/8.2/funchand.php +++ b/generated/8.2/funchand.php @@ -5,7 +5,8 @@ use Safe\Exceptions\FunchandException; /** - * + * Registers the given callback to be executed when a + * tick is called. * * @param callable(): void $callback The function to register. * @param mixed $args diff --git a/generated/8.2/image.php b/generated/8.2/image.php index 4b2a40f7..b37bfa2d 100644 --- a/generated/8.2/image.php +++ b/generated/8.2/image.php @@ -1076,8 +1076,10 @@ function imagecrop(\GdImage $image, array $rectangle): \GdImage * @param \GdImage $image A GdImage object, returned by one of the image creation functions, * such as imagecreatetruecolor. * @param int $mode One of the following constants: - * @param float $threshold - * @param int $color + * @param float $threshold Same as IMG_CROP_TRANSPARENT. + * Before PHP 7.4.0, the bundled libgd fell back to IMG_CROP_SIDES, + * if the image had no transparent color. + * @param int $color Crops out a transparent background. * @return \GdImage Returns a cropped image object on success. * If the complete image was cropped, imagecrop returns FALSE. * @throws ImageException diff --git a/generated/8.2/info.php b/generated/8.2/info.php index ecc445f9..284a36fa 100644 --- a/generated/8.2/info.php +++ b/generated/8.2/info.php @@ -232,7 +232,8 @@ function get_cfg_var(string $option) /** - * + * Gets the current include_path + * configuration option value. * * @return string Returns the path, as a string. * @throws InfoException @@ -273,7 +274,7 @@ function getlastmod(): int /** - * + * Gets the group ID of the current script. * * @return int Returns the group ID of the current script. * @throws InfoException @@ -327,7 +328,7 @@ function getmypid(): int /** - * + * Gets the user ID of the current script. * * @return int Returns the user ID of the current script. * @throws InfoException @@ -347,9 +348,22 @@ function getmyuid(): int /** * Parses options passed to the script. * - * @param string $short_options - * @param array $long_options - * @param int|null $rest_index + * @param string $short_options Each character in this string will be used as option characters and + * matched against options passed to the script starting with a single + * hyphen (-). + * + * For example, an option string "x" recognizes an + * option -x. + * + * Only a-z, A-Z and 0-9 are allowed. + * @param array $long_options An array of options. Each element in this array will be used as option + * strings and matched against options passed to the script starting with + * two hyphens (--). + * + * For example, an longopts element "opt" recognizes an + * option --opt. + * @param int|null $rest_index If the rest_index parameter is present, then the + * index where argument parsing stopped will be written to this variable. * @return array|array|array This function will return an array of option / argument pairs. * @throws InfoException * @@ -434,7 +448,11 @@ function ini_set(string $option, $value): string /** - * + * Returns a lowercase string that describes the type of interface + * (the Server API, SAPI) that PHP is using. For example, in CLI PHP this + * string will be "cli" whereas with Apache it may have several different + * values depending on the exact SAPI used. Possible values are listed + * below. * * @return non-empty-string Returns the interface type, as a lowercase string. * diff --git a/generated/8.2/mbstring.php b/generated/8.2/mbstring.php index 67ca2a51..c51b6831 100644 --- a/generated/8.2/mbstring.php +++ b/generated/8.2/mbstring.php @@ -222,14 +222,16 @@ function mb_ereg_replace_callback(string $pattern, callable $callback, string $s /** - * + * Scans string for matches to + * pattern, then replaces the matched text + * with replacement * * @param string $pattern The regular expression pattern. * * Multibyte characters may be used in pattern. * @param string $replacement The replacement text. * @param string $string The string being checked. - * @param null|string $options + * @param null|string $options The search option. See mb_regex_set_options for explanation. * @return null|string The resultant string on success. * If string is not valid for the current encoding, NULL * is returned. @@ -252,9 +254,17 @@ function mb_ereg_replace(string $pattern, string $replacement, string $string, ? /** + * Retrieve the result from the last multibyte regular expression match * - * - * @return array + * @return array An array + * including the sub-string of matched part by last + * mb_ereg_search, + * mb_ereg_search_pos, + * mb_ereg_search_regs. If there are some + * matches, the first element will have the matched sub-string, the + * second element will have the first part grouped with brackets, + * the third element will have the second part grouped with + * brackets, and so on. It returns FALSE on error. * @throws MbstringException * */ @@ -304,7 +314,12 @@ function mb_ereg_search_init(string $string, ?string $pattern = null, ?string $o * * @param null|string $pattern The search pattern. * @param null|string $options The search option. See mb_regex_set_options for explanation. - * @return array + * @return array mb_ereg_search_regs executes the multibyte + * regular expression match, and if there are some matched part, it + * returns an array including substring of matched part as first + * element, the first grouped part with brackets as second element, + * the second grouped part as third element, and so on. + * It returns FALSE on error. * @throws MbstringException * */ @@ -326,7 +341,8 @@ function mb_ereg_search_regs(?string $pattern = null, ?string $options = null): /** - * + * mb_ereg_search_setpos sets the starting + * point of a match for mb_ereg_search. * * @param int $offset The position to set. If it is negative, it counts from the end of the string. * @throws MbstringException @@ -343,12 +359,14 @@ function mb_ereg_search_setpos(int $offset): void /** - * + * Scans string for matches to + * pattern, then replaces the matched text + * with replacement. * * @param string $pattern The regular expression pattern. Multibyte characters may be used. The case will be ignored. * @param string $replacement The replacement text. * @param string $string The searched string. - * @param null|string $options + * @param null|string $options The search option. See mb_regex_set_options for explanation. * @return string The resultant string. * If string is not valid for the current encoding, NULL * is returned. @@ -371,7 +389,7 @@ function mb_eregi_replace(string $pattern, string $replacement, string $string, /** - * + * mb_get_info returns the internal setting parameters of mbstring. * * @param string $type If type is not specified or is specified as "all", * "internal_encoding", "http_input", @@ -529,7 +547,11 @@ function mb_parse_str(string $string, ?array &$result): void * @param null|string $encoding The encoding * parameter is the character encoding. If it is omitted or NULL, the internal character * encoding value will be used. - * @return bool|string + * @return bool|string If encoding is set, then + * Returns TRUE on success. + * In this case, the internal character encoding is NOT changed. + * If encoding is omitted, then + * the current character encoding name for a multibyte regex is returned. * @throws MbstringException * */ @@ -620,11 +642,16 @@ function mb_send_mail(string $to, string $subject, string $message, $additional_ /** - * + * Split a multibyte + * string using regular expression + * pattern and returns the result as an + * array. * * @param string $pattern The regular expression pattern. * @param string $string The string being split. - * @param int $limit + * @param int $limit If optional parameter limit is specified, + * it will be split in limit elements as + * maximum. * @return list The result as an array. * @throws MbstringException * diff --git a/generated/8.2/misc.php b/generated/8.2/misc.php index cc20e38f..5bbab456 100644 --- a/generated/8.2/misc.php +++ b/generated/8.2/misc.php @@ -70,7 +70,8 @@ function highlight_file(string $filename, bool $return = false) /** - * + * Outputs or returns html markup for a syntax highlighted version of the given PHP code + * using the colors defined in the built-in syntax highlighter for PHP. * * @param string $string The PHP code to be highlighted. This should include the opening tag. * @param bool $return Set this parameter to TRUE to make this function return the @@ -93,7 +94,8 @@ function highlight_string(string $string, bool $return = false) /** - * + * Returns the system's high resolution time, counted from an arbitrary point in time. + * The delivered timestamp is monotonic and can not be adjusted. * * @param bool $as_number Whether the high resolution time should be returned as array * or number. @@ -374,7 +376,9 @@ function sapi_windows_generate_ctrl_event(int $event, int $pid = 0): void * * Setting a NULL handler causes the process to ignore * CTRL+C events, but not CTRL+BREAK events. - * @param bool $add + * @param bool $add The CTRL event which has been received; + * either PHP_WINDOWS_EVENT_CTRL_C + * or PHP_WINDOWS_EVENT_CTRL_BREAK. * @throws MiscException * */ @@ -419,7 +423,8 @@ function sapi_windows_vt100_support($stream, ?bool $enable = null): void /** - * + * Delays the program execution for the given number of + * seconds. * * @param int $seconds Halt time in seconds (must be greater than or equal to 0). * @return false|int Returns zero on success. diff --git a/generated/8.2/network.php b/generated/8.2/network.php index 483308a2..d52ae368 100644 --- a/generated/8.2/network.php +++ b/generated/8.2/network.php @@ -429,7 +429,9 @@ function header_register_callback(callable $callback): void /** - * + * This function converts a 32bit IPv4, or 128bit IPv6 address (if PHP + * was built with IPv6 support enabled) into an address family appropriate + * string representation. * * @param string $ip A 32bit IPv4, or 128bit IPv6 address. * @return string Returns a string representation of the address. diff --git a/generated/8.2/outcontrol.php b/generated/8.2/outcontrol.php index 8d3c4946..2e094bc8 100644 --- a/generated/8.2/outcontrol.php +++ b/generated/8.2/outcontrol.php @@ -211,8 +211,8 @@ function ob_get_clean(): string * compressed web pages. ob_gzhandler determines * what type of content encoding the browser will accept and will return * its output accordingly. - * @param int $chunk_size - * @param int $flags + * @param int $chunk_size Contents of the output buffer. + * @param int $flags Bitmask of PHP_OUTPUT_HANDLER_* constants. * @throws OutcontrolException * */ diff --git a/generated/8.2/pcntl.php b/generated/8.2/pcntl.php index 047f5a23..5105a993 100644 --- a/generated/8.2/pcntl.php +++ b/generated/8.2/pcntl.php @@ -128,7 +128,7 @@ function pcntl_signal_dispatch(): void * Note that when you set a handler to an object method, that object's * reference count is increased which makes it persist until you either * change the handler to something else, or your script ends. - * @param bool $restart_syscalls + * @param bool $restart_syscalls The signal being handled. * @throws PcntlException * */ diff --git a/generated/8.2/pspell.php b/generated/8.2/pspell.php index 7ef3d259..826a9ce3 100644 --- a/generated/8.2/pspell.php +++ b/generated/8.2/pspell.php @@ -5,7 +5,11 @@ use Safe\Exceptions\PspellException; /** - * + * pspell_add_to_personal adds a word to the personal + * wordlist. If you used pspell_new_config with + * pspell_config_personal to open the dictionary, + * you can save the wordlist later with + * pspell_save_wordlist. * * @param int $dictionary An PSpell\Dictionary instance. * @param string $word The added word. @@ -23,7 +27,9 @@ function pspell_add_to_personal(int $dictionary, string $word): void /** - * + * pspell_add_to_session adds a word to the wordlist + * associated with the current session. It is very similar to + * pspell_add_to_personal * * @param int $dictionary An PSpell\Dictionary instance. * @param string $word The added word. @@ -41,7 +47,9 @@ function pspell_add_to_session(int $dictionary, string $word): void /** - * + * pspell_clear_session clears the current session. + * The current wordlist becomes blank, and, for example, if you try to save + * it with pspell_save_wordlist, nothing happens. * * @param int $dictionary An PSpell\Dictionary instance. * @throws PspellException @@ -142,7 +150,9 @@ function pspell_config_dict_dir(int $config, string $directory): void /** - * + * pspell_config_ignore should be used on a config + * before calling pspell_new_config. This function + * allows short words to be skipped by the spell checker. * * @param int $config An PSpell\Config instance. * @param int $min_length Words less than min_length characters will be skipped. @@ -160,7 +170,10 @@ function pspell_config_ignore(int $config, int $min_length): void /** - * + * pspell_config_mode should be used on a config + * before calling pspell_new_config. This function + * determines how many suggestions will be returned by + * pspell_suggest. * * @param int $config An PSpell\Config instance. * @param int $mode The mode parameter is the mode in which spellchecker will work. @@ -303,7 +316,13 @@ function pspell_config_save_repl(int $config, bool $save): void /** - * + * pspell_new_config opens up a new dictionary with + * settings specified in a config, created with + * pspell_config_create and modified with + * pspell_config_* functions. This method provides you + * with the most flexibility and has all the functionality provided by + * pspell_new and + * pspell_new_personal. * * @param int $config The config parameter is the one returned by * pspell_config_create when the config was created. @@ -466,7 +485,10 @@ function pspell_new(string $language, string $spelling = "", string $jargon = "" /** - * + * pspell_save_wordlist saves the personal wordlist from + * the current session. The location of files to be saved specified with + * pspell_config_personal and (optionally) + * pspell_config_repl. * * @param int $dictionary An PSpell\Dictionary instance. * @throws PspellException @@ -483,7 +505,16 @@ function pspell_save_wordlist(int $dictionary): void /** - * + * pspell_store_replacement stores a replacement pair for + * a word, so that replacement can be returned by + * pspell_suggest later. In order to be able to take + * advantage of this function, you have to use + * pspell_new_personal to open the dictionary. In order + * to permanently save the replacement pair, you have to + * use pspell_config_personal and + * pspell_config_repl to set the path where to save your + * custom wordlists, and then use pspell_save_wordlist + * for the changes to be written to disk. * * @param int $dictionary An PSpell\Dictionary instance. * @param string $misspelled The misspelled word. diff --git a/generated/8.2/strings.php b/generated/8.2/strings.php index 79c88c4c..4b673a75 100644 --- a/generated/8.2/strings.php +++ b/generated/8.2/strings.php @@ -68,7 +68,10 @@ function md5_file(string $filename, bool $binary = false): string /** - * + * Calculates the sha1 hash of the file specified by + * filename using the + * US Secure Hash Algorithm 1, + * and returns that hash. The hash is a 40-character hexadecimal number. * * @param string $filename The filename of the file to hash. * @param bool $binary When TRUE, returns the digest in raw binary format with a length of diff --git a/generated/8.2/uodbc.php b/generated/8.2/uodbc.php index 2262edd0..3afbd818 100644 --- a/generated/8.2/uodbc.php +++ b/generated/8.2/uodbc.php @@ -277,7 +277,17 @@ function odbc_commit($odbc): void /** - * + * The connection id returned by this functions is needed by other + * ODBC functions. You can have multiple connections open at once as long as + * they either use different db or different credentials. + * + * With some ODBC drivers, executing a complex stored procedure may + * fail with an error similar to: "Cannot open a cursor on a stored + * procedure that has anything other than a single select statement + * in it". Using SQL_CUR_USE_ODBC may avoid that error. Also, some + * drivers don't support the optional row_number parameter in + * odbc_fetch_row. SQL_CUR_USE_ODBC might help + * in that case, too. * * @param string $dsn The database source name for the connection. Alternatively, a * DSN-less connection string can be used. @@ -1002,7 +1012,14 @@ function odbc_setoption($odbc, int $which, int $option, int $value): void * * @param resource $odbc The ODBC connection object, * see odbc_connect for details. - * @param int $type + * @param int $type When the type argument is SQL_BEST_ROWID, + * odbc_specialcolumns returns the + * column or columns that uniquely identify each row in the table. + * + * When the type argument is SQL_ROWVER, + * odbc_specialcolumns returns the column or columns in the + * specified table, if any, that are automatically updated by the data source + * when any value in the row is updated by any transaction. * @param string $catalog The catalog ('qualifier' in ODBC 2 parlance). * @param string $schema The schema ('owner' in ODBC 2 parlance). * @param string $table The table. diff --git a/generated/8.2/xml.php b/generated/8.2/xml.php index 8193e2b5..8b53cf72 100644 --- a/generated/8.2/xml.php +++ b/generated/8.2/xml.php @@ -7,7 +7,7 @@ /** * Frees the given XML parser. * - * @param \XMLParser $parser + * @param \XMLParser $parser A reference to the XML parser to free. * @throws XmlException * */ @@ -191,7 +191,8 @@ function xml_set_default_handler(\XMLParser $parser, callable $handler): void * * * - * @param callable $end_handler + * @param callable $end_handler The first parameter, parser, is a + * reference to the XML parser calling the handler. * @throws XmlException * */ diff --git a/generated/8.3/filesystem.php b/generated/8.3/filesystem.php index 3ce33ca6..677241be 100644 --- a/generated/8.3/filesystem.php +++ b/generated/8.3/filesystem.php @@ -406,7 +406,7 @@ function file_put_contents(string $filename, $data, int $flags = 0, $context = n * * * - * @param null|resource $context + * @param null|resource $context Search for the file in the include_path. * @return list Returns the file in an array. Each element of the array corresponds to a * line in the file, with the newline still attached. Upon failure, * file returns FALSE. @@ -429,7 +429,7 @@ function file(string $filename, int $flags = 0, $context = null): array /** - * + * Gets the last access time of the given file. * * @param string $filename Path to the file. * @return int Returns the time the file was last accessed. @@ -1022,7 +1022,9 @@ function ftruncate($stream, int $size): void /** - * + * fwrite writes the contents of + * data to the file stream pointed to by + * stream. * * @param resource $stream A file system pointer resource * that is typically created using fopen. @@ -1030,7 +1032,8 @@ function ftruncate($stream, int $size): void * @param 0|null|positive-int $length If length is an integer, writing will stop * after length bytes have been written or the * end of data is reached, whichever comes first. - * @return 0|positive-int + * @return 0|positive-int fwrite returns the number of bytes + * written. * @throws FilesystemException * */ diff --git a/generated/8.3/funchand.php b/generated/8.3/funchand.php index 1569f372..2c04487a 100644 --- a/generated/8.3/funchand.php +++ b/generated/8.3/funchand.php @@ -5,7 +5,8 @@ use Safe\Exceptions\FunchandException; /** - * + * Registers the given callback to be executed when a + * tick is called. * * @param callable(): void $callback The function to register. * @param mixed $args diff --git a/generated/8.3/image.php b/generated/8.3/image.php index 97c3e616..b24c6519 100644 --- a/generated/8.3/image.php +++ b/generated/8.3/image.php @@ -1076,8 +1076,10 @@ function imagecrop(\GdImage $image, array $rectangle): \GdImage * @param \GdImage $image A GdImage object, returned by one of the image creation functions, * such as imagecreatetruecolor. * @param int $mode One of the following constants: - * @param float $threshold - * @param int $color + * @param float $threshold Same as IMG_CROP_TRANSPARENT. + * Before PHP 7.4.0, the bundled libgd fell back to IMG_CROP_SIDES, + * if the image had no transparent color. + * @param int $color Crops out a transparent background. * @return \GdImage Returns a cropped image object on success. * If the complete image was cropped, imagecrop returns FALSE. * @throws ImageException diff --git a/generated/8.3/info.php b/generated/8.3/info.php index ecc445f9..284a36fa 100644 --- a/generated/8.3/info.php +++ b/generated/8.3/info.php @@ -232,7 +232,8 @@ function get_cfg_var(string $option) /** - * + * Gets the current include_path + * configuration option value. * * @return string Returns the path, as a string. * @throws InfoException @@ -273,7 +274,7 @@ function getlastmod(): int /** - * + * Gets the group ID of the current script. * * @return int Returns the group ID of the current script. * @throws InfoException @@ -327,7 +328,7 @@ function getmypid(): int /** - * + * Gets the user ID of the current script. * * @return int Returns the user ID of the current script. * @throws InfoException @@ -347,9 +348,22 @@ function getmyuid(): int /** * Parses options passed to the script. * - * @param string $short_options - * @param array $long_options - * @param int|null $rest_index + * @param string $short_options Each character in this string will be used as option characters and + * matched against options passed to the script starting with a single + * hyphen (-). + * + * For example, an option string "x" recognizes an + * option -x. + * + * Only a-z, A-Z and 0-9 are allowed. + * @param array $long_options An array of options. Each element in this array will be used as option + * strings and matched against options passed to the script starting with + * two hyphens (--). + * + * For example, an longopts element "opt" recognizes an + * option --opt. + * @param int|null $rest_index If the rest_index parameter is present, then the + * index where argument parsing stopped will be written to this variable. * @return array|array|array This function will return an array of option / argument pairs. * @throws InfoException * @@ -434,7 +448,11 @@ function ini_set(string $option, $value): string /** - * + * Returns a lowercase string that describes the type of interface + * (the Server API, SAPI) that PHP is using. For example, in CLI PHP this + * string will be "cli" whereas with Apache it may have several different + * values depending on the exact SAPI used. Possible values are listed + * below. * * @return non-empty-string Returns the interface type, as a lowercase string. * diff --git a/generated/8.3/mbstring.php b/generated/8.3/mbstring.php index 67ca2a51..c51b6831 100644 --- a/generated/8.3/mbstring.php +++ b/generated/8.3/mbstring.php @@ -222,14 +222,16 @@ function mb_ereg_replace_callback(string $pattern, callable $callback, string $s /** - * + * Scans string for matches to + * pattern, then replaces the matched text + * with replacement * * @param string $pattern The regular expression pattern. * * Multibyte characters may be used in pattern. * @param string $replacement The replacement text. * @param string $string The string being checked. - * @param null|string $options + * @param null|string $options The search option. See mb_regex_set_options for explanation. * @return null|string The resultant string on success. * If string is not valid for the current encoding, NULL * is returned. @@ -252,9 +254,17 @@ function mb_ereg_replace(string $pattern, string $replacement, string $string, ? /** + * Retrieve the result from the last multibyte regular expression match * - * - * @return array + * @return array An array + * including the sub-string of matched part by last + * mb_ereg_search, + * mb_ereg_search_pos, + * mb_ereg_search_regs. If there are some + * matches, the first element will have the matched sub-string, the + * second element will have the first part grouped with brackets, + * the third element will have the second part grouped with + * brackets, and so on. It returns FALSE on error. * @throws MbstringException * */ @@ -304,7 +314,12 @@ function mb_ereg_search_init(string $string, ?string $pattern = null, ?string $o * * @param null|string $pattern The search pattern. * @param null|string $options The search option. See mb_regex_set_options for explanation. - * @return array + * @return array mb_ereg_search_regs executes the multibyte + * regular expression match, and if there are some matched part, it + * returns an array including substring of matched part as first + * element, the first grouped part with brackets as second element, + * the second grouped part as third element, and so on. + * It returns FALSE on error. * @throws MbstringException * */ @@ -326,7 +341,8 @@ function mb_ereg_search_regs(?string $pattern = null, ?string $options = null): /** - * + * mb_ereg_search_setpos sets the starting + * point of a match for mb_ereg_search. * * @param int $offset The position to set. If it is negative, it counts from the end of the string. * @throws MbstringException @@ -343,12 +359,14 @@ function mb_ereg_search_setpos(int $offset): void /** - * + * Scans string for matches to + * pattern, then replaces the matched text + * with replacement. * * @param string $pattern The regular expression pattern. Multibyte characters may be used. The case will be ignored. * @param string $replacement The replacement text. * @param string $string The searched string. - * @param null|string $options + * @param null|string $options The search option. See mb_regex_set_options for explanation. * @return string The resultant string. * If string is not valid for the current encoding, NULL * is returned. @@ -371,7 +389,7 @@ function mb_eregi_replace(string $pattern, string $replacement, string $string, /** - * + * mb_get_info returns the internal setting parameters of mbstring. * * @param string $type If type is not specified or is specified as "all", * "internal_encoding", "http_input", @@ -529,7 +547,11 @@ function mb_parse_str(string $string, ?array &$result): void * @param null|string $encoding The encoding * parameter is the character encoding. If it is omitted or NULL, the internal character * encoding value will be used. - * @return bool|string + * @return bool|string If encoding is set, then + * Returns TRUE on success. + * In this case, the internal character encoding is NOT changed. + * If encoding is omitted, then + * the current character encoding name for a multibyte regex is returned. * @throws MbstringException * */ @@ -620,11 +642,16 @@ function mb_send_mail(string $to, string $subject, string $message, $additional_ /** - * + * Split a multibyte + * string using regular expression + * pattern and returns the result as an + * array. * * @param string $pattern The regular expression pattern. * @param string $string The string being split. - * @param int $limit + * @param int $limit If optional parameter limit is specified, + * it will be split in limit elements as + * maximum. * @return list The result as an array. * @throws MbstringException * diff --git a/generated/8.3/misc.php b/generated/8.3/misc.php index cc20e38f..5bbab456 100644 --- a/generated/8.3/misc.php +++ b/generated/8.3/misc.php @@ -70,7 +70,8 @@ function highlight_file(string $filename, bool $return = false) /** - * + * Outputs or returns html markup for a syntax highlighted version of the given PHP code + * using the colors defined in the built-in syntax highlighter for PHP. * * @param string $string The PHP code to be highlighted. This should include the opening tag. * @param bool $return Set this parameter to TRUE to make this function return the @@ -93,7 +94,8 @@ function highlight_string(string $string, bool $return = false) /** - * + * Returns the system's high resolution time, counted from an arbitrary point in time. + * The delivered timestamp is monotonic and can not be adjusted. * * @param bool $as_number Whether the high resolution time should be returned as array * or number. @@ -374,7 +376,9 @@ function sapi_windows_generate_ctrl_event(int $event, int $pid = 0): void * * Setting a NULL handler causes the process to ignore * CTRL+C events, but not CTRL+BREAK events. - * @param bool $add + * @param bool $add The CTRL event which has been received; + * either PHP_WINDOWS_EVENT_CTRL_C + * or PHP_WINDOWS_EVENT_CTRL_BREAK. * @throws MiscException * */ @@ -419,7 +423,8 @@ function sapi_windows_vt100_support($stream, ?bool $enable = null): void /** - * + * Delays the program execution for the given number of + * seconds. * * @param int $seconds Halt time in seconds (must be greater than or equal to 0). * @return false|int Returns zero on success. diff --git a/generated/8.3/network.php b/generated/8.3/network.php index 483308a2..d52ae368 100644 --- a/generated/8.3/network.php +++ b/generated/8.3/network.php @@ -429,7 +429,9 @@ function header_register_callback(callable $callback): void /** - * + * This function converts a 32bit IPv4, or 128bit IPv6 address (if PHP + * was built with IPv6 support enabled) into an address family appropriate + * string representation. * * @param string $ip A 32bit IPv4, or 128bit IPv6 address. * @return string Returns a string representation of the address. diff --git a/generated/8.3/outcontrol.php b/generated/8.3/outcontrol.php index 8d3c4946..2e094bc8 100644 --- a/generated/8.3/outcontrol.php +++ b/generated/8.3/outcontrol.php @@ -211,8 +211,8 @@ function ob_get_clean(): string * compressed web pages. ob_gzhandler determines * what type of content encoding the browser will accept and will return * its output accordingly. - * @param int $chunk_size - * @param int $flags + * @param int $chunk_size Contents of the output buffer. + * @param int $flags Bitmask of PHP_OUTPUT_HANDLER_* constants. * @throws OutcontrolException * */ diff --git a/generated/8.3/pcntl.php b/generated/8.3/pcntl.php index 047f5a23..5105a993 100644 --- a/generated/8.3/pcntl.php +++ b/generated/8.3/pcntl.php @@ -128,7 +128,7 @@ function pcntl_signal_dispatch(): void * Note that when you set a handler to an object method, that object's * reference count is increased which makes it persist until you either * change the handler to something else, or your script ends. - * @param bool $restart_syscalls + * @param bool $restart_syscalls The signal being handled. * @throws PcntlException * */ diff --git a/generated/8.3/pspell.php b/generated/8.3/pspell.php index 7ef3d259..826a9ce3 100644 --- a/generated/8.3/pspell.php +++ b/generated/8.3/pspell.php @@ -5,7 +5,11 @@ use Safe\Exceptions\PspellException; /** - * + * pspell_add_to_personal adds a word to the personal + * wordlist. If you used pspell_new_config with + * pspell_config_personal to open the dictionary, + * you can save the wordlist later with + * pspell_save_wordlist. * * @param int $dictionary An PSpell\Dictionary instance. * @param string $word The added word. @@ -23,7 +27,9 @@ function pspell_add_to_personal(int $dictionary, string $word): void /** - * + * pspell_add_to_session adds a word to the wordlist + * associated with the current session. It is very similar to + * pspell_add_to_personal * * @param int $dictionary An PSpell\Dictionary instance. * @param string $word The added word. @@ -41,7 +47,9 @@ function pspell_add_to_session(int $dictionary, string $word): void /** - * + * pspell_clear_session clears the current session. + * The current wordlist becomes blank, and, for example, if you try to save + * it with pspell_save_wordlist, nothing happens. * * @param int $dictionary An PSpell\Dictionary instance. * @throws PspellException @@ -142,7 +150,9 @@ function pspell_config_dict_dir(int $config, string $directory): void /** - * + * pspell_config_ignore should be used on a config + * before calling pspell_new_config. This function + * allows short words to be skipped by the spell checker. * * @param int $config An PSpell\Config instance. * @param int $min_length Words less than min_length characters will be skipped. @@ -160,7 +170,10 @@ function pspell_config_ignore(int $config, int $min_length): void /** - * + * pspell_config_mode should be used on a config + * before calling pspell_new_config. This function + * determines how many suggestions will be returned by + * pspell_suggest. * * @param int $config An PSpell\Config instance. * @param int $mode The mode parameter is the mode in which spellchecker will work. @@ -303,7 +316,13 @@ function pspell_config_save_repl(int $config, bool $save): void /** - * + * pspell_new_config opens up a new dictionary with + * settings specified in a config, created with + * pspell_config_create and modified with + * pspell_config_* functions. This method provides you + * with the most flexibility and has all the functionality provided by + * pspell_new and + * pspell_new_personal. * * @param int $config The config parameter is the one returned by * pspell_config_create when the config was created. @@ -466,7 +485,10 @@ function pspell_new(string $language, string $spelling = "", string $jargon = "" /** - * + * pspell_save_wordlist saves the personal wordlist from + * the current session. The location of files to be saved specified with + * pspell_config_personal and (optionally) + * pspell_config_repl. * * @param int $dictionary An PSpell\Dictionary instance. * @throws PspellException @@ -483,7 +505,16 @@ function pspell_save_wordlist(int $dictionary): void /** - * + * pspell_store_replacement stores a replacement pair for + * a word, so that replacement can be returned by + * pspell_suggest later. In order to be able to take + * advantage of this function, you have to use + * pspell_new_personal to open the dictionary. In order + * to permanently save the replacement pair, you have to + * use pspell_config_personal and + * pspell_config_repl to set the path where to save your + * custom wordlists, and then use pspell_save_wordlist + * for the changes to be written to disk. * * @param int $dictionary An PSpell\Dictionary instance. * @param string $misspelled The misspelled word. diff --git a/generated/8.3/strings.php b/generated/8.3/strings.php index 79c88c4c..4b673a75 100644 --- a/generated/8.3/strings.php +++ b/generated/8.3/strings.php @@ -68,7 +68,10 @@ function md5_file(string $filename, bool $binary = false): string /** - * + * Calculates the sha1 hash of the file specified by + * filename using the + * US Secure Hash Algorithm 1, + * and returns that hash. The hash is a 40-character hexadecimal number. * * @param string $filename The filename of the file to hash. * @param bool $binary When TRUE, returns the digest in raw binary format with a length of diff --git a/generated/8.3/uodbc.php b/generated/8.3/uodbc.php index 2262edd0..3afbd818 100644 --- a/generated/8.3/uodbc.php +++ b/generated/8.3/uodbc.php @@ -277,7 +277,17 @@ function odbc_commit($odbc): void /** - * + * The connection id returned by this functions is needed by other + * ODBC functions. You can have multiple connections open at once as long as + * they either use different db or different credentials. + * + * With some ODBC drivers, executing a complex stored procedure may + * fail with an error similar to: "Cannot open a cursor on a stored + * procedure that has anything other than a single select statement + * in it". Using SQL_CUR_USE_ODBC may avoid that error. Also, some + * drivers don't support the optional row_number parameter in + * odbc_fetch_row. SQL_CUR_USE_ODBC might help + * in that case, too. * * @param string $dsn The database source name for the connection. Alternatively, a * DSN-less connection string can be used. @@ -1002,7 +1012,14 @@ function odbc_setoption($odbc, int $which, int $option, int $value): void * * @param resource $odbc The ODBC connection object, * see odbc_connect for details. - * @param int $type + * @param int $type When the type argument is SQL_BEST_ROWID, + * odbc_specialcolumns returns the + * column or columns that uniquely identify each row in the table. + * + * When the type argument is SQL_ROWVER, + * odbc_specialcolumns returns the column or columns in the + * specified table, if any, that are automatically updated by the data source + * when any value in the row is updated by any transaction. * @param string $catalog The catalog ('qualifier' in ODBC 2 parlance). * @param string $schema The schema ('owner' in ODBC 2 parlance). * @param string $table The table. diff --git a/generated/8.3/xml.php b/generated/8.3/xml.php index 8193e2b5..8b53cf72 100644 --- a/generated/8.3/xml.php +++ b/generated/8.3/xml.php @@ -7,7 +7,7 @@ /** * Frees the given XML parser. * - * @param \XMLParser $parser + * @param \XMLParser $parser A reference to the XML parser to free. * @throws XmlException * */ @@ -191,7 +191,8 @@ function xml_set_default_handler(\XMLParser $parser, callable $handler): void * * * - * @param callable $end_handler + * @param callable $end_handler The first parameter, parser, is a + * reference to the XML parser calling the handler. * @throws XmlException * */ diff --git a/generated/8.4/array.php b/generated/8.4/array.php index ce5c1179..addd5cb3 100644 --- a/generated/8.4/array.php +++ b/generated/8.4/array.php @@ -5,9 +5,11 @@ use Safe\Exceptions\ArrayException; /** + * array_all returns TRUE, if the given + * callback returns TRUE for all elements. + * Otherwise the function returns FALSE. * - * - * @param array $array + * @param array $array The array that should be searched. * @param callable $callback The callback function to call to check each element, which must be * * boolcallback diff --git a/generated/8.4/filesystem.php b/generated/8.4/filesystem.php index d007be18..9bf69875 100644 --- a/generated/8.4/filesystem.php +++ b/generated/8.4/filesystem.php @@ -416,7 +416,7 @@ function file_put_contents(string $filename, $data, int $flags = 0, $context = n * * * - * @param null|resource $context + * @param null|resource $context Search for the file in the include_path. * @return list Returns the file in an array. Each element of the array corresponds to a * line in the file, with the newline still attached. Upon failure, * file returns FALSE. @@ -439,7 +439,7 @@ function file(string $filename, int $flags = 0, $context = null): array /** - * + * Gets the last access time of the given file. * * @param string $filename Path to the file. * @return int Returns the time the file was last accessed. @@ -1032,7 +1032,9 @@ function ftruncate($stream, int $size): void /** - * + * fwrite writes the contents of + * data to the file stream pointed to by + * stream. * * @param resource $stream A file system pointer resource * that is typically created using fopen. @@ -1040,7 +1042,8 @@ function ftruncate($stream, int $size): void * @param 0|null|positive-int $length If length is an integer, writing will stop * after length bytes have been written or the * end of data is reached, whichever comes first. - * @return 0|positive-int + * @return 0|positive-int fwrite returns the number of bytes + * written. * @throws FilesystemException * */ diff --git a/generated/8.4/filter.php b/generated/8.4/filter.php index 09eca12c..68c2ec7d 100644 --- a/generated/8.4/filter.php +++ b/generated/8.4/filter.php @@ -8,10 +8,31 @@ * This function is useful for retrieving many values without * repetitively calling filter_input. * - * @param int $type + * @param int $type One of the INPUT_* constants. + * + * The content of the superglobal that is being filtered is the original + * "raw" content provided by the SAPI, + * prior to any user modification to the superglobal. + * To filter a modified superglobal use + * filter_var_array instead. * @param array|int $options * @param bool $add_empty - * @return array|null + * @return array|null On success, an array containing the values of the requested variables. + * + * On failure, FALSE is returned. + * Except if the failure is that the input array designated by + * type is not populated where NULL is returned + * if the FILTER_NULL_ON_FAILURE flag is used. + * + * Missing entries from the input array will be populated into the returned + * array if add_empty is TRUE. + * In which case, missing entries will be set to NULL, + * unless the FILTER_NULL_ON_FAILURE flag is used, + * in which case it will be FALSE. + * + * An entry of the returned array will be FALSE if the filter fails, + * unless the FILTER_NULL_ON_FAILURE flag is used, + * in which case it will be NULL. * @throws FilterException * */ @@ -27,10 +48,38 @@ function filter_input_array(int $type, $options = FILTER_DEFAULT, bool $add_empt /** + * Filter an associative array of values using + * FILTER_VALIDATE_* + * validation filters, + * FILTER_SANITIZE_* + * sanitization filters, or custom filters. + * + * @param array $array An associative array containing the data to filter. + * @param mixed $options Either an associative array of options, + * or the filter to apply to each entry, + * which can either be a validation filter by using one of the + * FILTER_VALIDATE_* + * constants, or a sanitization filter by using one of the + * FILTER_SANITIZE_* + * constants. * + * The option array is an associative array where the key corresponds + * to a key in the data array and the associated + * value is either the filter to apply to this entry, + * or an associative array describing how and which filter should be + * applied to this entry. * - * @param array $array - * @param mixed $options + * The associative array describing how a filter should be applied + * must contain the 'filter' key whose associated + * value is the filter to apply, which can be one of the + * FILTER_VALIDATE_*, + * FILTER_SANITIZE_*, + * FILTER_UNSAFE_RAW, or + * FILTER_CALLBACK constants. + * It can optionally contain the 'flags' key + * which specifies and flags that apply to the filter, + * and the 'options' key which specifies any options + * that apply to the filter. * @param bool $add_empty Add missing keys as NULL to the return value. * @return array|null An array containing the values of the requested variables on success. An array value will be FALSE if the filter fails, or NULL if * the variable is not set. diff --git a/generated/8.4/funchand.php b/generated/8.4/funchand.php index 1569f372..2c04487a 100644 --- a/generated/8.4/funchand.php +++ b/generated/8.4/funchand.php @@ -5,7 +5,8 @@ use Safe\Exceptions\FunchandException; /** - * + * Registers the given callback to be executed when a + * tick is called. * * @param callable(): void $callback The function to register. * @param mixed $args diff --git a/generated/8.4/image.php b/generated/8.4/image.php index 63f29c9b..f6bf97bb 100644 --- a/generated/8.4/image.php +++ b/generated/8.4/image.php @@ -1076,8 +1076,10 @@ function imagecrop(\GdImage $image, array $rectangle): \GdImage * @param \GdImage $image A GdImage object, returned by one of the image creation functions, * such as imagecreatetruecolor. * @param int $mode One of the following constants: - * @param float $threshold - * @param int $color + * @param float $threshold Same as IMG_CROP_TRANSPARENT. + * Before PHP 7.4.0, the bundled libgd fell back to IMG_CROP_SIDES, + * if the image had no transparent color. + * @param int $color Crops out a transparent background. * @return \GdImage Returns a cropped image object on success. * FALSE is also returned if the whole image was cropped. * @throws ImageException diff --git a/generated/8.4/info.php b/generated/8.4/info.php index 9312cdaa..11be92d8 100644 --- a/generated/8.4/info.php +++ b/generated/8.4/info.php @@ -237,7 +237,8 @@ function get_cfg_var(string $option) /** - * + * Gets the current include_path + * configuration option value. * * @return string Returns the path, as a string. * @throws InfoException @@ -278,7 +279,7 @@ function getlastmod(): int /** - * + * Gets the group ID of the current script. * * @return int Returns the group ID of the current script. * @throws InfoException @@ -332,7 +333,7 @@ function getmypid(): int /** - * + * Gets the user ID of the current script. * * @return int Returns the user ID of the current script. * @throws InfoException @@ -352,9 +353,22 @@ function getmyuid(): int /** * Parses options passed to the script. * - * @param string $short_options - * @param array $long_options - * @param int|null $rest_index + * @param string $short_options Each character in this string will be used as option characters and + * matched against options passed to the script starting with a single + * hyphen (-). + * + * For example, an option string "x" recognizes an + * option -x. + * + * Only a-z, A-Z and 0-9 are allowed. + * @param array $long_options An array of options. Each element in this array will be used as option + * strings and matched against options passed to the script starting with + * two hyphens (--). + * + * For example, an longopts element "opt" recognizes an + * option --opt. + * @param int|null $rest_index If the rest_index parameter is present, then the + * index where argument parsing stopped will be written to this variable. * @return array|array|array This function will return an array of option / argument pairs. * @throws InfoException * @@ -439,7 +453,11 @@ function ini_set(string $option, $value): string /** - * + * Returns a lowercase string that describes the type of interface + * (the Server API, SAPI) that PHP is using. For example, in CLI PHP this + * string will be "cli" whereas with Apache it may have several different + * values depending on the exact SAPI used. Possible values are listed + * below. * * @return non-empty-string Returns the interface type, as a lowercase string. * diff --git a/generated/8.4/mbstring.php b/generated/8.4/mbstring.php index 21375cbb..cfe06c81 100644 --- a/generated/8.4/mbstring.php +++ b/generated/8.4/mbstring.php @@ -218,14 +218,16 @@ function mb_ereg_replace_callback(string $pattern, callable $callback, string $s /** - * + * Scans string for matches to + * pattern, then replaces the matched text + * with replacement * * @param string $pattern The regular expression pattern. * * Multibyte characters may be used in pattern. * @param string $replacement The replacement text. * @param string $string The string being checked. - * @param null|string $options + * @param null|string $options The search option. See mb_regex_set_options for explanation. * @return null|string The resultant string on success. * If string is not valid for the current encoding, NULL * is returned. @@ -248,9 +250,17 @@ function mb_ereg_replace(string $pattern, string $replacement, string $string, ? /** + * Retrieve the result from the last multibyte regular expression match * - * - * @return array + * @return array An array + * including the sub-string of matched part by last + * mb_ereg_search, + * mb_ereg_search_pos, + * mb_ereg_search_regs. If there are some + * matches, the first element will have the matched sub-string, the + * second element will have the first part grouped with brackets, + * the third element will have the second part grouped with + * brackets, and so on. It returns FALSE on error. * @throws MbstringException * */ @@ -300,7 +310,12 @@ function mb_ereg_search_init(string $string, ?string $pattern = null, ?string $o * * @param null|string $pattern The search pattern. * @param null|string $options The search option. See mb_regex_set_options for explanation. - * @return array + * @return array mb_ereg_search_regs executes the multibyte + * regular expression match, and if there are some matched part, it + * returns an array including substring of matched part as first + * element, the first grouped part with brackets as second element, + * the second grouped part as third element, and so on. + * It returns FALSE on error. * @throws MbstringException * */ @@ -322,7 +337,8 @@ function mb_ereg_search_regs(?string $pattern = null, ?string $options = null): /** - * + * mb_ereg_search_setpos sets the starting + * point of a match for mb_ereg_search. * * @param int $offset The position to set. If it is negative, it counts from the end of the string. * @throws MbstringException @@ -339,12 +355,14 @@ function mb_ereg_search_setpos(int $offset): void /** - * + * Scans string for matches to + * pattern, then replaces the matched text + * with replacement. * * @param string $pattern The regular expression pattern. Multibyte characters may be used. The case will be ignored. * @param string $replacement The replacement text. * @param string $string The searched string. - * @param null|string $options + * @param null|string $options The search option. See mb_regex_set_options for explanation. * @return string The resultant string. * If string is not valid for the current encoding, NULL * is returned. @@ -367,7 +385,7 @@ function mb_eregi_replace(string $pattern, string $replacement, string $string, /** - * + * mb_get_info returns the internal setting parameters of mbstring. * * @param string $type If type is not specified or is specified as "all", * "internal_encoding", "http_input", @@ -525,7 +543,11 @@ function mb_parse_str(string $string, ?array &$result): void * @param null|string $encoding The encoding * parameter is the character encoding. If it is omitted or NULL, the internal character * encoding value will be used. - * @return bool|string + * @return bool|string If encoding is set, then + * Returns TRUE on success. + * In this case, the internal character encoding is NOT changed. + * If encoding is omitted, then + * the current character encoding name for a multibyte regex is returned. * @throws MbstringException * */ @@ -616,11 +638,16 @@ function mb_send_mail(string $to, string $subject, string $message, $additional_ /** - * + * Split a multibyte + * string using regular expression + * pattern and returns the result as an + * array. * * @param string $pattern The regular expression pattern. * @param string $string The string being split. - * @param int $limit + * @param int $limit If optional parameter limit is specified, + * it will be split in limit elements as + * maximum. * @return list The result as an array. * @throws MbstringException * diff --git a/generated/8.4/misc.php b/generated/8.4/misc.php index e76bad04..20af6b18 100644 --- a/generated/8.4/misc.php +++ b/generated/8.4/misc.php @@ -70,7 +70,8 @@ function highlight_file(string $filename, bool $return = false) /** - * + * Outputs or returns html markup for a syntax highlighted version of the given PHP code + * using the colors defined in the built-in syntax highlighter for PHP. * * @param string $string The PHP code to be highlighted. This should include the opening tag. * @param bool $return Set this parameter to TRUE to make this function return the @@ -89,7 +90,8 @@ function highlight_string(string $string, bool $return = false) /** - * + * Returns the system's high resolution time, counted from an arbitrary point in time. + * The delivered timestamp is monotonic and can not be adjusted. * * @param bool $as_number Whether the high resolution time should be returned as array * or number. @@ -385,7 +387,9 @@ function sapi_windows_generate_ctrl_event(int $event, int $pid = 0): void * BREAK * * events. - * @param bool $add + * @param bool $add The CTRL event which has been received; + * either PHP_WINDOWS_EVENT_CTRL_C + * or PHP_WINDOWS_EVENT_CTRL_BREAK. * @throws MiscException * */ @@ -430,7 +434,8 @@ function sapi_windows_vt100_support($stream, ?bool $enable = null): void /** - * + * Delays the program execution for the given number of + * seconds. * * @param int $seconds Halt time in seconds (must be greater than or equal to 0). * @return false|int Returns zero on success. diff --git a/generated/8.4/network.php b/generated/8.4/network.php index fd1a9e67..3812b5d1 100644 --- a/generated/8.4/network.php +++ b/generated/8.4/network.php @@ -412,7 +412,9 @@ function header_register_callback(callable $callback): void /** - * + * This function converts a 32bit IPv4, or 128bit IPv6 address (if PHP + * was built with IPv6 support enabled) into an address family appropriate + * string representation. * * @param string $ip A 32bit IPv4, or 128bit IPv6 address. * @return string Returns a string representation of the address. diff --git a/generated/8.4/outcontrol.php b/generated/8.4/outcontrol.php index 68dd25df..2fd5378a 100644 --- a/generated/8.4/outcontrol.php +++ b/generated/8.4/outcontrol.php @@ -242,8 +242,14 @@ function ob_get_flush(): string * See * and * for more details on callbacks (output handlers). - * @param int $chunk_size - * @param int $flags + * @param int $chunk_size Contents of the output buffer. + * @param int $flags Bitmask of + * + * PHP_OUTPUT_HANDLER_* + * constants + * . + * See + * for more details. * @throws OutcontrolException * */ diff --git a/generated/8.4/pcntl.php b/generated/8.4/pcntl.php index 047f5a23..5105a993 100644 --- a/generated/8.4/pcntl.php +++ b/generated/8.4/pcntl.php @@ -128,7 +128,7 @@ function pcntl_signal_dispatch(): void * Note that when you set a handler to an object method, that object's * reference count is increased which makes it persist until you either * change the handler to something else, or your script ends. - * @param bool $restart_syscalls + * @param bool $restart_syscalls The signal being handled. * @throws PcntlException * */ diff --git a/generated/8.4/pgsql.php b/generated/8.4/pgsql.php index 0d84b419..0a7a4ba5 100644 --- a/generated/8.4/pgsql.php +++ b/generated/8.4/pgsql.php @@ -1294,10 +1294,14 @@ function pg_select(\PgSql\Connection $connection, string $table_name, array $con /** - * + * Set the query results to be retrieved in chunk mode. + * The query results returned afterward will be divided into multiple chunks, + * each containing up to size rows. + * This function must be called before retrieving results with pg_get_result. + * This function is only available when libpq is version 17 or higher. * * @param \PgSql\Connection $connection An PgSql\Connection instance. - * @param int $size + * @param int $size The number of rows to be retrieved in each chunk. * @throws PgsqlException * */ diff --git a/generated/8.4/pspell.php b/generated/8.4/pspell.php index bf852387..b06330ba 100644 --- a/generated/8.4/pspell.php +++ b/generated/8.4/pspell.php @@ -5,7 +5,11 @@ use Safe\Exceptions\PspellException; /** - * + * pspell_add_to_personal adds a word to the personal + * wordlist. If you used pspell_new_config with + * pspell_config_personal to open the dictionary, + * you can save the wordlist later with + * pspell_save_wordlist. * * @param int $dictionary An PSpell\Dictionary instance. * @param string $word The added word. @@ -23,7 +27,9 @@ function pspell_add_to_personal(int $dictionary, string $word): void /** - * + * pspell_add_to_session adds a word to the wordlist + * associated with the current session. It is very similar to + * pspell_add_to_personal * * @param int $dictionary An PSpell\Dictionary instance. * @param string $word The added word. @@ -41,7 +47,9 @@ function pspell_add_to_session(int $dictionary, string $word): void /** - * + * pspell_clear_session clears the current session. + * The current wordlist becomes blank, and, for example, if you try to save + * it with pspell_save_wordlist, nothing happens. * * @param int $dictionary An PSpell\Dictionary instance. * @throws PspellException @@ -138,7 +146,9 @@ function pspell_config_dict_dir(int $config, string $directory): void /** - * + * pspell_config_ignore should be used on a config + * before calling pspell_new_config. This function + * allows short words to be skipped by the spell checker. * * @param int $config An PSpell\Config instance. * @param int $min_length Words less than min_length characters will be skipped. @@ -156,7 +166,10 @@ function pspell_config_ignore(int $config, int $min_length): void /** - * + * pspell_config_mode should be used on a config + * before calling pspell_new_config. This function + * determines how many suggestions will be returned by + * pspell_suggest. * * @param int $config An PSpell\Config instance. * @param int $mode The mode parameter is the mode in which spellchecker will work. @@ -299,7 +312,13 @@ function pspell_config_save_repl(int $config, bool $save): void /** - * + * pspell_new_config opens up a new dictionary with + * settings specified in a config, created with + * pspell_config_create and modified with + * pspell_config_* functions. This method provides you + * with the most flexibility and has all the functionality provided by + * pspell_new and + * pspell_new_personal. * * @param int $config The config parameter is the one returned by * pspell_config_create when the config was created. @@ -462,7 +481,10 @@ function pspell_new(string $language, string $spelling = "", string $jargon = "" /** - * + * pspell_save_wordlist saves the personal wordlist from + * the current session. The location of files to be saved specified with + * pspell_config_personal and (optionally) + * pspell_config_repl. * * @param int $dictionary An PSpell\Dictionary instance. * @throws PspellException @@ -479,7 +501,16 @@ function pspell_save_wordlist(int $dictionary): void /** - * + * pspell_store_replacement stores a replacement pair for + * a word, so that replacement can be returned by + * pspell_suggest later. In order to be able to take + * advantage of this function, you have to use + * pspell_new_personal to open the dictionary. In order + * to permanently save the replacement pair, you have to + * use pspell_config_personal and + * pspell_config_repl to set the path where to save your + * custom wordlists, and then use pspell_save_wordlist + * for the changes to be written to disk. * * @param int $dictionary An PSpell\Dictionary instance. * @param string $misspelled The misspelled word. diff --git a/generated/8.4/sodium.php b/generated/8.4/sodium.php index a8f74119..0f2649bb 100644 --- a/generated/8.4/sodium.php +++ b/generated/8.4/sodium.php @@ -5,13 +5,14 @@ use Safe\Exceptions\SodiumException; /** + * Verify then decrypt a message with AEGIS-128L. * - * - * @param string $ciphertext - * @param string $additional_data - * @param string $nonce - * @param string $key - * @return string + * @param string $ciphertext Must be in the format provided by sodium_crypto_aead_aegis128l_encrypt. + * @param string $additional_data Additional, authenticated data. This is used in the verification of the authentication tag + * appended to the ciphertext, but it is not encrypted or stored in the ciphertext. + * @param string $nonce A number that must be only used once, per message. + * @param string $key Encryption key (128-bit). + * @return string Returns the plaintext on success. * @throws SodiumException * */ @@ -27,13 +28,14 @@ function sodium_crypto_aead_aegis128l_decrypt(string $ciphertext, string $additi /** + * Verify then decrypt a message with AEGIS-256. * - * - * @param string $ciphertext - * @param string $additional_data - * @param string $nonce - * @param string $key - * @return string + * @param string $ciphertext Must be in the format provided by sodium_crypto_aead_aegis256_encrypt. + * @param string $additional_data Additional, authenticated data. This is used in the verification of the authentication tag + * appended to the ciphertext, but it is not encrypted or stored in the ciphertext. + * @param string $nonce A number that must be only used once, per message. + * @param string $key Encryption key (256-bit). + * @return string Returns the plaintext on success. * @throws SodiumException * */ diff --git a/generated/8.4/strings.php b/generated/8.4/strings.php index 79c88c4c..4b673a75 100644 --- a/generated/8.4/strings.php +++ b/generated/8.4/strings.php @@ -68,7 +68,10 @@ function md5_file(string $filename, bool $binary = false): string /** - * + * Calculates the sha1 hash of the file specified by + * filename using the + * US Secure Hash Algorithm 1, + * and returns that hash. The hash is a 40-character hexadecimal number. * * @param string $filename The filename of the file to hash. * @param bool $binary When TRUE, returns the digest in raw binary format with a length of diff --git a/generated/8.4/uodbc.php b/generated/8.4/uodbc.php index fc97a514..f2b0092e 100644 --- a/generated/8.4/uodbc.php +++ b/generated/8.4/uodbc.php @@ -270,7 +270,17 @@ function odbc_commit(\Odbc\Connection $odbc): void /** - * + * The connection id returned by this functions is needed by other + * ODBC functions. You can have multiple connections open at once as long as + * they either use different db or different credentials. + * + * With some ODBC drivers, executing a complex stored procedure may + * fail with an error similar to: "Cannot open a cursor on a stored + * procedure that has anything other than a single select statement + * in it". Using SQL_CUR_USE_ODBC may avoid that error. Also, some + * drivers don't support the optional row_number parameter in + * odbc_fetch_row. SQL_CUR_USE_ODBC might help + * in that case, too. * * @param string $dsn The database source name for the connection. Alternatively, a * DSN-less connection string can be used. @@ -979,7 +989,14 @@ function odbc_setoption($odbc, int $which, int $option, int $value): void * * @param \Odbc\Connection $odbc The ODBC connection object, * see odbc_connect for details. - * @param int $type + * @param int $type When the type argument is SQL_BEST_ROWID, + * odbc_specialcolumns returns the + * column or columns that uniquely identify each row in the table. + * + * When the type argument is SQL_ROWVER, + * odbc_specialcolumns returns the column or columns in the + * specified table, if any, that are automatically updated by the data source + * when any value in the row is updated by any transaction. * @param string $catalog The catalog ('qualifier' in ODBC 2 parlance). * @param string $schema The schema ('owner' in ODBC 2 parlance). * @param string $table The table. diff --git a/generated/8.4/xml.php b/generated/8.4/xml.php index a4ee48df..7eb056fc 100644 --- a/generated/8.4/xml.php +++ b/generated/8.4/xml.php @@ -7,7 +7,7 @@ /** * Frees the given XML parser. * - * @param \XMLParser $parser + * @param \XMLParser $parser A reference to the XML parser to free. * @throws XmlException * */ @@ -311,7 +311,7 @@ function xml_set_default_handler(\XMLParser $parser, callable $handler): bool * * * - * @param callable $end_handler + * @param callable $end_handler The XML parser calling the handler. * @return bool Always returns TRUE. * */ diff --git a/generated/8.5/array.php b/generated/8.5/array.php index ce5c1179..addd5cb3 100644 --- a/generated/8.5/array.php +++ b/generated/8.5/array.php @@ -5,9 +5,11 @@ use Safe\Exceptions\ArrayException; /** + * array_all returns TRUE, if the given + * callback returns TRUE for all elements. + * Otherwise the function returns FALSE. * - * - * @param array $array + * @param array $array The array that should be searched. * @param callable $callback The callback function to call to check each element, which must be * * boolcallback diff --git a/generated/8.5/cubrid.php b/generated/8.5/cubrid.php index 423f0cc5..fc7ddade 100644 --- a/generated/8.5/cubrid.php +++ b/generated/8.5/cubrid.php @@ -13,106 +13,6 @@ * * The following table shows the types of substitute values. * - * - * CUBRID Bind Date Types - * - * - * - * Support - * Bind Type - * Corresponding SQL Type - * - * - * - * - * Supported - * STRING - * CHAR, VARCHAR - * - * - * - * NCHAR - * NCHAR, NVARCHAR - * - * - * - * BIT - * BIT, VARBIT - * - * - * - * NUMERIC or NUMBER - * SHORT, INT, NUMERIC - * - * - * - * FLOAT - * FLOAT - * - * - * - * DOUBLE - * DOUBLE - * - * - * - * TIME - * TIME - * - * - * - * DATE - * DATE - * - * - * - * TIMESTAMP - * TIMESTAMP - * - * - * - * OBJECT - * OBJECT - * - * - * - * ENUM - * ENUM - * - * - * - * BLOB - * BLOB - * - * - * - * CLOB - * CLOB - * - * - * - * NULL - * NULL - * - * - * Not supported - * SET - * SET - * - * - * - * MULTISET - * MULTISET - * - * - * - * SEQUENCE - * SEQUENCE - * - * - * - * - * * @param resource $req_identifier Request identifier as a result of * cubrid_prepare. * @param int $bind_index Location of binding parameters. It starts with 1. @@ -256,38 +156,6 @@ function cubrid_commit($conn_identifier): void * * <milli_sec> := MILLI SECOND * - * - * host : A host name or IP address of the master database - * db_name : A name of the database - * db_user : A name of the database user - * db_password : A database user password - * - * alhosts : Specifies the broker information of the standby server, which is - * used for failover when it is impossible to connect to the active server. - * You can specify multiple brokers for failover, and the connection to the brokers - * is attempted in the order listed in alhosts - * - * rctime : An interval between the attempts to connect to the active broker in - * which failure occurred. After a failure occurs, the system connects to the - * broker specified by althosts (failover), terminates the transaction, and then - * attempts to connect to the active broker of the master database at every rctime. - * The default value is 600 seconds. - * - * login_timeout : Timeout value (unit: msec.) for database login. The default - * value is 0, which means infinite postponement. - * - * - * query_timeout : Timeout value (unit: msec.) for query request. Upon timeout, - * a message to cancel requesting a query transferred to server is sent. The return - * value can depend on the disconnect_on_query_timeout configuration; even though the - * message to cancel a request is sent to server, that request may succeed. - * - * - * disconnect_on_query_timeout : Configures a value whether to immediately return - * an error of function being executed upon timeout. The default value is false. - * - * - * * @param string $conn_url A character string that contains server connection information. * @param string $userid User name for the database. * @param string $passwd User password. @@ -513,50 +381,6 @@ function cubrid_get_client_info(): string /** - * This function returns the CUBRID database parameters. - * It returns an associative array with the values for the following parameters: - * - * - * PARAM_ISOLATION_LEVEL - * PARAM_LOCK_TIMEOUT - * PARAM_MAX_STRING_LENGTH - * PARAM_AUTO_COMMIT - * - * - * - * Database parameters - * - * - * - * Parameter - * Description - * - * - * - * - * PARAM_ISOLATION_LEVEL - * The transaction isolation level. - * - * - * LOCK_TIMEOUT - * CUBRID provides the lock timeout feature, which sets the waiting - * time (in seconds) for the lock until the transaction lock setting is - * allowed. The default value of the lock_timeout_in_secs parameter is - * -1, which means the application client will wait indefinitely until - * the transaction lock is allowed. - * - * - * - * PARAM_AUTO_COMMIT - * In CUBRID PHP, auto-commit mode is disabled by default for - * transaction management. It can be set by using - * cubrid_set_autocommit. - * - * - * - * - * - * * The following table shows the isolation levels from 1 to 6. It consists of * table schema (row) and isolation level: * @@ -1261,38 +1085,6 @@ function cubrid_next_result($result): void * * <milli_sec> := MILLI SECOND * - * - * host : A host name or IP address of the master database - * db_name : A name of the database - * db_user : A name of the database user - * db_password : A database user password - * - * alhosts : Specifies the broker information of the standby server, which is - * used for failover when it is impossible to connect to the active server. - * You can specify multiple brokers for failover, and the connection to the brokers - * is attempted in the order listed in alhosts - * - * rctime : An interval between the attempts to connect to the active broker in - * which failure occurred. After a failure occurs, the system connects to the - * broker specified by althosts (failover), terminates the transaction, and then - * attempts to connect to the active broker of the master database at every rctime. - * The default value is 600 seconds. - * - * login_timeout : Timeout value (unit: msec.) for database login. The default - * value is 0, which means infinite postponement. - * - * - * query_timeout : Timeout value (unit: msec.) for query request. Upon timeout, - * a message to cancel requesting a query transferred to server is sent. The return - * value can depend on the disconnect_on_query_timeout configuration; even though the - * message to cancel a request is sent to server, that request may succeed. - * - * - * disconnect_on_query_timeout : Configures a value whether to immediately return - * an error of function being executed upon timeout. The default value is false. - * - * - * * @param string $conn_url A character string that contains server connection information. * @param string $userid User name for the database. * @param string $passwd User password. @@ -1460,375 +1252,6 @@ function cubrid_rollback($conn_identifier): void * tables shows types of schema and the column structure of the result array to * be returned based on the schema type. * - * - * Result Composition of Each Type - * - * - * - * Schema - * Column Number - * Column Name - * Value - * - * - * - * - * CUBRID_SCH_CLASS - * 1 - * NAME - * - * - * - * - * 2 - * TYPE - * 0:system class 1:vclass 2:class - * - * - * - * CUBRID_SCH_VCLASS - * 1 - * NAME - * - * - * - * - * 2 - * TYPE - * 1:vclass - * - * - * - * CUBRID_SCH_QUERY_SPEC - * 1 - * QUERY_SPEC - * - * - * - * - * CUBRID_SCH_ATTRIBUTE / CUBRID_SCH_CLASS_ATTRIBUTE - * 1 - * ATTR_NAME - * - * - * - * - * 2 - * DOMAIN - * - * - * - * - * 3 - * SCALE - * - * - * - * - * 4 - * PRECISION - * - * - * - * - * 5 - * INDEXED - * 1:indexed - * - * - * - * 6 - * NOT NULL - * 1:not null - * - * - * - * 7 - * SHARED - * 1:shared - * - * - * - * 8 - * UNIQUE - * 1:unique - * - * - * - * 9 - * DEFAULT - * - * - * - * - * 10 - * ATTR_ORDER - * base:1 - * - * - * - * 11 - * CLASS_NAME - * - * - * - * - * 12 - * SOURCE_CLASS - * - * - * - * - * 13 - * IS_KEY - * 1:key - * - * - * - * CUBRID_SCH_METHOD / CUBRID_SCH_CLASS_METHOD - * 1 - * NAME - * - * - * - * - * 2 - * RET_DOMAIN - * - * - * - * - * 3 - * ARG_DOMAIN - * - * - * - * - * CUBRID_SCH_METHOD_FILE - * 1 - * METHOD_FILE - * - * - * - * - * CUBRID_SCH_SUPERCLASS / CUBRID_SCH_DIRECT_SUPER_CLASS / CUBRID_SCH_SUBCLASS - * 1 - * CLASS_NAME - * - * - * - * - * 2 - * TYPE - * 0:system class 1:vclass 2:class - * - * - * - * CUBRID_SCH_CONSTRAINT - * 1 - * TYPE - * 0:unique 1:index 2:reverse unique 3:reverse index - * - * - * - * 2 - * NAME - * - * - * - * - * 3 - * ATTR_NAME - * - * - * - * - * 4 - * NUM_PAGES - * - * - * - * - * 5 - * NUM_KEYS - * - * - * - * - * 6 - * PRIMARY_KEY - * 1:primary key - * - * - * - * 7 - * KEY_ORDER - * base:1 - * - * - * - * CUBRID_SCH_TRIGGER - * 1 - * NAME - * - * - * - * - * 2 - * STATUS - * - * - * - * - * 3 - * EVENT - * - * - * - * - * 4 - * TARGET_CLASS - * - * - * - * - * 5 - * TARGET_ATTR - * - * - * - * - * 6 - * ACTION_TIME - * - * - * - * - * 7 - * ACTION - * - * - * - * - * 8 - * PRIORITY - * - * - * - * - * 9 - * CONDITION_TIME - * - * - * - * - * 10 - * CONDITION - * - * - * - * - * CUBRID_SCH_CLASS_PRIVILEGE / CUBRID_SCH_ATTR_PRIVILEGE - * 1 - * CLASS_NAME / ATTR_NAME - * - * - * - * - * 2 - * PRIVILEGE - * - * - * - * - * 3 - * GRANTABLE - * - * - * - * - * CUBRID_SCH_PRIMARY_KEY - * 1 - * CLASS_NAME - * - * - * - * - * 2 - * ATTR_NAME - * - * - * - * - * 3 - * KEY_SEQ - * base:1 - * - * - * - * 4 - * KEY_NAME - * - * - * - * - * CUBRID_SCH_IMPORTED_KEYS / CUBRID_SCH_EXPORTED_KEYS / CUBRID_SCH_CROSS_REFERENCE - * 1 - * PKTABLE_NAME - * - * - * - * - * 2 - * PKCOLUMN_NAME - * - * - * - * - * 3 - * FKTABLE_NAME - * base:1 - * - * - * - * 4 - * FKCOLUMN_NAME - * - * - * - * - * 5 - * KEY_SEQ - * base:1 - * - * - * - * 6 - * UPDATE_ACTION - * 0:cascade 1:restrict 2:no action 3:set null - * - * - * - * 7 - * DELETE_ACTION - * 0:cascade 1:restrict 2:no action 3:set null - * - * - * - * 8 - * FK_NAME - * - * - * - * - * 9 - * PK_NAME - * - * - * - * - * - * * @param resource $conn_identifier Connection identifier. * @param int $schema_type Schema data that you want to know. * @param string $class_name Class you want to know the schema of. @@ -1952,11 +1375,6 @@ function cubrid_set_add($conn_identifier, string $oid, string $attr_name, string * * @param resource $conn_identifier Connection identifier. * @param bool $mode Auto-commit mode. The following constants can be used: - * - * - * CUBRID_AUTOCOMMIT_FALSE - * CUBRID_AUTOCOMMIT_TRUE - * * @throws CubridException * */ @@ -1975,11 +1393,6 @@ function cubrid_set_autocommit($conn_identifier, bool $mode): void * the CUBRID database parameters. It can set the following CUBRID database * parameters: * - * - * PARAM_ISOLATION_LEVEL - * PARAM_LOCK_TIMEOUT - * - * * @param resource $conn_identifier The CUBRID connection. If the connection identifier is not specified, * the last link opened by cubrid_connect is assumed. * @param int $param_type Database parameter type. diff --git a/generated/8.5/dir.php b/generated/8.5/dir.php index 03a68274..f1735c1a 100644 --- a/generated/8.5/dir.php +++ b/generated/8.5/dir.php @@ -103,11 +103,11 @@ function getcwd(): string * closedir, readdir, and * rewinddir calls. * - * @param string $directory The directory path that is to be opened + * @param string $directory The directory path to open. * @param null|resource $context For a description of the context parameter, * refer to the streams section of * the manual. - * @return resource Returns a directory handle resource on success + * @return resource Returns a directory handle on success * @throws DirException * */ diff --git a/generated/8.5/eio.php b/generated/8.5/eio.php index f5673390..a9d22aed 100644 --- a/generated/8.5/eio.php +++ b/generated/8.5/eio.php @@ -35,6 +35,7 @@ function eio_busy(int $delay, int $pri = EIO_PRI_DEFAULT, ?callable $callback = * new permissions are specified by mode. * * @param string $path Path to the target file or directory + * * Avoid relative * paths * @param int $mode The new permissions. E.g. 0644. @@ -86,6 +87,7 @@ function eio_chmod(string $path, int $mode, int $pri = EIO_PRI_DEFAULT, ?callabl * Changes file, or directory permissions. * * @param string $path Path to file or directory. + * * Avoid relative * paths * @param int $uid User ID. Is ignored when equal to -1. @@ -1112,77 +1114,7 @@ function eio_readahead($fd, int $offset, int $length, int $pri = EIO_PRI_DEFAULT * * is optional request resource which can be used with functions like eio_get_last_error. * @param null|string $data is custom data passed to the request. - * @return resource eio_readdir returns request resource on success. - * Sets result argument of - * callback function according to - * flags: - * - * - * - * - * - * - * EIO_READDIR_DENTS - * (int) - * - * - * - * eio_readdir flag. If specified, the result argument of the callback - * becomes an array with the following keys: - * 'names' - array of directory names - * 'dents' - array of struct - * eio_dirent-like arrays having the following keys each: - * 'name' - the directory name; - * 'type' - one of EIO_DT_* - * constants; - * 'inode' - the inode number, if available, otherwise - * unspecified; - * - * - * - * - * - * EIO_READDIR_DIRS_FIRST - * (int) - * - * - * - * When this flag is specified, the names will be returned in an order - * where likely directories come first, in optimal stat order. - * - * - * - * - * - * EIO_READDIR_STAT_ORDER - * (int) - * - * - * - * When this flag is specified, then the names will be returned in an order - * suitable for stat'ing each one. When planning to - * stat all files in the given directory, the - * returned order will likely be - * fastest. - * - * - * - * - * - * EIO_READDIR_FOUND_UNKNOWN - * (int) - * - * - * - * - * - * - * - * - * - * - * - * Node types: + * @return resource Node types: * * * diff --git a/generated/8.5/filesystem.php b/generated/8.5/filesystem.php index d6b82ae3..f70ebf0b 100644 --- a/generated/8.5/filesystem.php +++ b/generated/8.5/filesystem.php @@ -416,7 +416,7 @@ function file_put_contents(string $filename, $data, int $flags = 0, $context = n * * * - * @param null|resource $context + * @param null|resource $context Search for the file in the include_path. * @return list Returns the file in an array. Each element of the array corresponds to a * line in the file, with the newline still attached. Upon failure, * file returns FALSE. @@ -439,7 +439,7 @@ function file(string $filename, int $flags = 0, $context = null): array /** - * + * Gets the last access time of the given file. * * @param string $filename Path to the file. * @return int Returns the time the file was last accessed. @@ -817,7 +817,14 @@ function flock($stream, int $operation, ?int &$would_block = null): void * 'e' * * Set close-on-exec flag on the opened file descriptor. Only - * available in PHP compiled on POSIX.1-2008 conform systems. + * available in PHP compiled on POSIX.1-2008 conformant systems. + * + * + * + * 'n' + * + * Set non-blocking flag on the opened file descriptor. Only + * available in PHP compiled on POSIX.1-2008 conformant systems. * * * @@ -1032,7 +1039,9 @@ function ftruncate($stream, int $size): void /** - * + * fwrite writes the contents of + * data to the file stream pointed to by + * stream. * * @param resource $stream A file system pointer resource * that is typically created using fopen. @@ -1040,7 +1049,8 @@ function ftruncate($stream, int $size): void * @param 0|null|positive-int $length If length is an integer, writing will stop * after length bytes have been written or the * end of data is reached, whichever comes first. - * @return 0|positive-int + * @return 0|positive-int fwrite returns the number of bytes + * written. * @throws FilesystemException * */ diff --git a/generated/8.5/filter.php b/generated/8.5/filter.php index 09eca12c..68c2ec7d 100644 --- a/generated/8.5/filter.php +++ b/generated/8.5/filter.php @@ -8,10 +8,31 @@ * This function is useful for retrieving many values without * repetitively calling filter_input. * - * @param int $type + * @param int $type One of the INPUT_* constants. + * + * The content of the superglobal that is being filtered is the original + * "raw" content provided by the SAPI, + * prior to any user modification to the superglobal. + * To filter a modified superglobal use + * filter_var_array instead. * @param array|int $options * @param bool $add_empty - * @return array|null + * @return array|null On success, an array containing the values of the requested variables. + * + * On failure, FALSE is returned. + * Except if the failure is that the input array designated by + * type is not populated where NULL is returned + * if the FILTER_NULL_ON_FAILURE flag is used. + * + * Missing entries from the input array will be populated into the returned + * array if add_empty is TRUE. + * In which case, missing entries will be set to NULL, + * unless the FILTER_NULL_ON_FAILURE flag is used, + * in which case it will be FALSE. + * + * An entry of the returned array will be FALSE if the filter fails, + * unless the FILTER_NULL_ON_FAILURE flag is used, + * in which case it will be NULL. * @throws FilterException * */ @@ -27,10 +48,38 @@ function filter_input_array(int $type, $options = FILTER_DEFAULT, bool $add_empt /** + * Filter an associative array of values using + * FILTER_VALIDATE_* + * validation filters, + * FILTER_SANITIZE_* + * sanitization filters, or custom filters. + * + * @param array $array An associative array containing the data to filter. + * @param mixed $options Either an associative array of options, + * or the filter to apply to each entry, + * which can either be a validation filter by using one of the + * FILTER_VALIDATE_* + * constants, or a sanitization filter by using one of the + * FILTER_SANITIZE_* + * constants. * + * The option array is an associative array where the key corresponds + * to a key in the data array and the associated + * value is either the filter to apply to this entry, + * or an associative array describing how and which filter should be + * applied to this entry. * - * @param array $array - * @param mixed $options + * The associative array describing how a filter should be applied + * must contain the 'filter' key whose associated + * value is the filter to apply, which can be one of the + * FILTER_VALIDATE_*, + * FILTER_SANITIZE_*, + * FILTER_UNSAFE_RAW, or + * FILTER_CALLBACK constants. + * It can optionally contain the 'flags' key + * which specifies and flags that apply to the filter, + * and the 'options' key which specifies any options + * that apply to the filter. * @param bool $add_empty Add missing keys as NULL to the return value. * @return array|null An array containing the values of the requested variables on success. An array value will be FALSE if the filter fails, or NULL if * the variable is not set. diff --git a/generated/8.5/funchand.php b/generated/8.5/funchand.php index 1569f372..2c04487a 100644 --- a/generated/8.5/funchand.php +++ b/generated/8.5/funchand.php @@ -5,7 +5,8 @@ use Safe\Exceptions\FunchandException; /** - * + * Registers the given callback to be executed when a + * tick is called. * * @param callable(): void $callback The function to register. * @param mixed $args diff --git a/generated/8.5/functionsList.php b/generated/8.5/functionsList.php index 2bac0f65..0f3c363f 100644 --- a/generated/8.5/functionsList.php +++ b/generated/8.5/functionsList.php @@ -1082,11 +1082,11 @@ 'xdiff_string_bpatch', 'xdiff_string_patch', 'xdiff_string_patch_binary', + 'xdiff_string_rabdiff', 'xmlrpc_set_type', 'xml_parser_free', 'xml_parser_set_option', 'yaml_parse', - 'yaml_parse_file', 'yaml_parse_url', 'yaz_ccl_parse', 'yaz_close', diff --git a/generated/8.5/ibmDb2.php b/generated/8.5/ibmDb2.php index e17bb2d4..bb9016a0 100644 --- a/generated/8.5/ibmDb2.php +++ b/generated/8.5/ibmDb2.php @@ -28,10 +28,6 @@ * * * - * - * Turns AUTOCOMMIT off. - * - * Turns AUTOCOMMIT on. * @return \DB2_AUTOCOMMIT_OFF|\DB2_AUTOCOMMIT_ON|bool When db2_autocommit receives only the * connection parameter, it returns the current state * of AUTOCOMMIT for the requested connection as an integer value. A value of @@ -435,15 +431,6 @@ function db2_free_stmt($stmt): void * * * - * Prior versions of ibm_db2 do not support these new options. - * - * When the value in each option is being set, some servers might not handle - * the entire length provided and might truncate the value. - * - * To ensure that the data specified in each option is converted correctly - * when transmitted to a host system, use only the characters A through Z, - * 0 through 9, and the underscore (_) or period (.). - * * SQL_ATTR_INFO_USERID - A pointer to a null-terminated * character string used to identify the client user ID sent to the host * database server when using DB2 Connect. @@ -455,10 +442,6 @@ function db2_free_stmt($stmt): void * * * - * DB2 for z/OS and OS/390 servers support up to a length of 16 characters. - * This user-id is not to be confused with the authentication user-id, it is for - * identification purposes only and is not used for any authorization. - * * SQL_ATTR_INFO_ACCTSTR - A pointer to a null-terminated * character string used to identify the client accounting string sent to the * host database server when using DB2 Connect. @@ -468,8 +451,6 @@ function db2_free_stmt($stmt): void * * * - * DB2 for z/OS and OS/390 servers support up to a length of 200 characters. - * * SQL_ATTR_INFO_APPLNAME - A pointer to a null-terminated * character string used to identify the client application name sent to the * host database server when using DB2 Connect. @@ -479,8 +460,6 @@ function db2_free_stmt($stmt): void * * * - * DB2 for z/OS and OS/390 servers support up to a length of 32 characters. - * * SQL_ATTR_INFO_WRKSTNNAME - A pointer to a null-terminated * character string used to identify the client workstation name sent to the * host database server when using DB2 Connect. @@ -489,8 +468,6 @@ function db2_free_stmt($stmt): void * DB2 for z/OS and OS/390 servers support up to a length of 18 characters. * * - * - * DB2 for z/OS and OS/390 servers support up to a length of 18 characters. * @return string Returns the current setting of the connection attribute provided on success. * @throws IbmDb2Exception * @@ -549,13 +526,6 @@ function db2_num_rows($stmt): int * * * - * If you have a persistent DB2 client connection created with - * db2_pconnect, you may use this function to close the - * connection. To avoid substantial connection performance penalties, this - * function should only be used in rare cases when the persistent connection - * has become unresponsive or the persistent connection will not be needed for - * a long period of time. - * * @param resource $connection Specifies an active DB2 client connection. * @throws IbmDb2Exception * @@ -954,54 +924,6 @@ function db2_server_info($connection): \stdClass * * * - * Passing DB2_AUTOCOMMIT_ON turns - * autocommit on for the specified connection resource. - * - * Passing DB2_AUTOCOMMIT_OFF turns - * autocommit off for the specified connection resource. - * - * Passing DB2_FORWARD_ONLY specifies a - * forward-only cursor for a statement resource. This is the - * default cursor type, and is supported by all database - * servers. - * - * Passing DB2_SCROLLABLE specifies a - * scrollable cursor for a statement resource. Scrollable - * cursors enable result set rows to be accessed in - * non-sequential order, but are only supported by - * IBM DB2 Universal Database databases. - * - * Passing DB2_BINARY specifies that - * binary data will be returned as is. This is the default - * mode. This is the equivalent of setting - * ibm_db2.binmode=1 in php.ini. - * - * Passing DB2_CONVERT specifies that - * binary data will be converted to hexadecimal encoding, - * and will be returned as such. This is the equivalent of - * setting ibm_db2.binmode=2 in php.ini. - * - * Passing DB2_PASSTHRU specifies that - * binary data will be converted to NULL. This is the - * equivalent of setting ibm_db2.binmode=3 - * in php.ini. - * - * Passing DB2_CASE_LOWER specifies that - * column names of the result set are returned in lower case. - * - * Passing DB2_CASE_UPPER specifies that - * column names of the result set are returned in upper case. - * - * Passing DB2_CASE_NATURAL specifies that - * column names of the result set are returned in natural - * case. - * - * Passing DB2_DEFERRED_PREPARE_ON turns deferred - * prepare on for the specified statement resource. - * - * Passing DB2_DEFERRED_PREPARE_OFF turns deferred - * prepare off for the specified statement resource. - * * The following new i5/OS options are available in ibm_db2 version 1.5.1 * and later. These options apply only when running PHP and ibm_db2 natively on i5 systems. * @@ -1022,14 +944,6 @@ function db2_server_info($connection): \stdClass * * * - * DB2_I5_FETCH_ON - Cursors are read-only - * and cannot be used for positioned updates or deletes. This - * is the default unless SQL_ATTR_FOR_FETCH_ONLY - * environment has been set to SQL_FALSE. - * - * DB2_I5_FETCH_OFF - Cursors can be used - * for positioned updates and deletes. - * * The following new option is available in ibm_db2 version 1.8.0 and later. * * @@ -1049,14 +963,6 @@ function db2_server_info($connection): \stdClass * * * - * DB2_ROWCOUNT_PREFETCH_ON - Client can request - * the full row count prior to fetching, which means that - * db2_num_rows returns the number of rows selected - * even when a ROLLFORWARD_ONLY cursor is used. - * - * DB2_ROWCOUNT_PREFETCH_OFF - Client cannot request - * the full row count prior to fetching. - * * The following new options are available in ibm_db2 version 1.7.0 and later. * * @@ -1081,14 +987,6 @@ function db2_server_info($connection): \stdClass * * * - * To switch the user to a trusted user, pass the User ID (String) - * of the trusted user as the value of this key. This option can - * be set on a connection resource only. To use this option, trusted - * context must be enabled on the connection resource. - * - * The password (String) that corresponds to the user specified - * by the trusted_user key. - * * The following new options are available in ibm_db2 version 1.6.0 and later. * These options provide useful tracking information that can be accessed during * execution with db2_get_option. @@ -1168,13 +1066,6 @@ function db2_server_info($connection): \stdClass * * * - * When the value in each option is being set, some servers might not handle - * the entire length provided and might truncate the value. - * - * To ensure that the data specified in each option is converted correctly - * when transmitted to a host system, use only the characters A through Z, - * 0 through 9, and the underscore (_) or period (.). - * * SQL_ATTR_INFO_USERID - A pointer to a null-terminated * character string used to identify the client user ID sent to the host * database server when using DB2 Connect. @@ -1186,10 +1077,6 @@ function db2_server_info($connection): \stdClass * * * - * DB2 for z/OS and OS/390 servers support up to a length of 16 characters. - * This user-id is not to be confused with the authentication user-id, it is for - * identification purposes only and is not used for any authorization. - * * SQL_ATTR_INFO_ACCTSTR - A pointer to a null-terminated * character string used to identify the client accounting string sent to the * host database server when using DB2 Connect. @@ -1199,8 +1086,6 @@ function db2_server_info($connection): \stdClass * * * - * DB2 for z/OS and OS/390 servers support up to a length of 200 characters. - * * SQL_ATTR_INFO_APPLNAME - A pointer to a null-terminated * character string used to identify the client application name sent to the * host database server when using DB2 Connect. @@ -1210,8 +1095,6 @@ function db2_server_info($connection): \stdClass * * * - * DB2 for z/OS and OS/390 servers support up to a length of 32 characters. - * * SQL_ATTR_INFO_WRKSTNNAME - A pointer to a null-terminated * character string used to identify the client workstation name sent to the * host database server when using DB2 Connect. @@ -1220,8 +1103,6 @@ function db2_server_info($connection): \stdClass * DB2 for z/OS and OS/390 servers support up to a length of 18 characters. * * - * - * DB2 for z/OS and OS/390 servers support up to a length of 18 characters. * @param int $type Passing DB2_AUTOCOMMIT_ON turns * autocommit on for the specified connection resource. * diff --git a/generated/8.5/image.php b/generated/8.5/image.php index bc6a66ad..e5f93130 100644 --- a/generated/8.5/image.php +++ b/generated/8.5/image.php @@ -1076,8 +1076,10 @@ function imagecrop(\GdImage $image, array $rectangle): \GdImage * @param \GdImage $image A GdImage object, returned by one of the image creation functions, * such as imagecreatetruecolor. * @param int $mode One of the following constants: - * @param float $threshold - * @param int $color + * @param float $threshold Same as IMG_CROP_TRANSPARENT. + * Before PHP 7.4.0, the bundled libgd fell back to IMG_CROP_SIDES, + * if the image had no transparent color. + * @param int $color Crops out a transparent background. * @return \GdImage Returns a cropped image object on success. * FALSE is also returned if the whole image was cropped. * @throws ImageException @@ -2651,7 +2653,7 @@ function imagetruecolortopalette(\GdImage $image, bool $dither, int $num_colors) * Note that open_basedir does * not apply to fontfile. * @param string $string The string to be measured. - * @param array $options + * @param array $options Same as in imagettftext. * @return array imagettfbbox returns an array with 8 * elements representing four points making the bounding box of the * text on success and FALSE on error. @@ -2774,7 +2776,7 @@ function imagettfbbox(float $size, float $angle, string $font_filename, string $ * * If a character is used in the string which is not supported by the * font, a hollow rectangle will replace the character. - * @param array $options + * @param array $options An array with linespacing key holding a float value. * @return array Returns an array with 8 elements representing four points making the * bounding box of the text. The order of the points is lower left, lower * right, upper right, upper left. The points are relative to the text diff --git a/generated/8.5/info.php b/generated/8.5/info.php index 9312cdaa..11be92d8 100644 --- a/generated/8.5/info.php +++ b/generated/8.5/info.php @@ -237,7 +237,8 @@ function get_cfg_var(string $option) /** - * + * Gets the current include_path + * configuration option value. * * @return string Returns the path, as a string. * @throws InfoException @@ -278,7 +279,7 @@ function getlastmod(): int /** - * + * Gets the group ID of the current script. * * @return int Returns the group ID of the current script. * @throws InfoException @@ -332,7 +333,7 @@ function getmypid(): int /** - * + * Gets the user ID of the current script. * * @return int Returns the user ID of the current script. * @throws InfoException @@ -352,9 +353,22 @@ function getmyuid(): int /** * Parses options passed to the script. * - * @param string $short_options - * @param array $long_options - * @param int|null $rest_index + * @param string $short_options Each character in this string will be used as option characters and + * matched against options passed to the script starting with a single + * hyphen (-). + * + * For example, an option string "x" recognizes an + * option -x. + * + * Only a-z, A-Z and 0-9 are allowed. + * @param array $long_options An array of options. Each element in this array will be used as option + * strings and matched against options passed to the script starting with + * two hyphens (--). + * + * For example, an longopts element "opt" recognizes an + * option --opt. + * @param int|null $rest_index If the rest_index parameter is present, then the + * index where argument parsing stopped will be written to this variable. * @return array|array|array This function will return an array of option / argument pairs. * @throws InfoException * @@ -439,7 +453,11 @@ function ini_set(string $option, $value): string /** - * + * Returns a lowercase string that describes the type of interface + * (the Server API, SAPI) that PHP is using. For example, in CLI PHP this + * string will be "cli" whereas with Apache it may have several different + * values depending on the exact SAPI used. Possible values are listed + * below. * * @return non-empty-string Returns the interface type, as a lowercase string. * diff --git a/generated/8.5/ldap.php b/generated/8.5/ldap.php index a52f1b3a..b082864c 100644 --- a/generated/8.5/ldap.php +++ b/generated/8.5/ldap.php @@ -491,7 +491,9 @@ function ldap_get_entries(\LDAP\Connection $ldap, \LDAP\Result $result): array /** * Sets value to the value of the specified option. * - * @param \LDAP\Connection $ldap An LDAP\Connection instance, returned by ldap_connect. + * @param \LDAP\Connection|null $ldap Either an LDAP\Connection instance, returned by + * ldap_connect, to get the option for that connection, + * or NULL to get the global option. * @param int $option The parameter option can be one of: * * @@ -670,7 +672,7 @@ function ldap_get_entries(\LDAP\Connection $ldap, \LDAP\Result $result): array * @throws LdapException * */ -function ldap_get_option(\LDAP\Connection $ldap, int $option, &$value = null): void +function ldap_get_option(?\LDAP\Connection $ldap, int $option, &$value = null): void { error_clear_last(); $safeResult = \ldap_get_option($ldap, $option, $value); diff --git a/generated/8.5/mbstring.php b/generated/8.5/mbstring.php index 21375cbb..cfe06c81 100644 --- a/generated/8.5/mbstring.php +++ b/generated/8.5/mbstring.php @@ -218,14 +218,16 @@ function mb_ereg_replace_callback(string $pattern, callable $callback, string $s /** - * + * Scans string for matches to + * pattern, then replaces the matched text + * with replacement * * @param string $pattern The regular expression pattern. * * Multibyte characters may be used in pattern. * @param string $replacement The replacement text. * @param string $string The string being checked. - * @param null|string $options + * @param null|string $options The search option. See mb_regex_set_options for explanation. * @return null|string The resultant string on success. * If string is not valid for the current encoding, NULL * is returned. @@ -248,9 +250,17 @@ function mb_ereg_replace(string $pattern, string $replacement, string $string, ? /** + * Retrieve the result from the last multibyte regular expression match * - * - * @return array + * @return array An array + * including the sub-string of matched part by last + * mb_ereg_search, + * mb_ereg_search_pos, + * mb_ereg_search_regs. If there are some + * matches, the first element will have the matched sub-string, the + * second element will have the first part grouped with brackets, + * the third element will have the second part grouped with + * brackets, and so on. It returns FALSE on error. * @throws MbstringException * */ @@ -300,7 +310,12 @@ function mb_ereg_search_init(string $string, ?string $pattern = null, ?string $o * * @param null|string $pattern The search pattern. * @param null|string $options The search option. See mb_regex_set_options for explanation. - * @return array + * @return array mb_ereg_search_regs executes the multibyte + * regular expression match, and if there are some matched part, it + * returns an array including substring of matched part as first + * element, the first grouped part with brackets as second element, + * the second grouped part as third element, and so on. + * It returns FALSE on error. * @throws MbstringException * */ @@ -322,7 +337,8 @@ function mb_ereg_search_regs(?string $pattern = null, ?string $options = null): /** - * + * mb_ereg_search_setpos sets the starting + * point of a match for mb_ereg_search. * * @param int $offset The position to set. If it is negative, it counts from the end of the string. * @throws MbstringException @@ -339,12 +355,14 @@ function mb_ereg_search_setpos(int $offset): void /** - * + * Scans string for matches to + * pattern, then replaces the matched text + * with replacement. * * @param string $pattern The regular expression pattern. Multibyte characters may be used. The case will be ignored. * @param string $replacement The replacement text. * @param string $string The searched string. - * @param null|string $options + * @param null|string $options The search option. See mb_regex_set_options for explanation. * @return string The resultant string. * If string is not valid for the current encoding, NULL * is returned. @@ -367,7 +385,7 @@ function mb_eregi_replace(string $pattern, string $replacement, string $string, /** - * + * mb_get_info returns the internal setting parameters of mbstring. * * @param string $type If type is not specified or is specified as "all", * "internal_encoding", "http_input", @@ -525,7 +543,11 @@ function mb_parse_str(string $string, ?array &$result): void * @param null|string $encoding The encoding * parameter is the character encoding. If it is omitted or NULL, the internal character * encoding value will be used. - * @return bool|string + * @return bool|string If encoding is set, then + * Returns TRUE on success. + * In this case, the internal character encoding is NOT changed. + * If encoding is omitted, then + * the current character encoding name for a multibyte regex is returned. * @throws MbstringException * */ @@ -616,11 +638,16 @@ function mb_send_mail(string $to, string $subject, string $message, $additional_ /** - * + * Split a multibyte + * string using regular expression + * pattern and returns the result as an + * array. * * @param string $pattern The regular expression pattern. * @param string $string The string being split. - * @param int $limit + * @param int $limit If optional parameter limit is specified, + * it will be split in limit elements as + * maximum. * @return list The result as an array. * @throws MbstringException * diff --git a/generated/8.5/misc.php b/generated/8.5/misc.php index 1406cdf9..cd0fc146 100644 --- a/generated/8.5/misc.php +++ b/generated/8.5/misc.php @@ -67,7 +67,8 @@ function highlight_file(string $filename, bool $return = false) /** - * + * Outputs or returns html markup for a syntax highlighted version of the given PHP code + * using the colors defined in the built-in syntax highlighter for PHP. * * @param string $string The PHP code to be highlighted. This should include the opening tag. * @param bool $return Set this parameter to TRUE to make this function return the @@ -86,7 +87,8 @@ function highlight_string(string $string, bool $return = false) /** - * + * Returns the system's high resolution time, counted from an arbitrary point in time. + * The delivered timestamp is monotonic and can not be adjusted. * * @param bool $as_number Whether the high resolution time should be returned as array * or number. @@ -249,7 +251,7 @@ function hrtime(bool $as_number = false) * * * Z - * NUL-padded string + * NUL-terminated (ASCIIZ) string, will be NUL padded * * * @ @@ -382,7 +384,9 @@ function sapi_windows_generate_ctrl_event(int $event, int $pid = 0): void * BREAK * * events. - * @param bool $add + * @param bool $add The CTRL event which has been received; + * either PHP_WINDOWS_EVENT_CTRL_C + * or PHP_WINDOWS_EVENT_CTRL_BREAK. * @throws MiscException * */ @@ -427,7 +431,8 @@ function sapi_windows_vt100_support($stream, ?bool $enable = null): void /** - * + * Delays the program execution for the given number of + * seconds. * * @param int $seconds Halt time in seconds (must be greater than or equal to 0). * @return false|int Returns zero on success. diff --git a/generated/8.5/mysql.php b/generated/8.5/mysql.php index 559a8190..148cad38 100644 --- a/generated/8.5/mysql.php +++ b/generated/8.5/mysql.php @@ -5,11 +5,6 @@ use Safe\Exceptions\MysqlException; /** - * mysql_close closes the non-persistent connection to - * the MySQL server that's associated with the specified link identifier. If - * link_identifier isn't specified, the last opened - * link is used. - * * * Open non-persistent MySQL connections and result sets are automatically destroyed when a * PHP script finishes its execution. So, while explicitly closing open diff --git a/generated/8.5/network.php b/generated/8.5/network.php index fd1a9e67..3812b5d1 100644 --- a/generated/8.5/network.php +++ b/generated/8.5/network.php @@ -412,7 +412,9 @@ function header_register_callback(callable $callback): void /** - * + * This function converts a 32bit IPv4, or 128bit IPv6 address (if PHP + * was built with IPv6 support enabled) into an address family appropriate + * string representation. * * @param string $ip A 32bit IPv4, or 128bit IPv6 address. * @return string Returns a string representation of the address. diff --git a/generated/8.5/openssl.php b/generated/8.5/openssl.php index 28b03a5a..b962ad92 100644 --- a/generated/8.5/openssl.php +++ b/generated/8.5/openssl.php @@ -81,11 +81,11 @@ function openssl_cms_decrypt(string $input_filename, string $output_filename, $c * @param int $flags Flags to be passed to CMS_sign. * @param int $encoding An encoding to output. One of OPENSSL_ENCODING_SMIME, * OPENSSL_ENCODING_DER or OPENSSL_ENCODING_PEM. - * @param int $cipher_algo A cypher to use. + * @param int|string $cipher_algo A cipher to use. * @throws OpensslException * */ -function openssl_cms_encrypt(string $input_filename, string $output_filename, $certificate, ?array $headers, int $flags = 0, int $encoding = OPENSSL_ENCODING_SMIME, int $cipher_algo = OPENSSL_CIPHER_AES_128_CBC): void +function openssl_cms_encrypt(string $input_filename, string $output_filename, $certificate, ?array $headers, int $flags = 0, int $encoding = OPENSSL_ENCODING_SMIME, $cipher_algo = OPENSSL_CIPHER_AES_128_CBC): void { error_clear_last(); $safeResult = \openssl_cms_encrypt($input_filename, $output_filename, $certificate, $headers, $flags, $encoding, $cipher_algo); @@ -1471,13 +1471,18 @@ function openssl_pkey_new(?array $options = null): \OpenSSLAsymmetricKey * OPENSSL_SSLV23_PADDING, * OPENSSL_PKCS1_OAEP_PADDING, * OPENSSL_NO_PADDING. + * @param null|string $digest_algo The digest algorithm for OAEP padding, or NULL to use the default algorithm. * @throws OpensslException * */ -function openssl_private_decrypt(string $data, ?string &$decrypted_data, $private_key, int $padding = OPENSSL_PKCS1_PADDING): void +function openssl_private_decrypt(string $data, ?string &$decrypted_data, $private_key, int $padding = OPENSSL_PKCS1_PADDING, ?string $digest_algo = null): void { error_clear_last(); - $safeResult = \openssl_private_decrypt($data, $decrypted_data, $private_key, $padding); + if ($digest_algo !== null) { + $safeResult = \openssl_private_decrypt($data, $decrypted_data, $private_key, $padding, $digest_algo); + } else { + $safeResult = \openssl_private_decrypt($data, $decrypted_data, $private_key, $padding); + } if ($safeResult === false) { throw OpensslException::createFromPhpError(); } @@ -1561,13 +1566,18 @@ function openssl_public_decrypt(string $data, ?string &$decrypted_data, $public_ * OPENSSL_SSLV23_PADDING, * OPENSSL_PKCS1_OAEP_PADDING, * OPENSSL_NO_PADDING. + * @param null|string $digest_algo The digest algorithm for OAEP padding, or NULL to use the default algorithm. * @throws OpensslException * */ -function openssl_public_encrypt(string $data, ?string &$encrypted_data, $public_key, int $padding = OPENSSL_PKCS1_PADDING): void +function openssl_public_encrypt(string $data, ?string &$encrypted_data, $public_key, int $padding = OPENSSL_PKCS1_PADDING, ?string $digest_algo = null): void { error_clear_last(); - $safeResult = \openssl_public_encrypt($data, $encrypted_data, $public_key, $padding); + if ($digest_algo !== null) { + $safeResult = \openssl_public_encrypt($data, $encrypted_data, $public_key, $padding, $digest_algo); + } else { + $safeResult = \openssl_public_encrypt($data, $encrypted_data, $public_key, $padding); + } if ($safeResult === false) { throw OpensslException::createFromPhpError(); } @@ -1657,13 +1667,14 @@ function openssl_seal(string $data, ?string &$sealed_data, ?array &$encrypted_ke * @param int|string $algorithm int - one of these Signature Algorithms. * * string - a valid string returned by openssl_get_md_methods example, "sha256WithRSAEncryption" or "sha384". + * @param int $padding RSA PSS padding to use. * @throws OpensslException * */ -function openssl_sign(string $data, ?string &$signature, $private_key, $algorithm = OPENSSL_ALGO_SHA1): void +function openssl_sign(string $data, ?string &$signature, $private_key, $algorithm = OPENSSL_ALGO_SHA1, int $padding = 0): void { error_clear_last(); - $safeResult = \openssl_sign($data, $signature, $private_key, $algorithm); + $safeResult = \openssl_sign($data, $signature, $private_key, $algorithm, $padding); if ($safeResult === false) { throw OpensslException::createFromPhpError(); } @@ -1766,15 +1777,16 @@ function openssl_spki_verify(string $spki): void * @param int|string $algorithm int - one of these Signature Algorithms. * * string - a valid string returned by openssl_get_md_methods example, "sha1WithRSAEncryption" or "sha512". + * @param int $padding RSA PSS padding to use. * @return -1|0|1 Returns 1 if the signature is correct, 0 if it is incorrect, and * -1. * @throws OpensslException * */ -function openssl_verify(string $data, string $signature, $public_key, $algorithm = OPENSSL_ALGO_SHA1): int +function openssl_verify(string $data, string $signature, $public_key, $algorithm = OPENSSL_ALGO_SHA1, int $padding = 0): int { error_clear_last(); - $safeResult = \openssl_verify($data, $signature, $public_key, $algorithm); + $safeResult = \openssl_verify($data, $signature, $public_key, $algorithm, $padding); if ($safeResult === false) { throw OpensslException::createFromPhpError(); } diff --git a/generated/8.5/outcontrol.php b/generated/8.5/outcontrol.php index 68dd25df..2fd5378a 100644 --- a/generated/8.5/outcontrol.php +++ b/generated/8.5/outcontrol.php @@ -242,8 +242,14 @@ function ob_get_flush(): string * See * and * for more details on callbacks (output handlers). - * @param int $chunk_size - * @param int $flags + * @param int $chunk_size Contents of the output buffer. + * @param int $flags Bitmask of + * + * PHP_OUTPUT_HANDLER_* + * constants + * . + * See + * for more details. * @throws OutcontrolException * */ diff --git a/generated/8.5/pcntl.php b/generated/8.5/pcntl.php index 686c6e6d..45c73710 100644 --- a/generated/8.5/pcntl.php +++ b/generated/8.5/pcntl.php @@ -5,18 +5,18 @@ use Safe\Exceptions\PcntlException; /** + * Retrieve the cpu affinity of the process_id. * - * - * @param int|null $pid - * @return array|bool + * @param int|null $process_id If NULL, the current process ID is used. + * @return array Returns the cpu affinity mask of the process. * @throws PcntlException * */ -function pcntl_getcpuaffinity(?int $pid = null) +function pcntl_getcpuaffinity(?int $process_id = null): array { error_clear_last(); - if ($pid !== null) { - $safeResult = \pcntl_getcpuaffinity($pid); + if ($process_id !== null) { + $safeResult = \pcntl_getcpuaffinity($process_id); } else { $safeResult = \pcntl_getcpuaffinity(); } @@ -60,20 +60,21 @@ function pcntl_getpriority(?int $process_id = null, int $mode = PRIO_PROCESS): i /** + * Sets the cpu affinity for the process_id with the cpu affinity mask given by + * cpu_ids. * - * - * @param int|null $pid - * @param array $hmask + * @param int|null $process_id If NULL, the current process ID is used. + * @param array $cpu_ids The cpu affinity mask comprised of one or more cpu id for binding the process to. * @throws PcntlException * */ -function pcntl_setcpuaffinity(?int $pid = null, ?array $hmask = null): void +function pcntl_setcpuaffinity(?int $process_id = null, array $cpu_ids = []): void { error_clear_last(); - if ($hmask !== null) { - $safeResult = \pcntl_setcpuaffinity($pid, $hmask); - } elseif ($pid !== null) { - $safeResult = \pcntl_setcpuaffinity($pid); + if ($cpu_ids !== []) { + $safeResult = \pcntl_setcpuaffinity($process_id, $cpu_ids); + } elseif ($process_id !== null) { + $safeResult = \pcntl_setcpuaffinity($process_id); } else { $safeResult = \pcntl_setcpuaffinity(); } @@ -175,7 +176,7 @@ function pcntl_signal_dispatch(): void * Note that when you set a handler to an object method, that object's * reference count is increased which makes it persist until you either * change the handler to something else, or your script ends. - * @param bool $restart_syscalls + * @param bool $restart_syscalls The signal being handled. * @throws PcntlException * */ diff --git a/generated/8.5/pcre.php b/generated/8.5/pcre.php index c482ddcf..c0e6e5bd 100644 --- a/generated/8.5/pcre.php +++ b/generated/8.5/pcre.php @@ -320,9 +320,6 @@ function preg_grep(string $pattern, array $array, int $flags = 0): array * * If this flag is passed, unmatched subpatterns are reported as NULL; * otherwise they are reported as an empty string. - * - * If no order flag is given, PREG_PATTERN_ORDER is - * assumed. * @param int $offset Orders results so that $matches[0] is an array of full * pattern matches, $matches[1] is an array of strings matched by * the first parenthesized subpattern, and so on. diff --git a/generated/8.5/pgsql.php b/generated/8.5/pgsql.php index 65de2959..5aab2cd2 100644 --- a/generated/8.5/pgsql.php +++ b/generated/8.5/pgsql.php @@ -138,7 +138,7 @@ function pg_convert(\PgSql\Connection $connection, string $table_name, array $va * * @param \PgSql\Connection $connection An PgSql\Connection instance. * @param string $table_name Name of the table into which to copy the rows. - * @param array $rows An array of data to be copied into table_name. + * @param array $rows An iterable data to be copied into table_name. * Each value in rows becomes a row in table_name. * Each value in rows should be a delimited string of the values * to insert into each field. Values should be linefeed terminated. @@ -1297,10 +1297,14 @@ function pg_select(\PgSql\Connection $connection, string $table_name, array $con /** - * + * Set the query results to be retrieved in chunk mode. + * The query results returned afterward will be divided into multiple chunks, + * each containing up to size rows. + * This function must be called before retrieving results with pg_get_result. + * This function is only available when libpq is version 17 or higher. * * @param \PgSql\Connection $connection An PgSql\Connection instance. - * @param int $size + * @param int $size The number of rows to be retrieved in each chunk. * @throws PgsqlException * */ diff --git a/generated/8.5/posix.php b/generated/8.5/posix.php index da588465..e7d7b2cb 100644 --- a/generated/8.5/posix.php +++ b/generated/8.5/posix.php @@ -324,8 +324,10 @@ function posix_getpwuid(int $user_id): array * An unprivileged process may only set its soft limit to a value * from 0 to the hard limit, and irreversibly lower its hard limit. * - * @param int|null $resource If NULL all resource limits will be fetched. - * Otherwise, the only limits of the resource type provided will be returned. + * @param int|null $resource If NULL, all current resource limits will be returned. + * Otherwise, specify the + * resource limit constant + * to retrieve a specific limit. * @return array Returns an associative array of elements for each * limit that is defined. Each limit has a soft and a hard limit. * diff --git a/generated/8.5/ps.php b/generated/8.5/ps.php index 1eaa9774..d2451005 100644 --- a/generated/8.5/ps.php +++ b/generated/8.5/ps.php @@ -826,8 +826,6 @@ function ps_hyphenate($psdoc, string $text): array /** - * This function is - * currently not documented; only its argument list is available. * * * @param resource $psdoc Resource identifier of the postscript file @@ -1377,8 +1375,6 @@ function ps_setdash($psdoc, float $on, float $off): void /** - * This function is - * currently not documented; only its argument list is available. * * * @param resource $psdoc Resource identifier of the postscript file @@ -1526,8 +1522,6 @@ function ps_setmiterlimit($psdoc, float $value): void /** - * This function is - * currently not documented; only its argument list is available. * * * @param resource $psdoc Resource identifier of the postscript file @@ -1683,8 +1677,6 @@ function ps_show_xy($psdoc, string $text, float $x, float $y): void /** - * This function is - * currently not documented; only its argument list is available. * * * @param resource $psdoc diff --git a/generated/8.5/pspell.php b/generated/8.5/pspell.php index bf852387..b06330ba 100644 --- a/generated/8.5/pspell.php +++ b/generated/8.5/pspell.php @@ -5,7 +5,11 @@ use Safe\Exceptions\PspellException; /** - * + * pspell_add_to_personal adds a word to the personal + * wordlist. If you used pspell_new_config with + * pspell_config_personal to open the dictionary, + * you can save the wordlist later with + * pspell_save_wordlist. * * @param int $dictionary An PSpell\Dictionary instance. * @param string $word The added word. @@ -23,7 +27,9 @@ function pspell_add_to_personal(int $dictionary, string $word): void /** - * + * pspell_add_to_session adds a word to the wordlist + * associated with the current session. It is very similar to + * pspell_add_to_personal * * @param int $dictionary An PSpell\Dictionary instance. * @param string $word The added word. @@ -41,7 +47,9 @@ function pspell_add_to_session(int $dictionary, string $word): void /** - * + * pspell_clear_session clears the current session. + * The current wordlist becomes blank, and, for example, if you try to save + * it with pspell_save_wordlist, nothing happens. * * @param int $dictionary An PSpell\Dictionary instance. * @throws PspellException @@ -138,7 +146,9 @@ function pspell_config_dict_dir(int $config, string $directory): void /** - * + * pspell_config_ignore should be used on a config + * before calling pspell_new_config. This function + * allows short words to be skipped by the spell checker. * * @param int $config An PSpell\Config instance. * @param int $min_length Words less than min_length characters will be skipped. @@ -156,7 +166,10 @@ function pspell_config_ignore(int $config, int $min_length): void /** - * + * pspell_config_mode should be used on a config + * before calling pspell_new_config. This function + * determines how many suggestions will be returned by + * pspell_suggest. * * @param int $config An PSpell\Config instance. * @param int $mode The mode parameter is the mode in which spellchecker will work. @@ -299,7 +312,13 @@ function pspell_config_save_repl(int $config, bool $save): void /** - * + * pspell_new_config opens up a new dictionary with + * settings specified in a config, created with + * pspell_config_create and modified with + * pspell_config_* functions. This method provides you + * with the most flexibility and has all the functionality provided by + * pspell_new and + * pspell_new_personal. * * @param int $config The config parameter is the one returned by * pspell_config_create when the config was created. @@ -462,7 +481,10 @@ function pspell_new(string $language, string $spelling = "", string $jargon = "" /** - * + * pspell_save_wordlist saves the personal wordlist from + * the current session. The location of files to be saved specified with + * pspell_config_personal and (optionally) + * pspell_config_repl. * * @param int $dictionary An PSpell\Dictionary instance. * @throws PspellException @@ -479,7 +501,16 @@ function pspell_save_wordlist(int $dictionary): void /** - * + * pspell_store_replacement stores a replacement pair for + * a word, so that replacement can be returned by + * pspell_suggest later. In order to be able to take + * advantage of this function, you have to use + * pspell_new_personal to open the dictionary. In order + * to permanently save the replacement pair, you have to + * use pspell_config_personal and + * pspell_config_repl to set the path where to save your + * custom wordlists, and then use pspell_save_wordlist + * for the changes to be written to disk. * * @param int $dictionary An PSpell\Dictionary instance. * @param string $misspelled The misspelled word. diff --git a/generated/8.5/rector-migrate.php b/generated/8.5/rector-migrate.php index c74b8a12..6de64fa9 100644 --- a/generated/8.5/rector-migrate.php +++ b/generated/8.5/rector-migrate.php @@ -1090,11 +1090,11 @@ 'xdiff_string_bpatch' => 'Safe\xdiff_string_bpatch', 'xdiff_string_patch' => 'Safe\xdiff_string_patch', 'xdiff_string_patch_binary' => 'Safe\xdiff_string_patch_binary', + 'xdiff_string_rabdiff' => 'Safe\xdiff_string_rabdiff', 'xmlrpc_set_type' => 'Safe\xmlrpc_set_type', 'xml_parser_free' => 'Safe\xml_parser_free', 'xml_parser_set_option' => 'Safe\xml_parser_set_option', 'yaml_parse' => 'Safe\yaml_parse', - 'yaml_parse_file' => 'Safe\yaml_parse_file', 'yaml_parse_url' => 'Safe\yaml_parse_url', 'yaz_ccl_parse' => 'Safe\yaz_ccl_parse', 'yaz_close' => 'Safe\yaz_close', diff --git a/generated/8.5/rpminfo.php b/generated/8.5/rpminfo.php index ca7472b5..fb4cfaee 100644 --- a/generated/8.5/rpminfo.php +++ b/generated/8.5/rpminfo.php @@ -5,9 +5,9 @@ use Safe\Exceptions\RpminfoException; /** + * Add an additional retrieved tag in subsequent queries. * - * - * @param int $tag + * @param int $tag One of RPMTAG_* constant. * @throws RpminfoException * */ @@ -22,9 +22,12 @@ function rpmaddtag(int $tag): void /** + * Define or change a RPM macro value. * + * This can be used to select the database path and backend to use + * instead of system default one. * - * @param string $text + * @param string $text Macro name, options, body. * @throws RpminfoException * */ diff --git a/generated/8.5/sem.php b/generated/8.5/sem.php index 5ca166d3..56e25083 100644 --- a/generated/8.5/sem.php +++ b/generated/8.5/sem.php @@ -298,8 +298,6 @@ function msg_set_queue(\SysvMessageQueue $queue, array $data): void * * * - * - * Returns FALSE on failure. * @throws SemException * */ diff --git a/generated/8.5/session.php b/generated/8.5/session.php index e7fde767..0f10380a 100644 --- a/generated/8.5/session.php +++ b/generated/8.5/session.php @@ -214,28 +214,18 @@ function session_encode(): string /** - * session_gc is used to perform session data - * GC (garbage collection). PHP does probability based session GC by - * default. - * - * Probability based GC works somewhat but it has few problems. 1) Low - * traffic sites' session data may not be deleted within the preferred - * duration. 2) High traffic sites' GC may be too frequent GC. 3) GC is - * performed on the user's request and the user will experience a GC - * delay. - * - * Therefore, it is recommended to execute GC periodically for - * production systems using, e.g., "cron" for UNIX-like systems. - * Make sure to disable probability based GC by setting - * session.gc_probability - * to 0. - * - * @return int session_gc returns number of deleted session - * data for success. - * - * Old save handlers do not return number of deleted session data, but - * only success/failure flag. If this is the case, number of deleted - * session data became 1 regardless of actually deleted data. + * By default, PHP uses session.gc_probability + * to run the session garbage collector probabilistically on each + * request. There are some limitations with this approach: + * + * For production systems, it is recommended to disable the + * probability-based garbage collection by setting + * session.gc_probability to 0 + * and explicitly trigger the garbage collector periodically, for example by using "cron" on + * UNIX-like systems to run a script that calls session_gc. + * + * @return int session_gc returns the number of deleted session + * entries on success. * @throws SessionException * */ diff --git a/generated/8.5/sodium.php b/generated/8.5/sodium.php index a8f74119..fac756e2 100644 --- a/generated/8.5/sodium.php +++ b/generated/8.5/sodium.php @@ -5,13 +5,14 @@ use Safe\Exceptions\SodiumException; /** + * Verify then decrypt a message with AEGIS-128L. * - * - * @param string $ciphertext - * @param string $additional_data - * @param string $nonce - * @param string $key - * @return string + * @param string $ciphertext Must be in the format provided by sodium_crypto_aead_aegis128l_encrypt. + * @param string $additional_data Additional, authenticated data. This is used in the verification of the authentication tag + * appended to the ciphertext, but it is not encrypted or stored in the ciphertext. + * @param string $nonce A number that must be only used once, per message. + * @param string $key Encryption key (128-bit). + * @return string Returns the plaintext on success. * @throws SodiumException * */ @@ -27,13 +28,14 @@ function sodium_crypto_aead_aegis128l_decrypt(string $ciphertext, string $additi /** + * Verify then decrypt a message with AEGIS-256. * - * - * @param string $ciphertext - * @param string $additional_data - * @param string $nonce - * @param string $key - * @return string + * @param string $ciphertext Must be in the format provided by sodium_crypto_aead_aegis256_encrypt. + * @param string $additional_data Additional, authenticated data. This is used in the verification of the authentication tag + * appended to the ciphertext, but it is not encrypted or stored in the ciphertext. + * @param string $nonce A number that must be only used once, per message. + * @param string $key Encryption key (256-bit). + * @return string Returns the plaintext on success. * @throws SodiumException * */ @@ -176,7 +178,7 @@ function sodium_crypto_aead_chacha20poly1305_ietf_encrypt(string $message, strin * * Generally, XChaCha20-Poly1305 is the best of the provided AEAD modes to use. * - * @param string $ciphertext Must be in the format provided by sodium_crypto_aead_chacha20poly1305_ietf_encrypt + * @param string $ciphertext Must be in the format provided by sodium_crypto_aead_xchacha20poly1305_ietf_encrypt * (ciphertext and tag, concatenated). * @param string $additional_data Additional, authenticated data. This is used in the verification of the authentication tag * appended to the ciphertext, but it is not encrypted or stored in the ciphertext. diff --git a/generated/8.5/ssh2.php b/generated/8.5/ssh2.php index 04882b11..36deac08 100644 --- a/generated/8.5/ssh2.php +++ b/generated/8.5/ssh2.php @@ -117,133 +117,10 @@ function ssh2_auth_pubkey_file($session, string $username, string $pubkeyfile, s * @param array $methods methods may be an associative array with up to four parameters * as described below. * - * - * methods may be an associative array - * with any or all of the following parameters. - * - * - * - * Index - * Meaning - * Supported Values* - * - * - * - * - * kex - * - * List of key exchange methods to advertise, comma separated - * in order of preference. - * - * - * diffie-hellman-group1-sha1, - * diffie-hellman-group14-sha1, and - * diffie-hellman-group-exchange-sha1 - * - * - * - * hostkey - * - * List of hostkey methods to advertise, comma separated - * in order of preference. - * - * - * ssh-rsa and - * ssh-dss - * - * - * - * client_to_server - * - * Associative array containing crypt, compression, and - * message authentication code (MAC) method preferences - * for messages sent from client to server. - * - * - * - * - * server_to_client - * - * Associative array containing crypt, compression, and - * message authentication code (MAC) method preferences - * for messages sent from server to client. - * - * - * - * - * - * - * * * - Supported Values are dependent on methods supported by underlying library. * See libssh2 documentation for additional * information. * - * - * - * client_to_server and - * server_to_client may be an associative array - * with any or all of the following parameters. - * - * - * - * - * Index - * Meaning - * Supported Values* - * - * - * - * - * crypt - * List of crypto methods to advertise, comma separated - * in order of preference. - * - * rijndael-cbc@lysator.liu.se, - * aes256-cbc, - * aes192-cbc, - * aes128-cbc, - * 3des-cbc, - * blowfish-cbc, - * cast128-cbc, - * arcfour, and - * none** - * - * - * - * comp - * List of compression methods to advertise, comma separated - * in order of preference. - * - * zlib and - * none - * - * - * - * mac - * List of MAC methods to advertise, comma separated - * in order of preference. - * - * hmac-sha1, - * hmac-sha1-96, - * hmac-ripemd160, - * hmac-ripemd160@openssh.com, and - * none** - * - * - * - * - * - * - * - * Crypt and MAC method "none" - * - * For security reasons, none is disabled by the underlying - * libssh2 library unless explicitly enabled - * during build time by using the appropriate ./configure options. See documentation - * for the underlying library for more information. - * - * - * * For security reasons, none is disabled by the underlying * libssh2 library unless explicitly enabled * during build time by using the appropriate ./configure options. See documentation diff --git a/generated/8.5/strings.php b/generated/8.5/strings.php index 79c88c4c..4b673a75 100644 --- a/generated/8.5/strings.php +++ b/generated/8.5/strings.php @@ -68,7 +68,10 @@ function md5_file(string $filename, bool $binary = false): string /** - * + * Calculates the sha1 hash of the file specified by + * filename using the + * US Secure Hash Algorithm 1, + * and returns that hash. The hash is a 40-character hexadecimal number. * * @param string $filename The filename of the file to hash. * @param bool $binary When TRUE, returns the digest in raw binary format with a length of diff --git a/generated/8.5/uodbc.php b/generated/8.5/uodbc.php index 2c1ffe5b..a514e1d2 100644 --- a/generated/8.5/uodbc.php +++ b/generated/8.5/uodbc.php @@ -270,7 +270,17 @@ function odbc_commit(\Odbc\Connection $odbc): void /** - * + * The connection id returned by this functions is needed by other + * ODBC functions. You can have multiple connections open at once as long as + * they either use different db or different credentials. + * + * With some ODBC drivers, executing a complex stored procedure may + * fail with an error similar to: "Cannot open a cursor on a stored + * procedure that has anything other than a single select statement + * in it". Using SQL_CUR_USE_ODBC may avoid that error. Also, some + * drivers don't support the optional row_number parameter in + * odbc_fetch_row. SQL_CUR_USE_ODBC might help + * in that case, too. * * @param string $dsn The database source name for the connection. Alternatively, a * DSN-less connection string can be used. @@ -1001,7 +1011,14 @@ function odbc_setoption($odbc, int $which, int $option, int $value): void * * @param \Odbc\Connection $odbc The ODBC connection object, * see odbc_connect for details. - * @param int $type + * @param int $type When the type argument is SQL_BEST_ROWID, + * odbc_specialcolumns returns the + * column or columns that uniquely identify each row in the table. + * + * When the type argument is SQL_ROWVER, + * odbc_specialcolumns returns the column or columns in the + * specified table, if any, that are automatically updated by the data source + * when any value in the row is updated by any transaction. * @param string $catalog The catalog ('qualifier' in ODBC 2 parlance). * @param string $schema The schema ('owner' in ODBC 2 parlance). * @param string $table The table. diff --git a/generated/8.5/xdiff.php b/generated/8.5/xdiff.php index dab92fce..ce604f81 100644 --- a/generated/8.5/xdiff.php +++ b/generated/8.5/xdiff.php @@ -234,3 +234,33 @@ function xdiff_string_patch(string $str, string $patch, ?int $flags = null, ?str } return $safeResult; } + + +/** + * Makes a binary diff of two strings using the Rabin's polynomial fingerprinting algorithm implemented by + * libxdiff. Compared to + * xdiff_string_bdiff, this algorithm generally produces smaller diffs and operates faster, + * while remaining fully compatible with xdiff_string_bpatch and + * xdiff_file_bpatch for applying patches. + * + * This function can be used with both text and binary data. The resulting diff data can later be + * applied to recreate the new version from the old one. + * + * For further information about the algorithm, see the + * libxdiff documentation. + * + * @param string $old_data The first string containing the "old" binary data. + * @param string $new_data The second string containing the "new" binary data. + * @return string Returns a binary diff string containing the differences between the old and new data. + * @throws XdiffException + * + */ +function xdiff_string_rabdiff(string $old_data, string $new_data): string +{ + error_clear_last(); + $safeResult = \xdiff_string_rabdiff($old_data, $new_data); + if ($safeResult === false) { + throw XdiffException::createFromPhpError(); + } + return $safeResult; +} diff --git a/generated/8.5/xml.php b/generated/8.5/xml.php index a4ee48df..7eb056fc 100644 --- a/generated/8.5/xml.php +++ b/generated/8.5/xml.php @@ -7,7 +7,7 @@ /** * Frees the given XML parser. * - * @param \XMLParser $parser + * @param \XMLParser $parser A reference to the XML parser to free. * @throws XmlException * */ @@ -311,7 +311,7 @@ function xml_set_default_handler(\XMLParser $parser, callable $handler): bool * * * - * @param callable $end_handler + * @param callable $end_handler The XML parser calling the handler. * @return bool Always returns TRUE. * */ diff --git a/generated/8.5/yaml.php b/generated/8.5/yaml.php index 52466e27..6790e839 100644 --- a/generated/8.5/yaml.php +++ b/generated/8.5/yaml.php @@ -16,11 +16,13 @@ * tag => callable mappings. See * parse callbacks for more * details. - * @return mixed Returns the value encoded in filename in appropriate - * PHP type. If pos is -1 an - * array will be returned with one entry for each document found - * in the stream. - * @throws YamlException + * @return mixed Returns the value encoded in filename in the appropriate + * PHP type. + * + * On failure, a string containing an error message is returned. + * + * If pos is -1, an array + * will be returned with one entry for each document found in the stream. * */ function yaml_parse_file(string $filename, int $pos = 0, ?int &$ndocs = null, ?array $callbacks = null) @@ -31,9 +33,6 @@ function yaml_parse_file(string $filename, int $pos = 0, ?int &$ndocs = null, ?a } else { $safeResult = \yaml_parse_file($filename, $pos, $ndocs); } - if ($safeResult === false) { - throw YamlException::createFromPhpError(); - } return $safeResult; } diff --git a/generated/8.5/zlib.php b/generated/8.5/zlib.php index aa4eab85..cc55379c 100644 --- a/generated/8.5/zlib.php +++ b/generated/8.5/zlib.php @@ -269,13 +269,12 @@ function gzencode(string $data, int $level = -1, int $encoding = ZLIB_ENCODING_G * it returns the file in an array. * * @param string $filename The file name. - * @param int $use_include_path You can set this optional parameter to 1, if you - * want to search for the file in the include_path too. + * @param int $use_include_path If set to TRUE, files in the include_path are searched for too. * @return list An array containing the file, one line per cell, empty lines included, and with newlines still attached. * @throws ZlibException * */ -function gzfile(string $filename, int $use_include_path = 0): array +function gzfile(string $filename, int $use_include_path = false): array { error_clear_last(); $safeResult = \gzfile($filename, $use_include_path); @@ -353,8 +352,7 @@ function gzinflate(string $data, int $max_length = 0): string * (See the description of deflateInit2 * in zlib.h for * more information about the strategy parameter.) - * @param int $use_include_path You can set this optional parameter to 1, if you - * want to search for the file in the include_path too. + * @param int $use_include_path If set to TRUE, files in the include_path are searched for too. * @return resource Returns a file pointer to the file opened, after that, everything you read * from this file descriptor will be transparently decompressed and what you * write gets compressed. @@ -363,7 +361,7 @@ function gzinflate(string $data, int $max_length = 0): string * @throws ZlibException * */ -function gzopen(string $filename, string $mode, int $use_include_path = 0) +function gzopen(string $filename, string $mode, int $use_include_path = false) { error_clear_last(); $safeResult = \gzopen($filename, $mode, $use_include_path); @@ -668,13 +666,14 @@ function inflate_init(int $encoding, array $options = []): \InflateContext * * @param string $filename The file name. This file will be opened from the filesystem and its * contents written to standard output. - * @param int $use_include_path You can set this optional parameter to 1, if you - * want to search for the file in the include_path too. + * @param int $use_include_path When set to TRUE the + * include_path + * will be used to determine which file to open. * @return 0|positive-int Returns the number of (uncompressed) bytes read from the file on success * @throws ZlibException * */ -function readgzfile(string $filename, int $use_include_path = 0): int +function readgzfile(string $filename, int $use_include_path = false): int { error_clear_last(); $safeResult = \readgzfile($filename, $use_include_path);