From 224a2a3ccbfc6ed075ce7e7afebcb31c9312f057 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Deruss=C3=A9?= Date: Wed, 27 Feb 2019 23:25:37 +0100 Subject: [PATCH 1/3] Update documentation --- generated/com.php | 8 ++--- generated/funchand.php | 3 +- generated/functionsList.php | 3 ++ generated/image.php | 12 +++---- generated/mbstring.php | 2 +- generated/misc.php | 5 ++- generated/sodium.php | 35 +++++++++++++++---- generated/sqlsrv.php | 18 +++++----- generated/strings.php | 4 +-- generated/xml.php | 70 +++++++++++++++++++++++++++++++++++++ rector-migrate.yml | 3 ++ 11 files changed, 129 insertions(+), 34 deletions(-) diff --git a/generated/com.php b/generated/com.php index c4212aee..210ec2ab 100644 --- a/generated/com.php +++ b/generated/com.php @@ -86,16 +86,16 @@ function com_event_sink(variant $comobject, object $sinkobject, $sinkinterface = * * The type library name, e.g. Microsoft OLE DB ActiveX Data * Objects 1.0 Library. - * @param int $case_insensitive The case_insensitive behaves in the same way as - * the parameter with the same name in the define + * @param bool $case_sensitive The case_sensitive behaves inversely to + * the parameter $case_insensitive in the define * function. * @throws ComException * */ -function com_load_typelib(string $typelib_name, bool $case_insensitive = true): void +function com_load_typelib(string $typelib_name, bool $case_sensitive = true): void { error_clear_last(); - $result = \com_load_typelib($typelib_name, $case_insensitive); + $result = \com_load_typelib($typelib_name, $case_sensitive); if ($result === false) { throw ComException::createFromPhpError(); } diff --git a/generated/funchand.php b/generated/funchand.php index b7b657e5..4a4cb43c 100644 --- a/generated/funchand.php +++ b/generated/funchand.php @@ -89,8 +89,7 @@ function forward_static_call(callable $function, ...$params) /** * * - * @param callable $function The function name as a string, or an array consisting of an object and - * a method. + * @param callable $function The function to register. * @param mixed $params * @throws FunchandException * diff --git a/generated/functionsList.php b/generated/functionsList.php index bd23485b..26ca7d76 100644 --- a/generated/functionsList.php +++ b/generated/functionsList.php @@ -914,6 +914,7 @@ 'socket_set_option', 'socket_shutdown', 'socket_write', + 'sodium_crypto_pwhash_str', 'sodium_crypto_pwhash', 'solr_get_version', 'class_implements', @@ -1036,6 +1037,8 @@ 'xdiff_string_bpatch', 'xdiff_string_patch_binary', 'xdiff_string_patch', + 'xml_parser_create_ns', + 'xml_parser_create', 'xml_set_object', 'xmlrpc_set_type', 'yaml_parse_file', diff --git a/generated/image.php b/generated/image.php index 941bdac5..1b2473fb 100644 --- a/generated/image.php +++ b/generated/image.php @@ -1639,20 +1639,16 @@ function imagerotate($image, float $angle, int $bgd_color, int $ignore_transpare /** - * imagesavealpha sets the flag to attempt to save + * imagesavealpha sets the flag which determines whether to retain * full alpha channel information (as opposed to single-color transparency) * when saving PNG images. * - * You have to unset alphablending - * (imagealphablending($im, false)), to use it. - * - * Alpha channel is not supported by all browsers, if you have problem with - * your browser, try to load your script with an alpha channel compliant - * browser, e.g. latest Mozilla. + * Alphablending has to be disabled (imagealphablending($im, false)) + * to retain the alpha-channel in the first place. * * @param resource $image An image resource, returned by one of the image creation functions, * such as imagecreatetruecolor. - * @param bool $saveflag Whether to save the alpha channel or not. Default to FALSE. + * @param bool $saveflag Whether to save the alpha channel or not. Defaults to FALSE. * @throws ImageException * */ diff --git a/generated/mbstring.php b/generated/mbstring.php index e6cce1d5..6cd8ff4e 100644 --- a/generated/mbstring.php +++ b/generated/mbstring.php @@ -451,7 +451,7 @@ function mb_regex_encoding(string $encoding = null) * * This parameter is escaped by escapeshellcmd internally * to prevent command execution. escapeshellcmd prevents - * command execution, but allows to add addtional parameters. For security reason, + * command execution, but allows to add additional parameters. For security reason, * this parameter should be validated. * * Since escapeshellcmd is applied automatically, some characters diff --git a/generated/misc.php b/generated/misc.php index 48265d55..f625e3bf 100644 --- a/generated/misc.php +++ b/generated/misc.php @@ -110,13 +110,16 @@ function sapi_windows_cp_set(int $cp): void /** - * If enable is omitted, the function return TRUE if the stream stream has VT100 control codes enabled, FALSE otherwise. + * If enable is omitted, the function returns TRUE if the stream stream has VT100 control codes enabled, FALSE otherwise. * * If enable is specified, the function will try to enable or disable the VT100 features of the stream stream. * If the feature has been successfully enabled (or disabled), . * * At startup, PHP tries to enable the VT100 feature of the STDOUT/STDERR streams. By the way, if those streams are redirected to a file, the VT100 features may not be enabled. * + * If VT100 support is enabled, it is possible to use control sequences as they are known from the VT100 terminal. + * They allow the modification of the terminal's output. On Windows these sequences are called Console Virtual Terminal Sequences. + * * @param resource $stream The stream on which the function will operate. * @param bool $enable If specified, the VT100 feature will be enabled (if TRUE) or disabled (if FALSE). * @throws MiscException diff --git a/generated/sodium.php b/generated/sodium.php index 56358c0d..cb83c8db 100644 --- a/generated/sodium.php +++ b/generated/sodium.php @@ -5,20 +5,41 @@ use Safe\Exceptions\SodiumException; /** + * Uses a CPU- and memory-hard hash algorithm along with a randomly-generated salt, and memory and CPU limits to generate an ASCII-encoded hash suitable for password storage. * + * @param string $password string; The password to generate a hash for. + * @param int $opslimit Represents a maximum amount of computations to perform. Raising this number will make the function require more CPU cycles to compute a key. There are constants available to set the operations limit to appropriate values depending on intended use, in order of strength: SODIUM_CRYPTO_PWHASH_OPSLIMIT_INTERACTIVE, SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE and SODIUM_CRYPTO_PWHASH_OPSLIMIT_SENSITIVE. + * @param int $memlimit The maximum amount of RAM that the function will use, in bytes. There are constants to help you choose an appropriate value, in order of size: SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE, SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE, and SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE. Typically these should be paired with the matching opslimit values. + * @return string Returns the hashed password, . + * + * In order to produce the same password hash from the same password, the same values for opslimit and memlimit must be used. These are embedded within the generated hash, so + * everything that's needed to verify the hash is included. This allows + * the sodium_crypto_pwhash_str_verify function to verify the hash without + * needing separate storage for the other parameters. + * @throws SodiumException + * + */ +function sodium_crypto_pwhash_str(string $password, int $opslimit, int $memlimit): string +{ + error_clear_last(); + $result = \sodium_crypto_pwhash_str($password, $opslimit, $memlimit); + if ($result === false) { + throw SodiumException::createFromPhpError(); + } + return $result; +} + + +/** + * This function provides low-level access to libsodium's crypto_pwhash key derivation function. Unless you have specific reason to use this function, you should use sodium_crypto_pwhash_str or password_hash functions instead. * * @param int $length integer; The length of the password hash to generate, in bytes. * @param string $password string; The password to generate a hash for. * @param string $salt string A salt to add to the password before hashing. The salt should be unpredictable, ideally generated from a good random mumber source such as random_bytes, and have a length of at least SODIUM_CRYPTO_PWHASH_SALTBYTES bytes. * @param int $opslimit Represents a maximum amount of computations to perform. Raising this number will make the function require more CPU cycles to compute a key. There are some constants available to set the operations limit to appropriate values depending on intended use, in order of strength: SODIUM_CRYPTO_PWHASH_OPSLIMIT_INTERACTIVE, SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE and SODIUM_CRYPTO_PWHASH_OPSLIMIT_SENSITIVE. * @param int $memlimit The maximum amount of RAM that the function will use, in bytes. There are constants to help you choose an appropriate value, in order of size: SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE, SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE, and SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE. Typically these should be paired with the matching opslimit values. - * @param int $alg integer A number indicating the hash algorithm to use. By default SODIUM_CRYPTO_PWHASH_ALG_DEFAULT (the currently recommended algorithm, which can change from one version of libsodium to another), or explicitly using SODIUM_CRYPTO_PWHASH_ALG_ARGON2I13, representing the Argon2id algorithm version 1.3. - * @return string Returns the hashed password, . - * - * The used algorithm, opslimit, memlimit and salt are embedded within the hash, so - * all information needed to verify the hash is included. This allows - * the password_verify function to verify the hash without - * needing separate storage for the salt or algorithm information. + * @param int $alg integer A number indicating the hash algorithm to use. By default SODIUM_CRYPTO_PWHASH_ALG_DEFAULT (the currently recommended algorithm, which can change from one version of libsodium to another), or explicitly using SODIUM_CRYPTO_PWHASH_ALG_ARGON2ID13, representing the Argon2id algorithm version 1.3. + * @return string Returns the derived key, . The return value is a binary string of the hash, not an ASCII-encoded representation, and does not contain additional information about the parameters used to create the hash, so you will need to keep that information if you are ever going to verify the password in future. Use sodium_crypto_pwhash_str to avoid needing to do all that. * @throws SodiumException * */ diff --git a/generated/sqlsrv.php b/generated/sqlsrv.php index 2ef7db99..d71dcb76 100644 --- a/generated/sqlsrv.php +++ b/generated/sqlsrv.php @@ -10,7 +10,7 @@ * sqlsrv_begin_transaction and before calls to * sqlsrv_rollback or sqlsrv_commit. * Explicit transactions should be started and committed or rolled back using - * these functions instead of executing SQL statements that begin and committ/roll + * these functions instead of executing SQL statements that begin and commit/roll * back transactions. For more information, see * SQLSRV Transactions. * @@ -122,7 +122,7 @@ function sqlsrv_close($conn): void * is called. The transaction that is committed includes all statements that were * executed after the call to sqlsrv_begin_transaction. * Explicit transactions should be started and committed or rolled back using these - * functions instead of executing SQL statements that begin and committ/roll back + * functions instead of executing SQL statements that begin and commit/roll back * transactions. For more information, see * SQLSRV Transactions. * @@ -218,7 +218,7 @@ function sqlsrv_execute($stmt): void * that alters server state, statement execution is terminated and the statement * is rolled back. * - * @param resource $stmt The statment for which resources are freed. + * @param resource $stmt The statement for which resources are freed. * Note that NULL is a valid parameter value. This allows the function to be * called multiple times in a script. * @throws SqlsrvException @@ -271,7 +271,7 @@ function sqlsrv_get_field($stmt, int $fieldIndex, int $getAsType = null) * Makes the next result of the specified statement active. Results include result * sets, row counts, and output parameters. * - * @param resource $stmt The statment on which the next result is being called. + * @param resource $stmt The statement on which the next result is being called. * @return mixed Returns TRUE if the next result was successfully retrieved, FALSE if an error * occurred, and NULL if there are no more results to retrieve. * @throws SqlsrvException @@ -291,7 +291,7 @@ function sqlsrv_next_result($stmt) /** * Retrieves the number of fields (columns) on a statement. * - * @param resource $stmt The statment for which the number of fields is returned. + * @param resource $stmt The statement for which the number of fields is returned. * sqlsrv_num_fields can be called on a statement before * or after statement execution. * @return mixed Returns the number of fields on success. Returns FALSE otherwise. @@ -311,12 +311,12 @@ function sqlsrv_num_fields($stmt) /** * Retrieves the number of rows in a result set. This function requires that the - * statment resource be created with a static or keyset cursor. For more information, + * statement resource be created with a static or keyset cursor. For more information, * see sqlsrv_query, sqlsrv_prepare, * or Specifying a Cursor Type and Selecting Rows * in the Microsoft SQLSRV documentation. * - * @param resource $stmt The statement for which the row count is returned. The statment resource + * @param resource $stmt The statement for which the row count is returned. The statement resource * must be created with a static or keyset cursor. For more information, see * sqlsrv_query, sqlsrv_prepare, or * Specifying a Cursor Type and Selecting Rows @@ -352,7 +352,7 @@ function sqlsrv_num_rows($stmt) * array($value [, $direction [, $phpType [, $sqlType]]]) * * The following table describes the elements in the array structure above: - * @param array $options An array specifing query property options. The supported keys are described + * @param array $options An array specifying query property options. The supported keys are described * in the following table: * @return mixed Returns a statement resource on success and FALSE if an error occurred. * @throws SqlsrvException @@ -389,7 +389,7 @@ function sqlsrv_prepare($conn, string $sql, array $params = null, array $options * array($value [, $direction [, $phpType [, $sqlType]]]) * * The following table describes the elements in the array structure above: - * @param array $options An array specifing query property options. The supported keys are described + * @param array $options An array specifying query property options. The supported keys are described * in the following table: * @return mixed Returns a statement resource on success and FALSE if an error occurred. * @throws SqlsrvException diff --git a/generated/strings.php b/generated/strings.php index 7dea1c77..dd86eb02 100644 --- a/generated/strings.php +++ b/generated/strings.php @@ -253,7 +253,7 @@ function sha1_file(string $filename, bool $raw_output = false): string * * * G - shorter of %E and - * %f. + * %F. * * * o - the argument is treated as an @@ -328,7 +328,7 @@ function sha1_file(string $filename, bool $raw_output = false): string * * * G - shorter of %E and - * %f. + * %F. * * * o - the argument is treated as an diff --git a/generated/xml.php b/generated/xml.php index 29c3f4ac..e4bb8f7a 100644 --- a/generated/xml.php +++ b/generated/xml.php @@ -4,6 +4,76 @@ use Safe\Exceptions\XmlException; +/** + * xml_parser_create_ns creates a new XML parser + * with XML namespace support and returns a resource handle referencing + * it to be used by the other XML functions. + * + * @param string $encoding The input encoding is automatically detected, so that the + * encoding parameter specifies only the output + * encoding. In PHP 5.0.0 and 5.0.1, the default output charset is + * ISO-8859-1, while in PHP 5.0.2 and upper is UTF-8. The supported + * encodings are ISO-8859-1, UTF-8 and + * US-ASCII. + * @param string $separator With a namespace aware parser tag parameters passed to the various + * handler functions will consist of namespace and tag name separated by + * the string specified in separator. + * @return resource Returns a resource handle for the new XML parser, . + * @throws XmlException + * + */ +function xml_parser_create_ns(string $encoding = null, string $separator = ":") +{ + error_clear_last(); + if ($separator !== ":") { + $result = \xml_parser_create_ns($encoding, $separator); + } elseif ($encoding !== null) { + $result = \xml_parser_create_ns($encoding); + } else { + $result = \xml_parser_create_ns(); + } + if ($result === false) { + throw XmlException::createFromPhpError(); + } + return $result; +} + + +/** + * xml_parser_create creates a new XML parser + * and returns a resource handle referencing it to be used by the + * other XML functions. + * + * @param string $encoding The optional encoding specifies the character + * encoding for the input/output in PHP 4. Starting from PHP 5, the input + * encoding is automatically detected, so that the + * encoding parameter specifies only the output + * encoding. In PHP 4, the default output encoding is the same as the + * input charset. If empty string is passed, the parser attempts to identify + * which encoding the document is encoded in by looking at the heading 3 or + * 4 bytes. In PHP 5.0.0 and 5.0.1, the default output charset is + * ISO-8859-1, while in PHP 5.0.2 and upper is UTF-8. The supported + * encodings are ISO-8859-1, UTF-8 and + * US-ASCII. + * @return resource Returns a resource handle for the new XML parser, . + * @throws XmlException + * + */ +function xml_parser_create(string $encoding = null) +{ + error_clear_last(); + if ($encoding !== null) { + $result = \xml_parser_create($encoding); + } else { + $result = \xml_parser_create(); + } + if ($result === false) { + throw XmlException::createFromPhpError(); + } + return $result; +} + + /** * This function allows to use parser inside * object. All callback functions could be set with diff --git a/rector-migrate.yml b/rector-migrate.yml index 24e6ed4c..fa7f832e 100644 --- a/rector-migrate.yml +++ b/rector-migrate.yml @@ -915,6 +915,7 @@ services: socket_set_option: 'Safe\socket_set_option' socket_shutdown: 'Safe\socket_shutdown' socket_write: 'Safe\socket_write' + sodium_crypto_pwhash_str: 'Safe\sodium_crypto_pwhash_str' sodium_crypto_pwhash: 'Safe\sodium_crypto_pwhash' solr_get_version: 'Safe\solr_get_version' class_implements: 'Safe\class_implements' @@ -1037,6 +1038,8 @@ services: xdiff_string_bpatch: 'Safe\xdiff_string_bpatch' xdiff_string_patch_binary: 'Safe\xdiff_string_patch_binary' xdiff_string_patch: 'Safe\xdiff_string_patch' + xml_parser_create_ns: 'Safe\xml_parser_create_ns' + xml_parser_create: 'Safe\xml_parser_create' xml_set_object: 'Safe\xml_set_object' xmlrpc_set_type: 'Safe\xmlrpc_set_type' yaml_parse_file: 'Safe\yaml_parse_file' From 19027ba93e87d094c30ad2f2ad6ac954d58638d6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Deruss=C3=A9?= Date: Thu, 28 Feb 2019 08:21:28 +0100 Subject: [PATCH 2/3] Improve @return documentation --- generated/apache.php | 10 +-- generated/apc.php | 10 ++- generated/apcu.php | 8 +-- generated/bzip2.php | 8 +-- generated/cubrid.php | 4 +- generated/curl.php | 14 ++-- generated/datetime.php | 14 ++-- generated/dir.php | 8 +-- generated/eio.php | 72 ++++++++++---------- generated/exec.php | 4 +- generated/fileinfo.php | 5 +- generated/filesystem.php | 40 +++++------ generated/filter.php | 2 +- generated/ftp.php | 16 ++--- generated/funchand.php | 6 +- generated/gmp.php | 8 +-- generated/hash.php | 2 +- generated/ibase.php | 8 +-- generated/ibmDb2.php | 5 +- generated/iconv.php | 4 +- generated/image.php | 30 ++++---- generated/imap.php | 14 ++-- generated/info.php | 16 ++--- generated/ingres-ii.php | 2 +- generated/inotify.php | 2 +- generated/json.php | 4 +- generated/ldap.php | 32 ++++----- generated/libevent.php | 6 +- generated/lzf.php | 4 +- generated/mailparse.php | 2 +- generated/mbstring.php | 19 +++--- generated/misc.php | 6 +- generated/msql.php | 16 ++--- generated/mssql.php | 15 ++-- generated/mysql.php | 53 +++++++------- generated/mysqlndQc.php | 2 +- generated/network.php | 9 ++- generated/oci8.php | 32 ++++----- generated/opcache.php | 3 +- generated/openssl.php | 28 ++++---- generated/password.php | 4 +- generated/pcntl.php | 5 +- generated/pcre.php | 7 +- generated/pdf.php | 144 +++++++++++++++++++-------------------- generated/pgsql.php | 62 ++++++++--------- generated/posix.php | 4 +- generated/ps.php | 14 ++-- generated/pspell.php | 6 +- generated/sem.php | 2 +- generated/shmop.php | 4 +- generated/simplexml.php | 6 +- generated/sockets.php | 22 +++--- generated/sodium.php | 4 +- generated/solr.php | 2 +- generated/spl.php | 6 +- generated/ssh2.php | 6 +- generated/stats.php | 9 +-- generated/stream.php | 16 ++--- generated/strings.php | 12 ++-- generated/uodbc.php | 35 +++++----- generated/url.php | 4 +- generated/xdiff.php | 6 +- generated/xml.php | 4 +- generated/yaml.php | 6 +- generated/yaz.php | 4 +- generated/zip.php | 2 +- generated/zlib.php | 32 ++++----- generator/src/Method.php | 2 +- 68 files changed, 469 insertions(+), 504 deletions(-) diff --git a/generated/apache.php b/generated/apache.php index 8fe2d5de..dbec11ee 100644 --- a/generated/apache.php +++ b/generated/apache.php @@ -7,7 +7,7 @@ /** * Fetch the Apache version. * - * @return string Returns the Apache version on success . + * @return string Returns the Apache version on success. * @throws ApacheException * */ @@ -30,7 +30,7 @@ function apache_get_version(): string * * @param string $variable The Apache environment variable * @param bool $walk_to_top Whether to get the top-level variable available to all Apache layers. - * @return string The value of the Apache environment variable on success, + * @return string The value of the Apache environment variable on success * @throws ApacheException * */ @@ -48,7 +48,7 @@ function apache_getenv(string $variable, bool $walk_to_top = false): string /** * Fetches all HTTP request headers from the current request. * - * @return array An associative array of all the HTTP headers in the current request, . + * @return array An associative array of all the HTTP headers in the current request. * @throws ApacheException * */ @@ -88,7 +88,7 @@ function apache_reset_timeout(): void /** * Fetch all HTTP response headers. * - * @return array An array of all Apache response headers on success . + * @return array An array of all Apache response headers on success. * @throws ApacheException * */ @@ -131,7 +131,7 @@ function apache_setenv(string $variable, string $value, bool $walk_to_top = fals * Please read the apache_request_headers * documentation for more information on how this function works. * - * @return array An associative array of all the HTTP headers in the current request, . + * @return array An associative array of all the HTTP headers in the current request. * @throws ApacheException * */ diff --git a/generated/apc.php b/generated/apc.php index 77bd483e..f7b95e41 100644 --- a/generated/apc.php +++ b/generated/apc.php @@ -62,7 +62,7 @@ function apc_cas(string $key, int $old, int $new): void * @param string $filename Full or relative path to a PHP file that will be compiled and stored in * the bytecode cache. * @param bool $atomic - * @return mixed Returns TRUE on success . + * @return mixed Returns TRUE on success. * @throws ApcException * */ @@ -84,8 +84,7 @@ function apc_compile_file(string $filename, bool $atomic = true) * @param int $step The step, or value to decrease. * @param bool $success Optionally pass the success or fail boolean value to * this referenced variable. - * @return int Returns the current value of key's value on success, - * + * @return int Returns the current value of key's value on success * @throws ApcException * */ @@ -139,7 +138,7 @@ function apc_define_constants(string $key, array $constants, bool $case_sensitiv * @param mixed $keys The files to be deleted. Accepts a string, * array of strings, or an APCIterator * object. - * @return mixed Returns TRUE on success . + * @return mixed Returns TRUE on success. * Or if keys is an array, then * an empty array is returned on success, or an array of failed files * is returned. @@ -183,8 +182,7 @@ function apc_delete(string $key) * @param int $step The step, or value to increase. * @param bool $success Optionally pass the success or fail boolean value to * this referenced variable. - * @return int Returns the current value of key's value on success, - * + * @return int Returns the current value of key's value on success * @throws ApcException * */ diff --git a/generated/apcu.php b/generated/apcu.php index dd09a303..6c2094c5 100644 --- a/generated/apcu.php +++ b/generated/apcu.php @@ -53,8 +53,7 @@ function apcu_cas(string $key, int $old, int $new): void * @param int $step The step, or value to decrease. * @param bool $success Optionally pass the success or fail boolean value to * this referenced variable. - * @return int Returns the current value of key's value on success, - * + * @return int Returns the current value of key's value on success * @throws ApcuException * */ @@ -76,7 +75,7 @@ function apcu_dec(string $key, int $step = 1, ?bool &$success = null): int * string for a single key, * or as an array of strings for several keys, * or as an APCUIterator object. - * @return bool|array Returns TRUE on success . + * @return bool|array Returns TRUE on success. * @throws ApcuException * */ @@ -97,8 +96,7 @@ function apcu_delete($key): void * @param int $step The step, or value to increase. * @param bool $success Optionally pass the success or fail boolean value to * this referenced variable. - * @return int Returns the current value of key's value on success, - * + * @return int Returns the current value of key's value on success * @throws ApcuException * */ diff --git a/generated/bzip2.php b/generated/bzip2.php index e1b35a44..d1f04df0 100644 --- a/generated/bzip2.php +++ b/generated/bzip2.php @@ -9,7 +9,7 @@ * * @param resource $bz The file pointer. It must be valid and must point to a file * successfully opened by bzopen. - * @return int Returns TRUE on success . + * @return int Returns TRUE on success. * @throws Bzip2Exception * */ @@ -30,7 +30,7 @@ function bzclose($bz): int * * @param resource $bz The file pointer. It must be valid and must point to a file * successfully opened by bzopen. - * @return int Returns TRUE on success . + * @return int Returns TRUE on success. * @throws Bzip2Exception * */ @@ -55,7 +55,7 @@ function bzflush($bz): void * @param int $length If not specified, bzread will read 1024 * (uncompressed) bytes at a time. A maximum of 8192 * uncompressed bytes will be read at a time. - * @return string Returns the uncompressed data, . + * @return string Returns the uncompressed data. * @throws Bzip2Exception * */ @@ -80,7 +80,7 @@ function bzread($bz, int $length = 1024): string * @param int $length If supplied, writing will stop after length * (uncompressed) bytes have been written or the end of * data is reached, whichever comes first. - * @return int Returns the number of bytes written, . + * @return int Returns the number of bytes written. * @throws Bzip2Exception * */ diff --git a/generated/cubrid.php b/generated/cubrid.php index 7a752d80..f19f2d56 100644 --- a/generated/cubrid.php +++ b/generated/cubrid.php @@ -6,7 +6,7 @@ /** * This function frees the memory occupied by the result data. It returns - * TRUE on success . Note that it can only frees the + * TRUE on success. Note that it can only frees the * client fetch buffer now, and if you want free all memory, use function * cubrid_close_request. * @@ -219,7 +219,7 @@ function cubrid_get_server_info($conn_identifier): string * The cubrid_insert_id function retrieves the ID * generated for the AUTO_INCREMENT column which is updated by the previous * INSERT query. It returns 0 if the previous query does not generate new - * rows, . + * rows. * * @param resource $conn_identifier The connection identifier previously obtained by a call to * cubrid_connect. diff --git a/generated/curl.php b/generated/curl.php index 80b12e03..8b865c59 100644 --- a/generated/curl.php +++ b/generated/curl.php @@ -10,7 +10,7 @@ * @param resource $ch A cURL handle returned by * curl_init. * @param string $str The string to be encoded. - * @return string Returns escaped string . + * @return string Returns escaped string. * @throws CurlException * */ @@ -33,7 +33,7 @@ function curl_escape($ch, string $str): string * * @param resource $ch A cURL handle returned by * curl_init. - * @return bool|string Returns TRUE on success . However, if the CURLOPT_RETURNTRANSFER + * @return bool|string Returns TRUE on success. However, if the CURLOPT_RETURNTRANSFER * option is set, it will return * the result on success, FALSE on failure. * @throws CurlException @@ -279,7 +279,7 @@ function curl_exec($ch) * * @return mixed If opt is given, returns its value. * Otherwise, returns an associative array with the following elements - * (which correspond to opt), : + * (which correspond to opt): * * * @@ -468,8 +468,7 @@ function curl_init(string $url = null) * * @param resource $mh A cURL multi handle returned by * curl_multi_init. - * @return int Return an integer containing the last multi curl error number, - * . + * @return int Return an integer containing the last multi curl error number. * @throws CurlException * */ @@ -2430,8 +2429,7 @@ function curl_setopt($ch, int $option, $value): void * Return an integer containing the last share curl error number. * * @param resource $sh A cURL share handle returned by curl_share_init. - * @return int Returns an integer containing the last share curl error number, - * . + * @return int Returns an integer containing the last share curl error number. * @throws CurlException * */ @@ -2527,7 +2525,7 @@ function curl_share_setopt($sh, int $option, string $value): void * @param resource $ch A cURL handle returned by * curl_init. * @param string $str The URL encoded string to be decoded. - * @return string Returns decoded string . + * @return string Returns decoded string. * @throws CurlException * */ diff --git a/generated/datetime.php b/generated/datetime.php index 9927f06c..f62077ea 100644 --- a/generated/datetime.php +++ b/generated/datetime.php @@ -29,7 +29,7 @@ function date_parse_from_format(string $format, string $date): array * * @param string $date Date in format accepted by strtotime. * @return array Returns array with information about the parsed date - * on success . + * on success. * @throws DatetimeException * */ @@ -50,7 +50,7 @@ function date_parse(string $date): array * @param int $time Timestamp. * @param float $latitude Latitude in degrees. * @param float $longitude Longitude in degrees. - * @return array Returns array on success . + * @return array Returns array on success. * The structure of the array is detailed in the following list: * * @@ -226,7 +226,7 @@ function date_sun_info(int $time, float $latitude, float $longitude): array * format is * SUNFUNCS_RET_TIMESTAMP. * @return mixed Returns the sunrise time in a specified format on - * success . One potential reason for failure is that the + * success. One potential reason for failure is that the * sun does not rise at all, which happens inside the polar circles for part of * the year. * @throws DatetimeException @@ -329,7 +329,7 @@ function date_sunrise(int $timestamp, int $format = SUNFUNCS_RET_STRING, float $ * format is * SUNFUNCS_RET_TIMESTAMP. * @return mixed Returns the sunset time in a specified format on - * success . One potential reason for failure is that the + * success. One potential reason for failure is that the * sun does not set at all, which happens inside the polar circles for part of * the year. * @throws DatetimeException @@ -424,7 +424,7 @@ function mktime(int $hour = null, int $minute = null, int $second = null, int $m /** * strptime returns an array with the - * date parsed, . + * date parsed. * * Month and weekday names and other language dependent strings respect the * current locale set with setlocale (LC_TIME). @@ -439,7 +439,7 @@ function mktime(int $hour = null, int $minute = null, int $second = null, int $m * * For more information about the format options, read the * strftime page. - * @return array Returns an array . + * @return array Returns an array. * * * The following parameters are returned in the array @@ -552,7 +552,7 @@ function strtotime(string $time, int $now = null): int * abbr doesn't exist then the time zone is * searched solely by the gmtOffset and * isdst. - * @return string Returns time zone name on success . + * @return string Returns time zone name on success. * @throws DatetimeException * */ diff --git a/generated/dir.php b/generated/dir.php index 43333312..1c4990da 100644 --- a/generated/dir.php +++ b/generated/dir.php @@ -48,7 +48,7 @@ function chroot(string $directory): void /** * Gets the current working directory. * - * @return string Returns the current working directory on success, . + * @return string Returns the current working directory on success. * * On some Unix variants, getcwd will return * FALSE if any one of the parent directories does not have the @@ -78,7 +78,7 @@ function getcwd(): string * @param 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 resource on success. * * If path is not a valid directory or the * directory can not be opened due to permission restrictions or @@ -115,7 +115,7 @@ function opendir(string $path, $context = null) * with opendir. If the directory handle is * not specified, the last link opened by opendir * is assumed. - * @return string Returns the entry name on success . + * @return string Returns the entry name on success. * @throws DirException * */ @@ -173,7 +173,7 @@ function rewinddir($dir_handle = null): void * @param resource $context For a description of the context parameter, * refer to the streams section of * the manual. - * @return array Returns an array of filenames on success, . If directory is not a directory, then + * @return array Returns an array of filenames on success. If directory is not a directory, then * boolean FALSE is returned, and an error of level * E_WARNING is generated. * @throws DirException diff --git a/generated/eio.php b/generated/eio.php index 6b9a8536..f310afe7 100644 --- a/generated/eio.php +++ b/generated/eio.php @@ -15,7 +15,7 @@ * EIO_PRI_DEFAULT. * @param callable $callback This callback is called when all the group requests are done. * @param mixed $data Arbitrary variable passed to callback. - * @return resource eio_busy returns request resource on success . + * @return resource eio_busy returns request resource on success. * @throws EioException * */ @@ -67,7 +67,7 @@ function eio_busy(int $delay, int $pri = EIO_PRI_DEFAULT, callable $callback = n * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_chmod returns request resource on success . + * @return resource eio_chmod returns request resource on success. * @throws EioException * */ @@ -119,7 +119,7 @@ function eio_chmod(string $path, int $mode, int $pri = EIO_PRI_DEFAULT, callable * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_chown returns request resource on success . + * @return resource eio_chown returns request resource on success. * @throws EioException * */ @@ -168,7 +168,7 @@ function eio_chown(string $path, int $uid, int $gid = -1, int $pri = EIO_PRI_DEF * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_close returns request resource on success . + * @return resource eio_close returns request resource on success. * @throws EioException * */ @@ -227,7 +227,7 @@ function eio_close($fd, int $pri = EIO_PRI_DEFAULT, callable $callback = null, $ * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_custom returns request resource on success . + * @return resource eio_custom returns request resource on success. * @throws EioException * */ @@ -276,7 +276,7 @@ function eio_custom(callable $execute, int $pri, callable $callback, $data = nul * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_dup2 returns request resource on success . + * @return resource eio_dup2 returns request resource on success. * @throws EioException * */ @@ -348,7 +348,7 @@ function eio_event_loop(): void * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_fallocate returns request resource on success . + * @return resource eio_fallocate returns request resource on success. * @throws EioException * */ @@ -398,7 +398,7 @@ function eio_fallocate($fd, int $mode, int $offset, int $length, int $pri = EIO_ * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_fchmod returns request resource on success . + * @return resource eio_fchmod returns request resource on success. * @throws EioException * */ @@ -446,7 +446,7 @@ function eio_fchmod($fd, int $mode, int $pri = EIO_PRI_DEFAULT, callable $callba * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_fdatasync returns request resource on success . + * @return resource eio_fdatasync returns request resource on success. * @throws EioException * */ @@ -495,7 +495,7 @@ function eio_fdatasync($fd, int $pri = EIO_PRI_DEFAULT, callable $callback = nul * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_busy returns request resource on success . + * @return resource eio_busy returns request resource on success. * @throws EioException * */ @@ -548,7 +548,7 @@ function eio_fstat($fd, int $pri, callable $callback, $data = null) * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_fstatvfs returns request resource on success . + * @return resource eio_fstatvfs returns request resource on success. * @throws EioException * */ @@ -600,7 +600,7 @@ function eio_fstatvfs($fd, int $pri, callable $callback, $data = null) * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_fsync returns request resource on success . + * @return resource eio_fsync returns request resource on success. * @throws EioException * */ @@ -651,7 +651,7 @@ function eio_fsync($fd, int $pri = EIO_PRI_DEFAULT, callable $callback = null, $ * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_ftruncate returns request resource on success . + * @return resource eio_ftruncate returns request resource on success. * @throws EioException * */ @@ -702,7 +702,7 @@ function eio_ftruncate($fd, int $offset = 0, int $pri = EIO_PRI_DEFAULT, callabl * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_futime returns request resource on success . + * @return resource eio_futime returns request resource on success. * @throws EioException * */ @@ -746,7 +746,7 @@ function eio_futime($fd, float $atime, float $mtime, int $pri = EIO_PRI_DEFAULT, * * is optional request resource which can be used with functions like eio_get_last_error * @param string $data is custom data passed to the request. - * @return resource eio_grp returns request group resource on success . + * @return resource eio_grp returns request group resource on success. * @throws EioException * */ @@ -795,7 +795,7 @@ function eio_grp(callable $callback, string $data = null) * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_lstat returns request resource on success . + * @return resource eio_lstat returns request resource on success. * @throws EioException * */ @@ -845,7 +845,7 @@ function eio_lstat(string $path, int $pri, callable $callback, $data = null) * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_mkdir returns request resource on success . + * @return resource eio_mkdir returns request resource on success. * @throws EioException * */ @@ -910,7 +910,7 @@ function eio_mkdir(string $path, int $mode, int $pri = EIO_PRI_DEFAULT, callable * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_mknod returns request resource on success . + * @return resource eio_mknod returns request resource on success. * @throws EioException * */ @@ -958,7 +958,7 @@ function eio_mknod(string $path, int $mode, int $dev, int $pri = EIO_PRI_DEFAULT * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_nop returns request resource on success . + * @return resource eio_nop returns request resource on success. * @throws EioException * */ @@ -1009,7 +1009,7 @@ function eio_nop(int $pri = EIO_PRI_DEFAULT, callable $callback = null, $data = * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_readahead returns request resource on success . + * @return resource eio_readahead returns request resource on success. * @throws EioException * */ @@ -1061,7 +1061,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 string $data is custom data passed to the request. - * @return resource eio_readdir returns request resource on success, . Sets result argument of + * @return resource eio_readdir returns request resource on success. Sets result argument of * callback function according to * flags: * @@ -1360,7 +1360,7 @@ function eio_readdir(string $path, int $flags, int $pri, callable $callback, str * * is optional request resource which can be used with functions like eio_get_last_error * @param string $data is custom data passed to the request. - * @return resource eio_readlink returns request resource on success . + * @return resource eio_readlink returns request resource on success. * @throws EioException * */ @@ -1409,7 +1409,7 @@ function eio_readlink(string $path, int $pri, callable $callback, string $data = * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_rename returns request resource on success . + * @return resource eio_rename returns request resource on success. * @throws EioException * */ @@ -1457,7 +1457,7 @@ function eio_rename(string $path, string $new_path, int $pri = EIO_PRI_DEFAULT, * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_rmdir returns request resource on success . + * @return resource eio_rmdir returns request resource on success. * @throws EioException * */ @@ -1513,7 +1513,7 @@ function eio_rmdir(string $path, int $pri = EIO_PRI_DEFAULT, callable $callback * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_seek returns request resource on success . + * @return resource eio_seek returns request resource on success. * @throws EioException * */ @@ -1565,7 +1565,7 @@ function eio_seek($fd, int $offset, int $whence, int $pri = EIO_PRI_DEFAULT, cal * * is optional request resource which can be used with functions like eio_get_last_error * @param string $data is custom data passed to the request. - * @return resource eio_sendfile returns request resource on success . + * @return resource eio_sendfile returns request resource on success. * @throws EioException * */ @@ -1622,7 +1622,7 @@ function eio_sendfile($out_fd, $in_fd, int $offset, int $length, int $pri = null * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_stat returns request resource on success . On success assigns result argument of + * @return resource eio_stat returns request resource on success. On success assigns result argument of * callback to an array. * @throws EioException * @@ -1672,7 +1672,7 @@ function eio_stat(string $path, int $pri, callable $callback, $data = null) * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_statvfs returns request resource on success . On success assigns result argument of + * @return resource eio_statvfs returns request resource on success. On success assigns result argument of * callback to an array. * @throws EioException * @@ -1727,7 +1727,7 @@ function eio_statvfs(string $path, int $pri, callable $callback, $data = null) * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_symlink returns request resource on success . + * @return resource eio_symlink returns request resource on success. * @throws EioException * */ @@ -1786,7 +1786,7 @@ function eio_symlink(string $path, string $new_path, int $pri = EIO_PRI_DEFAULT, * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_sync_file_range returns request resource on success . + * @return resource eio_sync_file_range returns request resource on success. * @throws EioException * */ @@ -1807,7 +1807,7 @@ function eio_sync_file_range($fd, int $offset, int $nbytes, int $flags, int $pri * @param int $pri * @param callable $callback * @param mixed $data - * @return resource eio_sync returns request resource on success . + * @return resource eio_sync returns request resource on success. * @throws EioException * */ @@ -1855,7 +1855,7 @@ function eio_sync(int $pri = EIO_PRI_DEFAULT, callable $callback = null, $data = * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_syncfs returns request resource on success . + * @return resource eio_syncfs returns request resource on success. * @throws EioException * */ @@ -1905,7 +1905,7 @@ function eio_syncfs($fd, int $pri = EIO_PRI_DEFAULT, callable $callback = null, * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_busy returns request resource on success . + * @return resource eio_busy returns request resource on success. * @throws EioException * */ @@ -1953,7 +1953,7 @@ function eio_truncate(string $path, int $offset = 0, int $pri = EIO_PRI_DEFAULT, * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_unlink returns request resource on success . + * @return resource eio_unlink returns request resource on success. * @throws EioException * */ @@ -2003,7 +2003,7 @@ function eio_unlink(string $path, int $pri = EIO_PRI_DEFAULT, callable $callback * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_utime returns request resource on success . + * @return resource eio_utime returns request resource on success. * @throws EioException * */ @@ -2056,7 +2056,7 @@ function eio_utime(string $path, float $atime, float $mtime, int $pri = EIO_PRI_ * * is optional request resource which can be used with functions like eio_get_last_error * @param mixed $data is custom data passed to the request. - * @return resource eio_write returns request resource on success . + * @return resource eio_write returns request resource on success. * @throws EioException * */ diff --git a/generated/exec.php b/generated/exec.php index 2c69b5e8..e9a40e08 100644 --- a/generated/exec.php +++ b/generated/exec.php @@ -10,7 +10,7 @@ * * @param resource $process The proc_open resource that will * be evaluated. - * @return array An array of collected information on success, . The returned array contains the following elements: + * @return array An array of collected information on success. The returned array contains the following elements: * * * @@ -144,7 +144,7 @@ function proc_nice(int $increment): void * @param int $return_var If the return_var argument is present, then the * return status of the executed command will be written to this * variable. - * @return string Returns the last line of the command output on success, . + * @return string Returns the last line of the command output on success. * @throws ExecException * */ diff --git a/generated/fileinfo.php b/generated/fileinfo.php index 40f2eb13..c65a3fe5 100644 --- a/generated/fileinfo.php +++ b/generated/fileinfo.php @@ -39,7 +39,7 @@ function finfo_close($finfo): void * Passing NULL or an empty string will be equivalent to the default * value. * @return resource (Procedural style only) - * Returns a magic database resource on success . + * Returns a magic database resource on success. * @throws FileinfoException * */ @@ -60,8 +60,7 @@ function finfo_open(int $options = FILEINFO_NONE, ?string $magic_file = null) * * @param string $filename Path to the tested file. * @return string Returns the content type in MIME format, like - * text/plain or application/octet-stream, - * . + * text/plain or application/octet-stream. * @throws FileinfoException * */ diff --git a/generated/filesystem.php b/generated/filesystem.php index 7983be90..690bf645 100644 --- a/generated/filesystem.php +++ b/generated/filesystem.php @@ -129,8 +129,7 @@ function copy(string $source, string $dest, $context = null): void * Given a file name instead of a directory, the behaviour of the * function is unspecified and may differ between operating systems and * PHP versions. - * @return float Returns the number of available bytes as a float - * . + * @return float Returns the number of available bytes as a float. * @throws FilesystemException * */ @@ -150,8 +149,7 @@ function disk_free_space(string $directory): float * number of bytes on the corresponding filesystem or disk partition. * * @param string $directory A directory of the filesystem or disk partition. - * @return float Returns the total number of bytes as a float - * . + * @return float Returns the total number of bytes as a float. * @throws FilesystemException * */ @@ -235,7 +233,7 @@ function fflush($handle): void * @param int $maxlen Maximum length of data read. The default is to read until end * of file is reached. Note that this parameter is applied to the * stream processed by the filters. - * @return string The function returns the read data . + * @return string The function returns the read data. * @throws FilesystemException * */ @@ -328,7 +326,7 @@ function file_get_contents(string $filename, bool $use_include_path = false, $co * * @param resource $context A valid context resource created with * stream_context_create. - * @return int This function returns the number of bytes that were written to the file, . + * @return int This function returns the number of bytes that were written to the file. * @throws FilesystemException * */ @@ -351,7 +349,7 @@ function file_put_contents(string $filename, $data, int $flags = 0, $context = n * * * @param string $filename Path to the file. - * @return int Returns the time the file was last accessed, . + * @return int Returns the time the file was last accessed. * The time is returned as a Unix timestamp. * @throws FilesystemException * @@ -371,7 +369,7 @@ function fileatime(string $filename): int * Gets the inode change time of a file. * * @param string $filename Path to the file. - * @return int Returns the time the file was last changed, . + * @return int Returns the time the file was last changed. * The time is returned as a Unix timestamp. * @throws FilesystemException * @@ -391,7 +389,7 @@ function filectime(string $filename): int * Gets the file inode. * * @param string $filename Path to the file. - * @return int Returns the inode number of the file, . + * @return int Returns the inode number of the file. * @throws FilesystemException * */ @@ -411,7 +409,7 @@ function fileinode(string $filename): int * written to, that is, the time when the content of the file was changed. * * @param string $filename Path to the file. - * @return int Returns the time the file was last modified, . + * @return int Returns the time the file was last modified. * The time is returned as a Unix timestamp, which is * suitable for the date function. * @throws FilesystemException @@ -432,7 +430,7 @@ function filemtime(string $filename): int * Gets the file owner. * * @param string $filename Path to the file. - * @return int Returns the user ID of the owner of the file, . + * @return int Returns the user ID of the owner of the file. * The user ID is returned in numerical format, use * posix_getpwuid to resolve it to a username. * @throws FilesystemException @@ -721,7 +719,7 @@ function flock($handle, int $operation, ?int &$wouldblock = null): void * can be set to '1' or TRUE if you want to search for the file in the * include_path, too. * @param resource $context - * @return resource Returns a file pointer resource on success, . + * @return resource Returns a file pointer resource on success. * @throws FilesystemException * */ @@ -757,7 +755,7 @@ function fopen(string $filename, string $mode, bool $use_include_path = false, $ * @param string $escape_char The optional escape_char parameter sets the * escape character (at most one character). * An empty string ("") disables the proprietary escape mechanism. - * @return int Returns the length of the written string . + * @return int Returns the length of the written string. * @throws FilesystemException * */ @@ -807,7 +805,7 @@ function fputcsv($handle, array $fields, string $delimiter = ",", string $enclos * @param resource $handle A file system pointer resource * that is typically created using fopen. * @param int $length Up to length number of bytes read. - * @return string Returns the read string . + * @return string Returns the read string. * @throws FilesystemException * */ @@ -936,7 +934,7 @@ function fwrite($handle, string $string, int $length = null): int * * * @return array Returns an array containing the matched files/directories, an empty array - * if no file matched . + * if no file matched. * @throws FilesystemException * */ @@ -1070,8 +1068,7 @@ function mkdir(string $pathname, int $mode = 0777, bool $recursive = false, $con * are converted to TRUE. "false", "off", "no" * and "none" are considered FALSE. "null" is converted to NULL * in typed mode. Also, all numeric strings are converted to integer type if it is possible. - * @return array The settings are returned as an associative array on success, - * . + * @return array The settings are returned as an associative array on success. * @throws FilesystemException * */ @@ -1108,8 +1105,7 @@ function parse_ini_file(string $filename, bool $process_sections = false, int $s * are converted to TRUE. "false", "off", "no" * and "none" are considered FALSE. "null" is converted to NULL * in typed mode. Also, all numeric strings are converted to integer type if it is possible. - * @return array The settings are returned as an associative array on success, - * . + * @return array The settings are returned as an associative array on success. * @throws FilesystemException * */ @@ -1128,7 +1124,7 @@ function parse_ini_string(string $ini, bool $process_sections = false, int $scan * readlink does the same as the readlink C function. * * @param string $path The symbolic link path. - * @return string Returns the contents of the symbolic link path . + * @return string Returns the contents of the symbolic link path. * @throws FilesystemException * */ @@ -1282,7 +1278,7 @@ function symlink(string $target, string $link): void * * @param string $dir The directory where the temporary filename will be created. * @param string $prefix The prefix of the generated temporary filename. - * @return string Returns the new temporary filename (with path), . + * @return string Returns the new temporary filename (with path). * @throws FilesystemException * */ @@ -1307,7 +1303,7 @@ function tempnam(string $dir, string $prefix): string * script ends. * * @return resource Returns a file handle, similar to the one returned by - * fopen, for the new file . + * fopen, for the new file. * @throws FilesystemException * */ diff --git a/generated/filter.php b/generated/filter.php index 2fa3a3bf..297a8aa1 100644 --- a/generated/filter.php +++ b/generated/filter.php @@ -91,7 +91,7 @@ function filter_input_array(int $type, $definition = null, bool $add_empty = tru * This parameter can be also an integer holding a filter constant. Then all values in the * input array are filtered by this filter. * @param bool $add_empty Add missing keys as NULL to the return value. - * @return mixed An array containing the values of the requested variables on success, . An array value will be FALSE if the filter fails, or NULL if + * @return mixed 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. * @throws FilterException * diff --git a/generated/ftp.php b/generated/ftp.php index 8ed43b08..f8aff076 100644 --- a/generated/ftp.php +++ b/generated/ftp.php @@ -87,7 +87,7 @@ function ftp_chdir($ftp_stream, string $directory): void * @param resource $ftp_stream The link identifier of the FTP connection. * @param int $mode The new permissions, given as an octal value. * @param string $filename The remote file. - * @return int Returns the new file permissions on success . + * @return int Returns the new file permissions on success. * @throws FtpException * */ @@ -132,7 +132,7 @@ function ftp_close($ftp_stream): void * If omitted, the default value is 90 seconds. The timeout can be changed and * queried at any time with ftp_set_option and * ftp_get_option. - * @return resource Returns a FTP stream on success . + * @return resource Returns a FTP stream on success. * @throws FtpException * */ @@ -259,7 +259,7 @@ function ftp_login($ftp_stream, string $username, string $password): void * * @param resource $ftp_stream The link identifier of the FTP connection. * @param string $directory The name of the directory that will be created. - * @return string Returns the newly created directory name on success . + * @return string Returns the newly created directory name on success. * @throws FtpException * */ @@ -279,7 +279,7 @@ function ftp_mkdir($ftp_stream, string $directory): string * * @param resource $ftp_stream The link identifier of the FTP connection. * @param string $directory The directory to be listed. - * @return array Returns an array of arrays with file infos from the specified directory on success . + * @return array Returns an array of arrays with file infos from the specified directory on success. * @throws FtpException * */ @@ -302,7 +302,7 @@ function ftp_mlsd($ftp_stream, string $directory): array * ftp_nlist($conn_id, "-la /your/dir"); * Note that this parameter isn't escaped so there may be some issues with * filenames containing spaces and other characters. - * @return array Returns an array of filenames from the specified directory on success . + * @return array Returns an array of filenames from the specified directory on success. * @throws FtpException * */ @@ -367,7 +367,7 @@ function ftp_put($ftp_stream, string $remote_file, string $local_file, int $mode * * * @param resource $ftp_stream The link identifier of the FTP connection. - * @return string Returns the current directory name . + * @return string Returns the current directory name. * @throws FtpException * */ @@ -462,7 +462,7 @@ function ftp_site($ftp_stream, string $command): void * If omitted, the default value is 90 seconds. The timeout can be changed and * queried at any time with ftp_set_option and * ftp_get_option. - * @return resource Returns a SSL-FTP stream on success . + * @return resource Returns a SSL-FTP stream on success. * @throws FtpException * */ @@ -481,7 +481,7 @@ function ftp_ssl_connect(string $host, int $port = 21, int $timeout = 90) * Returns the system type identifier of the remote FTP server. * * @param resource $ftp_stream The link identifier of the FTP connection. - * @return string Returns the remote system type, . + * @return string Returns the remote system type. * @throws FtpException * */ diff --git a/generated/funchand.php b/generated/funchand.php index 4a4cb43c..bd7183e1 100644 --- a/generated/funchand.php +++ b/generated/funchand.php @@ -10,7 +10,7 @@ * * @param string $args The function arguments. * @param string $code The function code. - * @return string Returns a unique function name as a string, . + * @return string Returns a unique function name as a string. * @throws FunchandException * */ @@ -41,7 +41,7 @@ function create_function(string $args, string $code): string * * Note that the parameters for forward_static_call_array are * not passed by reference. - * @return mixed Returns the function result, . + * @return mixed Returns the function result. * @throws FunchandException * */ @@ -67,7 +67,7 @@ function forward_static_call_array(callable $function, array $parameters) * with the name of the class, and the method, or a string, with a function * name. * @param mixed $params Zero or more parameters to be passed to the function. - * @return mixed Returns the function result, . + * @return mixed Returns the function result. * @throws FunchandException * */ diff --git a/generated/gmp.php b/generated/gmp.php index 38b15a46..e756b698 100644 --- a/generated/gmp.php +++ b/generated/gmp.php @@ -9,7 +9,7 @@ * * @param mixed $n Either a GMP number resource in PHP 5.5 and earlier, a GMP object in PHP 5.6 and later, or a numeric string provided that it is possible to convert the latter to a number. * @param int $k - * @return \\GMP Returns the binomial coefficient C(n, k), . + * @return \\GMP Returns the binomial coefficient C(n, k). * @throws GmpException * */ @@ -30,7 +30,7 @@ function gmp_binomial($n, int $k): \GMP * @param \GMP|string|int $gmpnumber The GMP number being exported * @param int $word_size Default value is 1. The number of bytes in each chunk of binary data. This is mainly used in conjunction with the options parameter. * @param int $options Default value is GMP_MSW_FIRST | GMP_NATIVE_ENDIAN. - * @return string Returns a string . + * @return string Returns a string. * @throws GmpException * */ @@ -51,7 +51,7 @@ function gmp_export(\GMP $gmpnumber, int $word_size = 1, int $options = GMP_MSW_ * @param string $data The binary string being imported * @param int $word_size Default value is 1. The number of bytes in each chunk of binary data. This is mainly used in conjunction with the options parameter. * @param int $options Default value is GMP_MSW_FIRST | GMP_NATIVE_ENDIAN. - * @return \GMP Returns a GMP number . + * @return \GMP Returns a GMP number. * @throws GmpException * */ @@ -74,7 +74,7 @@ function gmp_import(string $data, int $word_size = 1, int $options = GMP_MSW_FIR * gmp_random_range functions. * * Either a GMP number resource in PHP 5.5 and earlier, a GMP object in PHP 5.6 and later, or a numeric string provided that it is possible to convert the latter to a number. - * @return \GMP Returns NULL on success . + * @return \GMP Returns NULL on success. * @throws GmpException * */ diff --git a/generated/hash.php b/generated/hash.php index ff916a41..62644413 100644 --- a/generated/hash.php +++ b/generated/hash.php @@ -27,7 +27,7 @@ * * While optional, adding random salt significantly improves the strength of HKDF. * @return string Returns a string containing a raw binary representation of the derived key - * (also known as output keying material - OKM); . + * (also known as output keying material - OKM);. * @throws HashException * */ diff --git a/generated/ibase.php b/generated/ibase.php index 6fac72e2..ef5285a4 100644 --- a/generated/ibase.php +++ b/generated/ibase.php @@ -59,7 +59,7 @@ function ibase_blob_cancel($blob_handle): void * @param resource $link_identifier An InterBase link identifier. If omitted, the last opened link is * assumed. * @return resource Returns a BLOB handle for later use with - * ibase_blob_add . + * ibase_blob_add. * @throws IbaseException * */ @@ -80,7 +80,7 @@ function ibase_blob_create($link_identifier = null) * * @param resource $blob_handle A BLOB handle opened with ibase_blob_open. * @param int $len Size of returned data. - * @return string Returns at most len bytes from the BLOB, . + * @return string Returns at most len bytes from the BLOB. * @throws IbaseException * */ @@ -190,7 +190,7 @@ function ibase_commit($link_or_trans_identifier = null): void * one supported by client libraries. * @param string $role Functional only with InterBase 5 and up. * @param int $sync - * @return resource Returns an Firebird/InterBase link identifier on success, . + * @return resource Returns an Firebird/InterBase link identifier on success. * @throws IbaseException * */ @@ -420,7 +420,7 @@ function ibase_name_result($result, string $name): void * and up. * @param string $role Functional only with InterBase 5 and up. * @param int $sync - * @return resource Returns an InterBase link identifier on success, . + * @return resource Returns an InterBase link identifier on success. * @throws IbaseException * */ diff --git a/generated/ibmDb2.php b/generated/ibmDb2.php index 1762d252..c936bdaa 100644 --- a/generated/ibmDb2.php +++ b/generated/ibmDb2.php @@ -42,7 +42,7 @@ * connection parameter and * autocommit parameter, it attempts to set the * AUTOCOMMIT state of the requested connection to the corresponding state. - * Returns TRUE on success . + * Returns TRUE on success. * @throws IbmDb2Exception * */ @@ -504,8 +504,7 @@ function db2_free_stmt($stmt): void * * * 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 - * . + * @return string Returns the current setting of the connection attribute provided on success. * @throws IbmDb2Exception * */ diff --git a/generated/iconv.php b/generated/iconv.php index 6cf97875..44cf96ab 100644 --- a/generated/iconv.php +++ b/generated/iconv.php @@ -15,7 +15,7 @@ * internal_encoding * * @return mixed Returns the current value of the internal configuration variable if - * successful . + * successful. * * If type is omitted or set to "all", * iconv_get_encoding returns an array that @@ -81,7 +81,7 @@ function iconv_set_encoding(string $type, string $charset): void * so the conversion is likely to fail for characters which are illegal for * the out_charset. * @param string $str The string to be converted. - * @return string Returns the converted string . + * @return string Returns the converted string. * @throws IconvException * */ diff --git a/generated/image.php b/generated/image.php index 1b2473fb..4557ce06 100644 --- a/generated/image.php +++ b/generated/image.php @@ -41,7 +41,7 @@ function image2wbmp($image, ?string $filename = null, int $foreground = null): v * such as imagecreatetruecolor. * @param array $affine Array with keys 0 to 5. * @param array $clip Array with keys "x", "y", "width" and "height". - * @return resource Return affined image resource on success . + * @return resource Return affined image resource on success. * @throws ImageException * */ @@ -70,8 +70,7 @@ function imageaffine($image, array $affine, array $clip = null) * @param array $m2 An affine transformation matrix (an array with keys * 0 to 5 and float values). * @return array An affine transformation matrix (an array with keys - * 0 to 5 and float values) - * . + * 0 to 5 and float values). * @throws ImageException * */ @@ -99,8 +98,7 @@ function imageaffinematrixconcat(array $m1, array $m2): array * IMG_AFFINE_SHEAR_HORIZONTAL or IMG_AFFINE_SHEAR_VERTICAL, * options has to be a float specifying the angle. * @return array An affine transformation matrix (an array with keys - * 0 to 5 and float values) - * . + * 0 to 5 and float values). * @throws ImageException * */ @@ -295,7 +293,7 @@ function imagecharup($image, int $font, int $x, int $y, string $c, int $color): * such as imagecreatetruecolor. * @param int $x x-coordinate of the point. * @param int $y y-coordinate of the point. - * @return int Returns the index of the color . + * @return int Returns the index of the color. * @throws ImageException * */ @@ -359,7 +357,7 @@ function imagecolormatch($image1, $image2): void * @param array $matrix A 3x3 matrix: an array of three arrays of three floats. * @param float $div The divisor of the result of the convolution, used for normalization. * @param float $offset Color offset. - * @return resource Returns TRUE on success . + * @return resource Returns TRUE on success. * @throws ImageException * */ @@ -578,7 +576,7 @@ function imagecopyresized($dst_image, $src_image, int $dst_x, int $dst_y, int $s * @param array $rect The cropping rectangle as array with keys * x, y, width and * height. - * @return resource Return cropped image resource on success . + * @return resource Return cropped image resource on success. * @throws ImageException * */ @@ -602,7 +600,7 @@ function imagecrop($image, array $rect) * @param int $mode One of the following constants: * @param float $threshold * @param int $color - * @return resource Returns a cropped image resource on success . + * @return resource Returns a cropped image resource on success. * If the complete image was cropped, imagecrop returns FALSE. * @throws ImageException * @@ -1363,7 +1361,7 @@ function imageline($image, int $x1, int $y1, int $x2, int $y2, int $color): void * * * @return int The font identifier which is always bigger than 5 to avoid conflicts with - * built-in fonts s. + * built-in fontss. * @throws ImageException * */ @@ -1623,7 +1621,7 @@ function imagerectangle($image, int $x1, int $y1, int $x2, int $y2, int $color): * number of degrees to rotate the image anticlockwise. * @param int $bgd_color Specifies the color of the uncovered zone after the rotation * @param int $ignore_transparent If set and non-zero, transparent colors are ignored (otherwise kept). - * @return resource Returns an image resource for the rotated image, . + * @return resource Returns an image resource for the rotated image. * @throws ImageException * */ @@ -1684,7 +1682,7 @@ function imagesavealpha($image, bool $saveflag): void * IMG_WEIGHTED4 is not yet supported. * * - * @return resource Return the scaled image resource on success . + * @return resource Return the scaled image resource on success. * @throws ImageException * */ @@ -2024,7 +2022,7 @@ function imagestringup($image, int $font, int $x, int $y, string $string, int $c * * @param resource $image An image resource, returned by one of the image creation functions, * such as imagecreatetruecolor. - * @return int Return the width of the image s. + * @return int Return the width of the images. * @throws ImageException * */ @@ -2044,7 +2042,7 @@ function imagesx($image): int * * @param resource $image An image resource, returned by one of the image creation functions, * such as imagecreatetruecolor. - * @return int Return the height of the image s. + * @return int Return the height of the images. * @throws ImageException * */ @@ -2349,9 +2347,7 @@ function imagexbm($image, ?string $filename = null, int $foreground = null): voi * @param string $jpeg_file_name Path to the JPEG image. * @param int $spool Spool flag. If the spool flag is less than 2 then the JPEG will be * returned as a string. Otherwise the JPEG will be printed to STDOUT. - * @return array If spool is less than 2, the JPEG will be returned, - * . Otherwise returns TRUE on success - * . + * @return array If spool is less than 2, the JPEG will be returned. Otherwise returns TRUE on success. * @throws ImageException * */ diff --git a/generated/imap.php b/generated/imap.php index fb4e5d56..e8c4df75 100644 --- a/generated/imap.php +++ b/generated/imap.php @@ -596,8 +596,7 @@ function imap_mailboxmsginfo($imap_stream): object * Decode a modified UTF-7 (as specified in RFC 2060, section 5.1.3) string to UTF-8. * * @param string $in A string encoded in modified UTF-7. - * @return string Returns in converted to UTF-8, - * . + * @return string Returns in converted to UTF-8. * @throws ImapException * */ @@ -617,7 +616,7 @@ function imap_mutf7_to_utf8(string $in): string * * @param resource $imap_stream An IMAP stream returned by * imap_open. - * @return int Return the number of messages in the current mailbox, as an integer, . + * @return int Return the number of messages in the current mailbox, as an integer. * @throws ImapException * */ @@ -832,7 +831,7 @@ function imap_num_msg($imap_stream): int * * * - * @return resource Returns an IMAP stream on success . + * @return resource Returns an IMAP stream on success. * @throws ImapException * */ @@ -1021,7 +1020,7 @@ function imap_subscribe($imap_stream, string $mailbox): void * imap_open. * @param int $options * @return array imap_thread returns an associative array containing - * a tree of messages threaded by REFERENCES, . + * a tree of messages threaded by REFERENCES. * * Every message in the current mailbox will be represented by three entries * in the resulting array: @@ -1060,7 +1059,7 @@ function imap_thread($imap_stream, int $options = SE_FREE): array * IMAP_CLOSETIMEOUT. * @param int $timeout The timeout, in seconds. * @return mixed If the timeout parameter is set, this function - * returns TRUE on success . + * returns TRUE on success. * * If timeout is not provided or evaluates to -1, * the current timeout value of timeout_type is @@ -1124,8 +1123,7 @@ function imap_unsubscribe($imap_stream, string $mailbox): void * Encode a UTF-8 string to modified UTF-7 (as specified in RFC 2060, section 5.1.3). * * @param string $in A UTF-8 encoded string. - * @return string Returns in converted to modified UTF-7, - * . + * @return string Returns in converted to modified UTF-7. * @throws ImapException * */ diff --git a/generated/info.php b/generated/info.php index fc597143..fb5eff3e 100644 --- a/generated/info.php +++ b/generated/info.php @@ -57,7 +57,7 @@ * * * @param mixed $value An optional new value for the option. - * @return mixed Returns the original setting of any option s. + * @return mixed Returns the original setting of any options. * @throws InfoException * */ @@ -146,7 +146,7 @@ function cli_set_process_title(string $title): void * /usr/local/php/lib/php/extensions/debug-non-zts-20010901 * or * /usr/local/php/lib/php/extensions/no-debug-zts-20010901. - * @return int Returns TRUE on success . If the functionality of loading modules is not available + * @return int Returns TRUE on success. If the functionality of loading modules is not available * or has been disabled (either by setting * enable_dl off or by enabling safe mode * in php.ini) an E_ERROR is emitted @@ -192,7 +192,7 @@ function getlastmod(): int /** * * - * @return int Returns the group ID of the current script, . + * @return int Returns the group ID of the current script. * @throws InfoException * */ @@ -210,7 +210,7 @@ function getmygid(): int /** * Gets the inode of the current script. * - * @return int Returns the current script's inode as an integer, . + * @return int Returns the current script's inode as an integer. * @throws InfoException * */ @@ -228,7 +228,7 @@ function getmyinode(): int /** * Gets the current PHP process ID. * - * @return int Returns the current PHP process ID, . + * @return int Returns the current PHP process ID. * @throws InfoException * */ @@ -246,7 +246,7 @@ function getmypid(): int /** * * - * @return int Returns the user ID of the current script, . + * @return int Returns the user ID of the current script. * @throws InfoException * */ @@ -267,7 +267,7 @@ function getmyuid(): int * @param string $options * @param array $longopts * @param int $optind - * @return array|array|array This function will return an array of option / argument pairs, . + * @return array|array|array This function will return an array of option / argument pairs. * @throws InfoException * */ @@ -542,7 +542,7 @@ function putenv(string $setting): void * * @param string $new_include_path The new value for the include_path * @return string Returns the old include_path on - * success . + * success. * @throws InfoException * */ diff --git a/generated/ingres-ii.php b/generated/ingres-ii.php index 540e9089..9ea8b5f3 100644 --- a/generated/ingres-ii.php +++ b/generated/ingres-ii.php @@ -436,7 +436,7 @@ function ingres_field_name($result, int $index): string * and ingres_num_fields - * 1. * @return string ingres_field_type returns the type of a - * field in a query result . Examples of + * field in a query result. Examples of * types returned are IIAPI_BYTE_TYPE, * IIAPI_CHA_TYPE, IIAPI_DTE_TYPE, * IIAPI_FLT_TYPE, IIAPI_INT_TYPE, diff --git a/generated/inotify.php b/generated/inotify.php index cee5e067..2e070415 100644 --- a/generated/inotify.php +++ b/generated/inotify.php @@ -8,7 +8,7 @@ * Initialize an inotify instance for use with * inotify_add_watch * - * @return resource A stream resource . + * @return resource A stream resource. * @throws InotifyException * */ diff --git a/generated/json.php b/generated/json.php index d84a7f51..1de66b80 100644 --- a/generated/json.php +++ b/generated/json.php @@ -35,7 +35,7 @@ * constants is described on the * JSON constants page. * @param int $depth Set the maximum depth. Must be greater than zero. - * @return string Returns a JSON encoded string on success . + * @return string Returns a JSON encoded string on success. * @throws JsonException * */ @@ -54,7 +54,7 @@ function json_encode($value, int $options = 0, int $depth = 512): string * * * @return string Returns the error message on success, "No error" if no - * error has occurred, . + * error has occurred. * @throws JsonException * */ diff --git a/generated/ldap.php b/generated/ldap.php index 8a6101e0..0947eb94 100644 --- a/generated/ldap.php +++ b/generated/ldap.php @@ -11,7 +11,7 @@ * @param string $dn * @param array $entry * @param array $serverctrls - * @return resource Returns an LDAP result identifier . + * @return resource Returns an LDAP result identifier. * @throws LdapException * */ @@ -61,7 +61,7 @@ function ldap_add($link_identifier, string $dn, array $entry, array $serverctrls * @param resource $link_identifier * @param string $bind_rdn * @param string $bind_password - * @return resource Returns an LDAP result identifier . + * @return resource Returns an LDAP result identifier. * @throws LdapException * */ @@ -144,7 +144,7 @@ function ldap_control_paged_result($link, int $pagesize, bool $iscritical = fals * * @param resource $link_identifier An LDAP link identifier, returned by ldap_connect. * @param resource $result_identifier The internal LDAP result. - * @return int Returns number of entries in the result . + * @return int Returns number of entries in the result. * @throws LdapException * */ @@ -165,7 +165,7 @@ function ldap_count_entries($link_identifier, $result_identifier): int * @param resource $link_identifier * @param string $dn * @param array $serverctrls - * @return resource Returns an LDAP result identifier . + * @return resource Returns an LDAP result identifier. * @throws LdapException * */ @@ -210,7 +210,7 @@ function ldap_delete($link_identifier, string $dn, array $serverctrls = null): v * filled with an array of LDAP Controls * returned with the request. * @return mixed Returns the generated password if newpw is empty or omitted. - * Otherwise returns TRUE on success . + * Otherwise returns TRUE on success. * @throws LdapException * */ @@ -229,7 +229,7 @@ function ldap_exop_passwd($link, string $user = "", string $oldpw = "", string $ * Performs a WHOAMI extended operation and returns the data. * * @param resource $link An LDAP link identifier, returned by ldap_connect. - * @return string The data returned by the server, . + * @return string The data returned by the server. * @throws LdapException * */ @@ -257,8 +257,8 @@ function ldap_exop_whoami($link): string * If not provided you may use ldap_parse_exop on the result object * later to get this data. * @param string $retoid Will be filled with the response OID if provided, usually equal to the request OID. - * @return mixed When used with retdata, returns TRUE on success . - * When used without retdata, returns a result identifier . + * @return mixed When used with retdata, returns TRUE on success. + * When used without retdata, returns a result identifier. * @throws LdapException * */ @@ -283,7 +283,7 @@ function ldap_exop($link, string $reqoid, string $reqdata = null, ?array $server * attributes as well. To get RDNs with the attributes (i.e. in * attribute=value format) set with_attrib to 0 * and to get only values set it to 1. - * @return array Returns an array of all DN components, . + * @return array Returns an array of all DN components. * The first element in the array has count key and * represents the number of returned values, next elements are numerically * indexed DN components. @@ -793,7 +793,7 @@ function ldap_get_values($link_identifier, $result_entry_identifier, string $att * * * @param array $serverctrls Array of LDAP Controls to send with the request. - * @return resource Returns a search result identifier . + * @return resource Returns a search result identifier. * @throws LdapException * */ @@ -829,7 +829,7 @@ function ldap_list($link_identifier, string $base_dn, string $filter, array $att * @param string $dn * @param array $entry * @param array $serverctrls - * @return resource Returns an LDAP result identifier . + * @return resource Returns an LDAP result identifier. * @throws LdapException * */ @@ -872,7 +872,7 @@ function ldap_mod_add($link_identifier, string $dn, array $entry, array $serverc * @param string $dn * @param array $entry * @param array $serverctrls - * @return resource Returns an LDAP result identifier . + * @return resource Returns an LDAP result identifier. * @throws LdapException * */ @@ -916,7 +916,7 @@ function ldap_mod_del($link_identifier, string $dn, array $entry, array $serverc * @param string $dn * @param array $entry * @param array $serverctrls - * @return resource Returns an LDAP result identifier . + * @return resource Returns an LDAP result identifier. * @throws LdapException * */ @@ -1188,7 +1188,7 @@ function ldap_parse_result($link, $result, int &$errcode, string &$matcheddn = n * * * @param array $serverctrls Array of LDAP Controls to send with the request. - * @return resource Returns a search result identifier . + * @return resource Returns a search result identifier. * @throws LdapException * */ @@ -1226,7 +1226,7 @@ function ldap_read($link_identifier, string $base_dn, string $filter, array $att * @param string $newparent * @param bool $deleteoldrdn * @param array $serverctrls - * @return resource Returns an LDAP result identifier . + * @return resource Returns an LDAP result identifier. * @throws LdapException * */ @@ -1370,7 +1370,7 @@ function ldap_sasl_bind($link, string $binddn = null, string $password = null, s * * * @param array $serverctrls Array of LDAP Controls to send with the request. - * @return resource Returns a search result identifier . + * @return resource Returns a search result identifier. * @throws LdapException * */ diff --git a/generated/libevent.php b/generated/libevent.php index 2eea8fe7..574f0a67 100644 --- a/generated/libevent.php +++ b/generated/libevent.php @@ -71,7 +71,7 @@ function event_base_loopexit($event_base, int $timeout = -1): void * event_base_loop and other functions. * * @return resource event_base_new returns valid event base resource on - * success . + * success. * @throws LibeventException * */ @@ -219,7 +219,7 @@ function event_buffer_enable($bevent, int $events): void * NULL. * @param mixed $arg An argument that will be passed to each of the callbacks (optional). * @return resource event_buffer_new returns new buffered event resource - * on success . + * on success. * @throws LibeventException * */ @@ -327,7 +327,7 @@ function event_del($event): void /** * Creates and returns a new event resource. * - * @return resource event_new returns a new event resource on success . + * @return resource event_new returns a new event resource on success. * @throws LibeventException * */ diff --git a/generated/lzf.php b/generated/lzf.php index 21c622a0..7fce838a 100644 --- a/generated/lzf.php +++ b/generated/lzf.php @@ -9,7 +9,7 @@ * data string using LZF encoding. * * @param string $data The string to compress. - * @return string Returns the compressed data . + * @return string Returns the compressed data. * @throws LzfException * */ @@ -29,7 +29,7 @@ function lzf_compress(string $data): string * data string containing lzf encoded data. * * @param string $data The compressed string. - * @return string Returns the decompressed data . + * @return string Returns the decompressed data. * @throws LzfException * */ diff --git a/generated/mailparse.php b/generated/mailparse.php index 6e3760f1..db47bc4d 100644 --- a/generated/mailparse.php +++ b/generated/mailparse.php @@ -68,7 +68,7 @@ function mailparse_msg_free($mimemail): void * * @param string $filename Path to the file holding the message. * The file is opened and streamed through the parser. - * @return resource Returns a MIME resource representing the structure, . + * @return resource Returns a MIME resource representing the structure. * @throws MailparseException * */ diff --git a/generated/mbstring.php b/generated/mbstring.php index 6cd8ff4e..f76fe479 100644 --- a/generated/mbstring.php +++ b/generated/mbstring.php @@ -9,7 +9,7 @@ * * @param int $cp * @param string $encoding - * @return string Returns a specific character . + * @return string Returns a specific character. * @throws MbstringException * */ @@ -51,7 +51,7 @@ function mb_chr(int $cp, string $encoding = null): string * For UTF-16, UTF-32, * UCS2 and UCS4, encoding * detection will fail always. - * @return bool|array When setting the encoding detection order, TRUE is returned on success . + * @return bool|array When setting the encoding detection order, TRUE is returned on success. * * When getting the encoding detection order, an ordered array of the encodings is returned. * @throws MbstringException @@ -76,8 +76,7 @@ function mb_detect_order($encoding_list = null) * Returns an array of aliases for a known encoding type. * * @param string $encoding The encoding type being checked, for aliases. - * @return array Returns a numerically indexed array of encoding aliases on success, - * + * @return array Returns a numerically indexed array of encoding aliases on success * @throws MbstringException * */ @@ -120,7 +119,7 @@ function mb_encoding_aliases(string $encoding): array * not used anywhere else. * @param string $string The string being checked. * @param string $option The search option. See mb_regex_set_options for explanation. - * @return string The resultant string on success, . + * @return string The resultant string on success. * @throws MbstringException * */ @@ -144,7 +143,7 @@ function mb_ereg_replace_callback(string $pattern, callable $callback, string $s * @param string $replacement The replacement text. * @param string $string The string being checked. * @param string $option - * @return string The resultant string on success, . + * @return string The resultant string on success. * @throws MbstringException * */ @@ -257,7 +256,7 @@ function mb_ereg_search_setpos(int $position): void * @param string $replace The replacement text. * @param string $string The searched string. * @param string $option - * @return string The resultant string . + * @return string The resultant string. * @throws MbstringException * */ @@ -286,7 +285,7 @@ function mb_eregi_replace(string $pattern, string $replace, string $string, stri * @return string If encoding is omitted, * mb_http_output returns the current HTTP output * character encoding. Otherwise, - * Returns TRUE on success . + * Returns TRUE on success. * @throws MbstringException * */ @@ -314,7 +313,7 @@ function mb_http_output(string $encoding = null) * for string functions defined by the mbstring module. * You should notice that the internal encoding is totally different from the one for multibyte regex. * @return string If encoding is set, then - * Returns TRUE on success . + * Returns TRUE on success. * In this case, the character encoding for multibyte regex is NOT changed. * If encoding is omitted, then * the current character encoding name is returned. @@ -341,7 +340,7 @@ function mb_internal_encoding(string $encoding = null) * * @param string $str * @param string $encoding - * @return int Returns a code point of character . + * @return int Returns a code point of character. * @throws MbstringException * */ diff --git a/generated/misc.php b/generated/misc.php index f625e3bf..41da6ae6 100644 --- a/generated/misc.php +++ b/generated/misc.php @@ -113,7 +113,7 @@ function sapi_windows_cp_set(int $cp): void * If enable is omitted, the function returns TRUE if the stream stream has VT100 control codes enabled, FALSE otherwise. * * If enable is specified, the function will try to enable or disable the VT100 features of the stream stream. - * If the feature has been successfully enabled (or disabled), . + * If the feature has been successfully enabled (or disabled). * * At startup, PHP tries to enable the VT100 feature of the STDOUT/STDERR streams. By the way, if those streams are redirected to a file, the VT100 features may not be enabled. * @@ -143,7 +143,7 @@ function sapi_windows_vt100_support($stream, bool $enable = null): void * * * @param int $seconds Halt time in seconds. - * @return int Returns zero on success, . + * @return int Returns zero on success. * * If the call was interrupted by a signal, sleep returns * a non-zero value. On Windows, this value will always be @@ -171,7 +171,7 @@ function sleep(int $seconds): int * * @param int $seconds Must be a non-negative integer. * @param int $nanoseconds Must be a non-negative integer less than 1 billion. - * @return array Returns TRUE on success . + * @return array Returns TRUE on success. * * If the delay was interrupted by a signal, an associative array will be * returned with the components: diff --git a/generated/msql.php b/generated/msql.php index 1d5010af..331c1b6c 100644 --- a/generated/msql.php +++ b/generated/msql.php @@ -11,7 +11,7 @@ * @param resource $result The result resource that * is being evaluated. This result comes from a call to * msql_query. - * @return int Returns the number of affected rows on success, . + * @return int Returns the number of affected rows on success. * @throws MsqlException * */ @@ -77,7 +77,7 @@ function msql_close($link_identifier = null): void * While this function will accept a colon (:) as a * host/port separator, a comma (,) is the preferred * method. - * @return resource Returns a positive mSQL link identifier on success, . + * @return resource Returns a positive mSQL link identifier on success. * @throws MsqlException * */ @@ -156,7 +156,7 @@ function msql_data_seek($result, int $row_number): void * If not specified, the last link opened by msql_connect * is assumed. If no such link is found, the function will try to establish a * link as if msql_connect was called, and use it. - * @return resource Returns a positive mSQL query identifier to the query result, . + * @return resource Returns a positive mSQL query identifier to the query result. * @throws MsqlException * */ @@ -210,7 +210,7 @@ function msql_drop_db(string $database_name, $link_identifier = null): void * msql_query. * @param int $field_offset The numerical field offset. The * field_offset starts at 1. - * @return int Returns the length of the specified field . + * @return int Returns the length of the specified field. * @throws MsqlException * */ @@ -234,7 +234,7 @@ function msql_field_len($result, int $field_offset): int * msql_query. * @param int $field_offset The numerical field offset. The * field_offset starts at 1. - * @return string The name of the field . + * @return string The name of the field. * @throws MsqlException * */ @@ -280,7 +280,7 @@ function msql_field_seek($result, int $field_offset): void * msql_query. * @param int $field_offset The numerical field offset. The * field_offset starts at 1. - * @return int The name of the table on success . + * @return int The name of the table on success. * @throws MsqlException * */ @@ -365,7 +365,7 @@ function msql_free_result($result): void * If not specified, the connection is established by the means of a Unix * domain socket, being more efficient than a localhost TCP socket * connection. - * @return resource Returns a positive mSQL link identifier on success, . + * @return resource Returns a positive mSQL link identifier on success. * @throws MsqlException * */ @@ -394,7 +394,7 @@ function msql_pconnect(string $hostname = null) * If not specified, the last link opened by msql_connect * is assumed. If no such link is found, the function will try to establish a * link as if msql_connect was called, and use it. - * @return resource Returns a positive mSQL query identifier on success, . + * @return resource Returns a positive mSQL query identifier on success. * @throws MsqlException * */ diff --git a/generated/mssql.php b/generated/mssql.php index 7ad8bceb..234ef56b 100644 --- a/generated/mssql.php +++ b/generated/mssql.php @@ -93,7 +93,7 @@ function mssql_close($link_identifier = null): void * modifies this behavior and makes mssql_connect * always open a new link, even if mssql_connect was * called before with the same parameters. - * @return resource Returns a MS SQL link identifier on success, . + * @return resource Returns a MS SQL link identifier on success. * @throws MssqlException * */ @@ -147,7 +147,7 @@ function mssql_data_seek($result_identifier, int $row_number): void * @param resource $result The result resource that is being evaluated. This result comes from a * call to mssql_query. * @param int $offset The field offset, starts at 0. If omitted, the current field is used. - * @return int The length of the specified field index on success . + * @return int The length of the specified field index on success. * @throws MssqlException * */ @@ -169,7 +169,7 @@ function mssql_field_length($result, int $offset = -1): int * @param resource $result The result resource that is being evaluated. This result comes from a * call to mssql_query. * @param int $offset The field offset, starts at 0. If omitted, the current field is used. - * @return string The name of the specified field index on success . + * @return string The name of the specified field index on success. * @throws MssqlException * */ @@ -212,7 +212,7 @@ function mssql_field_seek($result, int $field_offset): void * @param resource $result The result resource that is being evaluated. This result comes from a * call to mssql_query. * @param int $offset The field offset, starts at 0. If omitted, the current field is used. - * @return string The type of the specified field index on success . + * @return string The type of the specified field index on success. * @throws MssqlException * */ @@ -280,8 +280,7 @@ function mssql_free_statement($stmt): void * @param resource $link_identifier A MS SQL link identifier, returned by * mssql_connect. * @return resource Returns a resource identifier "statement", used in subsequent calls to - * mssql_bind and mssql_execute, - * s. + * mssql_bind and mssql_executes. * @throws MssqlException * */ @@ -327,7 +326,7 @@ function mssql_init(string $sp_name, $link_identifier = null) * mssql_pconnect always open a new link, even if * mssql_pconnect was called before with the same * parameters. - * @return resource Returns a positive MS SQL persistent link identifier on success, . + * @return resource Returns a positive MS SQL persistent link identifier on success. * @throws MssqlException * */ @@ -367,7 +366,7 @@ function mssql_pconnect(string $servername = null, string $username = null, stri * as if mssql_connect was called, and use it. * @param int $batch_size The number of records to batch in the buffer. * @return mixed Returns a MS SQL result resource on success, TRUE if no rows were - * returned, . + * returned. * @throws MssqlException * */ diff --git a/generated/mysql.php b/generated/mysql.php index c73ab4ee..8372992d 100644 --- a/generated/mysql.php +++ b/generated/mysql.php @@ -69,7 +69,7 @@ function mysql_close($link_identifier = null): void * MYSQL_CLIENT_INTERACTIVE. * Read the section about for further information. * In SQL safe mode, this parameter is ignored. - * @return resource Returns a MySQL link identifier on success . + * @return resource Returns a MySQL link identifier on success. * @throws MysqlException * */ @@ -159,7 +159,7 @@ function mysql_data_seek($result, int $row_number): void * @param resource $result The result pointer from a call to mysql_list_dbs. * @param int $row The index into the result set. * @param mixed $field The field name. - * @return string Returns the database name on success, . If FALSE + * @return string Returns the database name on success. If FALSE * is returned, use mysql_error to determine the nature * of the error. * @throws MysqlException @@ -190,8 +190,7 @@ function mysql_db_name($result, int $row, $field = null): string * will try to create one as if mysql_connect had been called * with no arguments. If no connection is found or established, an * E_WARNING level error is generated. - * @return resource Returns a positive MySQL result resource to the query result, - * . The function also returns TRUE/FALSE for + * @return resource Returns a positive MySQL result resource to the query result. The function also returns TRUE/FALSE for * INSERT/UPDATE/DELETE * queries to indicate success/failure. * @throws MysqlException @@ -250,7 +249,7 @@ function mysql_drop_db(string $database_name, $link_identifier = null): void * @param resource $result The result resource that * is being evaluated. This result comes from a call to * mysql_query. - * @return array An array of lengths on success . + * @return array An array of lengths on success. * @throws MysqlException * */ @@ -278,7 +277,7 @@ function mysql_fetch_lengths($result): array * field_offset starts at 0. If * field_offset does not exist, an error of level * E_WARNING is also issued. - * @return string Returns a string of flags associated with the result . + * @return string Returns a string of flags associated with the result. * * The following flags are reported, if your version of MySQL * is current enough to support them: "not_null", @@ -312,7 +311,7 @@ function mysql_field_flags($result, int $field_offset): string * field_offset starts at 0. If * field_offset does not exist, an error of level * E_WARNING is also issued. - * @return int The length of the specified field index on success . + * @return int The length of the specified field index on success. * @throws MysqlException * */ @@ -338,7 +337,7 @@ function mysql_field_len($result, int $field_offset): int * field_offset starts at 0. If * field_offset does not exist, an error of level * E_WARNING is also issued. - * @return string The name of the specified field index on success . + * @return string The name of the specified field index on success. * @throws MysqlException * */ @@ -415,7 +414,7 @@ function mysql_free_result($result): void * with no arguments. If no connection is found or established, an * E_WARNING level error is generated. * @return string Returns a string describing the type of MySQL connection in use for the - * connection . + * connection. * @throws MysqlException * */ @@ -439,7 +438,7 @@ function mysql_get_host_info($link_identifier = null): string * will try to create one as if mysql_connect had been called * with no arguments. If no connection is found or established, an * E_WARNING level error is generated. - * @return int Returns the MySQL protocol on success . + * @return int Returns the MySQL protocol on success. * @throws MysqlException * */ @@ -463,7 +462,7 @@ function mysql_get_proto_info($link_identifier = null): int * will try to create one as if mysql_connect had been called * with no arguments. If no connection is found or established, an * E_WARNING level error is generated. - * @return string Returns the MySQL server version on success . + * @return string Returns the MySQL server version on success. * @throws MysqlException * */ @@ -487,7 +486,7 @@ function mysql_get_server_info($link_identifier = null): string * will try to create one as if mysql_connect had been called * with no arguments. If no connection is found or established, an * E_WARNING level error is generated. - * @return string Returns information about the statement on success, . See the example below for which statements provide information, + * @return string Returns information about the statement on success. See the example below for which statements provide information, * and what the returned value may look like. Statements that are not listed * will return FALSE. * @throws MysqlException @@ -514,7 +513,7 @@ function mysql_info($link_identifier = null): string * will try to create one as if mysql_connect had been called * with no arguments. If no connection is found or established, an * E_WARNING level error is generated. - * @return resource Returns a result pointer resource on success, . Use the mysql_tablename function to traverse + * @return resource Returns a result pointer resource on success. Use the mysql_tablename function to traverse * this result pointer, or any function for result tables, such as * mysql_fetch_array. * @throws MysqlException @@ -546,7 +545,7 @@ function mysql_list_dbs($link_identifier = null) * will try to create one as if mysql_connect had been called * with no arguments. If no connection is found or established, an * E_WARNING level error is generated. - * @return resource A result pointer resource on success, . + * @return resource A result pointer resource on success. * * The returned result can be used with mysql_field_flags, * mysql_field_len, @@ -575,7 +574,7 @@ function mysql_list_fields(string $database_name, string $table_name, $link_iden * will try to create one as if mysql_connect had been called * with no arguments. If no connection is found or established, an * E_WARNING level error is generated. - * @return resource A result pointer resource on success . + * @return resource A result pointer resource on success. * @throws MysqlException * */ @@ -604,7 +603,7 @@ function mysql_list_processes($link_identifier = null) * will try to create one as if mysql_connect had been called * with no arguments. If no connection is found or established, an * E_WARNING level error is generated. - * @return resource A result pointer resource on success . + * @return resource A result pointer resource on success. * * Use the mysql_tablename function to * traverse this result pointer, or any function for result tables, @@ -630,7 +629,7 @@ function mysql_list_tables(string $database, $link_identifier = null) * is being evaluated. This result comes from a call to * mysql_query. * @return int Returns the number of fields in the result set resource on - * success . + * success. * @throws MysqlException * */ @@ -654,7 +653,7 @@ function mysql_num_fields($result): int * @param resource $result The result resource that * is being evaluated. This result comes from a call to * mysql_query. - * @return int The number of rows in a result set on success . + * @return int The number of rows in a result set on success. * @throws MysqlException * */ @@ -687,11 +686,10 @@ function mysql_num_rows($result): int * E_WARNING level error is generated. * @return resource For SELECT, SHOW, DESCRIBE, EXPLAIN and other statements returning resultset, * mysql_query - * returns a resource on success, . + * returns a resource on success. * * For other type of SQL statements, INSERT, UPDATE, DELETE, DROP, etc, - * mysql_query returns TRUE on success - * . + * mysql_query returns TRUE on success. * * The returned result resource should be passed to * mysql_fetch_array, and other @@ -742,7 +740,7 @@ function mysql_query(string $query, $link_identifier = null) * will try to create one as if mysql_connect had been called * with no arguments. If no connection is found or established, an * E_WARNING level error is generated. - * @return string Returns the escaped string, . + * @return string Returns the escaped string. * @throws MysqlException * */ @@ -779,7 +777,7 @@ function mysql_real_escape_string(string $unescaped_string, $link_identifier = n * dot field name (tablename.fieldname). If the column name has been * aliased ('select foo as bar from...'), use the alias instead of the * column name. If undefined, the first field is retrieved. - * @return string The contents of one cell from a MySQL result set on success, . + * @return string The contents of one cell from a MySQL result set on success. * @throws MysqlException * */ @@ -852,7 +850,7 @@ function mysql_set_charset(string $charset, $link_identifier = null): void * @param resource $result A result pointer resource that's returned from * mysql_list_tables. * @param int $i The integer index (row/table number) - * @return string The name of the table on success . + * @return string The name of the table on success. * * Use the mysql_tablename function to * traverse this result pointer, or any function for result tables, @@ -882,7 +880,7 @@ function mysql_tablename($result, int $i): string * will try to create one as if mysql_connect had been called * with no arguments. If no connection is found or established, an * E_WARNING level error is generated. - * @return int The thread ID on success . + * @return int The thread ID on success. * @throws MysqlException * */ @@ -922,11 +920,10 @@ function mysql_thread_id($link_identifier = null): int * E_WARNING level error is generated. * @return resource For SELECT, SHOW, DESCRIBE or EXPLAIN statements, * mysql_unbuffered_query - * returns a resource on success, . + * returns a resource on success. * * For other type of SQL statements, UPDATE, DELETE, DROP, etc, - * mysql_unbuffered_query returns TRUE on success - * . + * mysql_unbuffered_query returns TRUE on success. * @throws MysqlException * */ diff --git a/generated/mysqlndQc.php b/generated/mysqlndQc.php index a888670a..9a99a379 100644 --- a/generated/mysqlndQc.php +++ b/generated/mysqlndQc.php @@ -57,7 +57,7 @@ function mysqlnd_qc_clear_cache(): void * offers the same capabilities. * * @param string $callback - * @return mixed Returns TRUE on success . + * @return mixed Returns TRUE on success. * @throws MysqlndQcException * */ diff --git a/generated/network.php b/generated/network.php index b97804f8..37711b41 100644 --- a/generated/network.php +++ b/generated/network.php @@ -58,8 +58,7 @@ function closelog(): void * Additional Records. * @param bool $raw In case of raw mode, we query only the requested type instead of looping * type by type before going with the additional info stuff. - * @return array This function returns an array of associative arrays, - * . Each associative array contains + * @return array This function returns an array of associative arrays. Each associative array contains * at minimum the following keys: * * Basic DNS attributes @@ -322,7 +321,7 @@ function fsockopen(string $hostname, int $port = -1, ?int &$errno = null, ?strin * /etc/protocols. * * @param string $name The protocol name. - * @return int Returns the protocol number, . + * @return int Returns the protocol number. * @throws NetworkException * */ @@ -343,7 +342,7 @@ function getprotobyname(string $name): int * /etc/protocols. * * @param int $number The protocol number. - * @return string Returns the protocol name as a string, . + * @return string Returns the protocol name as a string. * @throws NetworkException * */ @@ -384,7 +383,7 @@ function header_register_callback(callable $callback): void * * * @param string $in_addr A 32bit IPv4, or 128bit IPv6 address. - * @return string Returns a string representation of the address . + * @return string Returns a string representation of the address. * @throws NetworkException * */ diff --git a/generated/oci8.php b/generated/oci8.php index 3c7c6858..70b93af8 100644 --- a/generated/oci8.php +++ b/generated/oci8.php @@ -485,7 +485,7 @@ function oci_commit($connection): void * * OCI_CRED_EXT is not supported on Windows for * security reasons. - * @return resource Returns a connection identifier . + * @return resource Returns a connection identifier. * @throws Oci8Exception * */ @@ -719,7 +719,7 @@ function oci_execute($statement, int $mode = OCI_COMMIT_ON_SUCCESS): void * should use column aliases. Otherwise only one of the columns * will appear in an associative array. * @return int Returns the number of rows in output, which - * may be 0 or more, . + * may be 0 or more. * @throws Oci8Exception * */ @@ -739,7 +739,7 @@ function oci_fetch_all($statement, ?array &$output, int $skip = 0, int $maxrows * * @param resource $statement A valid OCI statement identifier. * @param mixed $field Can be the field's index (1-based) or name. - * @return string Returns the name as a string, s. + * @return string Returns the name as a strings. * @throws Oci8Exception * */ @@ -763,7 +763,7 @@ function oci_field_name($statement, $field): string * * @param resource $statement A valid OCI statement identifier. * @param mixed $field Can be the field's index (1-based) or name. - * @return int Returns the precision as an integer, s. + * @return int Returns the precision as an integers. * @throws Oci8Exception * */ @@ -787,7 +787,7 @@ function oci_field_precision($statement, $field): int * * @param resource $statement A valid OCI statement identifier. * @param mixed $field Can be the field's index (1-based) or name. - * @return int Returns the scale as an integer, s. + * @return int Returns the scale as an integers. * @throws Oci8Exception * */ @@ -807,7 +807,7 @@ function oci_field_scale($statement, $field): int * * @param resource $statement A valid OCI statement identifier. * @param mixed $field Can be the field's index (1-based) or name. - * @return int Returns the size of a field in bytes, s. + * @return int Returns the size of a field in bytess. * @throws Oci8Exception * */ @@ -829,7 +829,7 @@ function oci_field_size($statement, $field): int * * @param resource $statement A valid OCI statement identifier. * @param mixed $field Can be the field's index (1-based) or name. - * @return int Returns Oracle's raw data type as a number, s. + * @return int Returns Oracle's raw data type as a numbers. * @throws Oci8Exception * */ @@ -849,7 +849,7 @@ function oci_field_type_raw($statement, $field): int * * @param resource $statement A valid OCI statement identifier. * @param mixed $field Can be the field's index (1-based) or name. - * @return mixed Returns the field data type as a string, s. + * @return mixed Returns the field data type as a strings. * @throws Oci8Exception * */ @@ -908,7 +908,7 @@ function oci_free_statement($statement): void * @param string $tdo Should be a valid named type (uppercase). * @param string $schema Should point to the scheme, where the named type was created. The name * of the current user is the default value. - * @return \OCI-Collection Returns a new OCICollection object . + * @return \OCI-Collection Returns a new OCICollection object. * @throws Oci8Exception * */ @@ -1007,7 +1007,7 @@ function oci_new_collection($connection, string $tdo, string $schema = null) * * OCI_CRED_EXT is not supported on Windows for * security reasons. - * @return resource Returns a connection identifier . + * @return resource Returns a connection identifier. * @throws Oci8Exception * */ @@ -1035,7 +1035,7 @@ function oci_new_connect(string $username, string $password, string $connection_ * * @param resource $connection An Oracle connection identifier, returned by * oci_connect or oci_pconnect. - * @return resource Returns a new statement handle, . + * @return resource Returns a new statement handle. * @throws Oci8Exception * */ @@ -1077,7 +1077,7 @@ function oci_new_descriptor($connection, int $type = OCI_DTYPE_LOB) * Gets the number of columns in the given statement. * * @param resource $statement A valid OCI statement identifier. - * @return int Returns the number of columns as an integer, s. + * @return int Returns the number of columns as an integers. * @throws Oci8Exception * */ @@ -1096,7 +1096,7 @@ function oci_num_fields($statement): int * Gets the number of rows affected during statement execution. * * @param resource $statement A valid OCI statement identifier. - * @return int Returns the number of rows affected as an integer, s. + * @return int Returns the number of rows affected as an integers. * @throws Oci8Exception * */ @@ -1129,7 +1129,7 @@ function oci_num_rows($statement): int * semi-colon (";"). PL/SQL * statements should end with a semi-colon * (";"). - * @return resource Returns a statement handle on success, . + * @return resource Returns a statement handle on success. * @throws Oci8Exception * */ @@ -1228,7 +1228,7 @@ function oci_parse($connection, string $sql_text) * * OCI_CRED_EXT is not supported on Windows for * security reasons. - * @return resource Returns a connection identifier . + * @return resource Returns a connection identifier. * @throws Oci8Exception * */ @@ -1317,7 +1317,7 @@ function oci_rollback($connection): void * Returns a string with the Oracle Database version and available options * * @param resource $connection - * @return string Returns the version information as a string . + * @return string Returns the version information as a string. * @throws Oci8Exception * */ diff --git a/generated/opcache.php b/generated/opcache.php index c3d8f072..04a58205 100644 --- a/generated/opcache.php +++ b/generated/opcache.php @@ -27,8 +27,7 @@ function opcache_compile_file(string $file): void * This function returns state information about the cache instance * * @param bool $get_scripts Include script specific state information - * @return array Returns an array of information, optionally containing script specific state information, - * . + * @return array Returns an array of information, optionally containing script specific state information. * @throws OpcacheException * */ diff --git a/generated/openssl.php b/generated/openssl.php index 709cce1f..d09718bb 100644 --- a/generated/openssl.php +++ b/generated/openssl.php @@ -8,7 +8,7 @@ * Gets the cipher initialization vector (iv) length. * * @param string $method The cipher method, see openssl_get_cipher_methods for a list of potential values. - * @return int Returns the cipher length on success, . + * @return int Returns the cipher length on success. * @throws OpensslException * */ @@ -84,7 +84,7 @@ function openssl_csr_export($csr, ?string &$out, bool $notext = true): void * array - if shortnames is TRUE (the default) then * fields will be indexed with the short name form, otherwise, the long name * form will be used - e.g.: CN is the shortname form of commonName. - * @return array Returns TRUE on success . + * @return array Returns TRUE on success. * @throws OpensslException * */ @@ -205,7 +205,7 @@ function openssl_csr_get_subject($csr, bool $use_shortnames = true): array * configuration options for the CSR. Both dn and * extraattribs are associative arrays whose keys are * converted to OIDs and applied to the relevant part of the request. - * @return resource Returns the CSR . + * @return resource Returns the CSR. * @throws OpensslException * */ @@ -280,7 +280,7 @@ function openssl_csr_sign($csr, $cacert, $priv_key, int $days, array $configargs * @param string $iv A non-NULL Initialization Vector. * @param string $tag The authentication tag in AEAD cipher mode. If it is incorrect, the authentication fails and the function returns FALSE. * @param string $aad Additional authentication data. - * @return string The decrypted string on success . + * @return string The decrypted string on success. * @throws OpensslException * */ @@ -302,7 +302,7 @@ function openssl_decrypt(string $data, string $method, string $key, int $options * * @param string $pub_key DH Public key of the remote party. * @param resource $dh_key A local DH private key, corresponding to the public key to be shared with the remote party. - * @return string Returns shared secret on success . + * @return string Returns shared secret on success. * @throws OpensslException * */ @@ -325,7 +325,7 @@ function openssl_dh_compute_key(string $pub_key, $dh_key): string * @param string $method The digest method to use, e.g. "sha256", see openssl_get_md_methods for a list of available digest methods. * @param bool $raw_output Setting to TRUE will return as raw output data, otherwise the return * value is binhex encoded. - * @return string Returns the digested hash value on success . + * @return string Returns the digested hash value on success. * @throws OpensslException * */ @@ -354,7 +354,7 @@ function openssl_digest(string $data, string $method, bool $raw_output = false): * @param string $tag The authentication tag passed by reference when using AEAD cipher mode (GCM or CCM). * @param string $aad Additional authentication data. * @param int $tag_length The length of the authentication tag. Its value can be between 4 and 16 for GCM mode. - * @return string Returns the encrypted string on success . + * @return string Returns the encrypted string on success. * @throws OpensslException * */ @@ -413,7 +413,7 @@ function openssl_open(string $sealed_data, ?string &$open_data, string $env_key, * @param int $iterations The number of iterations desired. NIST * recommends at least 10,000. * @param string $digest_algorithm Optional hash or digest algorithm from openssl_get_md_methods. Defaults to SHA-1. - * @return string Returns raw binary string . + * @return string Returns raw binary string. * @throws OpensslException * */ @@ -739,7 +739,7 @@ function openssl_pkey_export($key, ?string &$out, string $passphrase = null, arr * * @param string $passphrase The optional parameter passphrase must be used * if the specified key is encrypted (protected by a passphrase). - * @return resource Returns a positive key resource identifier on success, . + * @return resource Returns a positive key resource identifier on success. * @throws OpensslException * */ @@ -769,7 +769,7 @@ function openssl_pkey_get_private($key, string $passphrase = "") * * A PEM formatted public key. * - * @return resource Returns a positive key resource identifier on success, . + * @return resource Returns a positive key resource identifier on success. * @throws OpensslException * */ @@ -793,7 +793,7 @@ function openssl_pkey_get_public($certificate) * bits) using configargs. See * openssl_csr_new for more information about * configargs. - * @return resource Returns a resource identifier for the pkey on success, . + * @return resource Returns a resource identifier for the pkey on success. * @throws OpensslException * */ @@ -943,7 +943,7 @@ function openssl_public_encrypt(string $data, ?string &$crypted, $key, int $padd * @param bool $crypto_strong If passed into the function, this will hold a boolean value that determines * if the algorithm used was "cryptographically strong", e.g., safe for usage with GPG, * passwords, etc. TRUE if it did, otherwise FALSE - * @return string Returns the generated string of bytes on success, . + * @return string Returns the generated string of bytes on success. * @throws OpensslException * */ @@ -975,7 +975,7 @@ function openssl_random_pseudo_bytes(int $length, ?bool &$crypto_strong = null): * @param array $pub_key_ids Array of public key resource identifiers. * @param string $method The cipher method. * @param string $iv The initialization vector. - * @return int Returns the length of the sealed data on success, . + * @return int Returns the length of the sealed data on success. * If successful the sealed data is returned in * sealed_data, and the envelope keys in * env_keys. @@ -1102,7 +1102,7 @@ function openssl_x509_fingerprint($x509, string $hash_algorithm = "sha1", bool $ * it. * * @param string|resource $x509certdata X509 certificate. See Key/Certificate parameters for a list of valid values. - * @return resource Returns a resource identifier on success . + * @return resource Returns a resource identifier on success. * @throws OpensslException * */ diff --git a/generated/password.php b/generated/password.php index f4d3e494..5850b649 100644 --- a/generated/password.php +++ b/generated/password.php @@ -24,7 +24,7 @@ * * PASSWORD_BCRYPT - Use the CRYPT_BLOWFISH algorithm to * create the hash. This will produce a standard crypt compatible hash using - * the "$2y$" identifier. The result will always be a 60 character string, . + * the "$2y$" identifier. The result will always be a 60 character string. * * * @@ -102,7 +102,7 @@ * * If omitted, a random salt will be created and the default cost will be * used. - * @return string Returns the hashed password, . + * @return string Returns the hashed password. * * The used algorithm, cost and salt are returned as part of the hash. Therefore, * all information that's needed to verify the hash is included in it. This allows diff --git a/generated/pcntl.php b/generated/pcntl.php index 03030f3b..89632863 100644 --- a/generated/pcntl.php +++ b/generated/pcntl.php @@ -45,8 +45,7 @@ function pcntl_exec(string $path, array $args = null, array $envs = null): void * @param int $pid If not specified, the pid of the current process is used. * @param int $process_identifier One of PRIO_PGRP, PRIO_USER * or PRIO_PROCESS. - * @return int pcntl_getpriority returns the priority of the process - * . A lower numerical value causes more favorable + * @return int pcntl_getpriority returns the priority of the process. A lower numerical value causes more favorable * scheduling. * @throws PcntlException * @@ -152,7 +151,7 @@ function pcntl_sigprocmask(int $how, array $set, ?array &$oldset = null): void * * * @param int $errno - * @return string Returns error description on success . + * @return string Returns error description on success. * @throws PcntlException * */ diff --git a/generated/pcre.php b/generated/pcre.php index 34b91fbb..d61f9f8d 100644 --- a/generated/pcre.php +++ b/generated/pcre.php @@ -343,8 +343,7 @@ * * * The above example will output: - * @return int Returns the number of full pattern matches (which might be zero), - * . + * @return int Returns the number of full pattern matches (which might be zero). * @throws PcreException * */ @@ -581,7 +580,7 @@ function preg_match_all(string $pattern, string $subject, array &$matches = null * * The above example will output: * @return int preg_match returns 1 if the pattern - * matches given subject, 0 if it does not, . + * matches given subject, 0 if it does not. * @throws PcreException * */ @@ -647,7 +646,7 @@ function preg_match(string $pattern, string $subject, array &$matches = null, in * matched string at offset 0 and its string offset * into subject at offset 1. * @return array Returns an array containing substrings of subject - * split along boundaries matched by pattern, . + * split along boundaries matched by pattern. * @throws PcreException * */ diff --git a/generated/pdf.php b/generated/pdf.php index 19c9b626..d039b27a 100644 --- a/generated/pdf.php +++ b/generated/pdf.php @@ -6,7 +6,7 @@ /** * Activates a previously created structure element or other content item. - * Returns TRUE on success . + * Returns TRUE on success. * * @param resource $pdfdoc * @param int $id @@ -25,7 +25,7 @@ function PDF_activate_item($pdfdoc, int $id): void /** * Add a link annotation to a target within the current PDF file. - * Returns TRUE on success . + * Returns TRUE on success. * * This function is deprecated since PDFlib version 6, use * PDF_create_action with type=GoTo @@ -54,7 +54,7 @@ function PDF_add_locallink($pdfdoc, float $lowerleftx, float $lowerlefty, float /** * Creates a named destination on an arbitrary page in the current document. - * Returns TRUE on success . + * Returns TRUE on success. * * @param resource $pdfdoc * @param string $name @@ -73,7 +73,7 @@ function PDF_add_nameddest($pdfdoc, string $name, string $optlist): void /** - * Sets an annotation for the current page. Returns TRUE on success . + * Sets an annotation for the current page. Returns TRUE on success. * * This function is deprecated since PDFlib version 6, use * PDF_create_annotation with @@ -103,7 +103,7 @@ function PDF_add_note($pdfdoc, float $llx, float $lly, float $urx, float $ury, s /** * Add a file link annotation to a PDF target. - * Returns TRUE on success . + * Returns TRUE on success. * * This function is deprecated since PDFlib version 6, use * PDF_create_action with @@ -134,7 +134,7 @@ function PDF_add_pdflink($pdfdoc, float $bottom_left_x, float $bottom_left_y, fl /** * Adds an existing image as thumbnail for the current page. - * Returns TRUE on success . + * Returns TRUE on success. * * @param resource $pdfdoc * @param int $image @@ -153,7 +153,7 @@ function PDF_add_thumbnail($pdfdoc, int $image): void /** * Adds a weblink annotation to a target url on the Web. - * Returns TRUE on success . + * Returns TRUE on success. * * This function is deprecated since PDFlib version 6, use * PDF_create_action with type=URI @@ -180,7 +180,7 @@ function PDF_add_weblink($pdfdoc, float $lowerleftx, float $lowerlefty, float $u /** - * Adds a file attachment annotation. Returns TRUE on success . + * Adds a file attachment annotation. Returns TRUE on success. * * This function is deprecated since PDFlib version 6, use * PDF_create_annotation with @@ -210,7 +210,7 @@ function PDF_attach_file($pdfdoc, float $llx, float $lly, float $urx, float $ury /** - * Starts a layer for subsequent output on the page. Returns TRUE on success . + * Starts a layer for subsequent output on the page. Returns TRUE on success. * * This function requires PDF 1.5. * @@ -232,7 +232,7 @@ function PDF_begin_layer($pdfdoc, int $layer): void /** * Adds a new page to the document, and specifies various options. * The parameters width and height - * are the dimensions of the new page in points. Returns TRUE on success . + * are the dimensions of the new page in points. Returns TRUE on success. * * * Common Page Sizes in Points @@ -314,7 +314,7 @@ function PDF_begin_page_ext($pdfdoc, float $width, float $height, string $optlis /** - * Adds a new page to the document. Returns TRUE on success . + * Adds a new page to the document. Returns TRUE on success. * * This function is deprecated since PDFlib version 6, use * PDF_begin_page_ext instead. @@ -336,7 +336,7 @@ function PDF_begin_page($pdfdoc, float $width, float $height): void /** - * Adds a circle. Returns TRUE on success . + * Adds a circle. Returns TRUE on success. * * @param resource $pdfdoc * @param float $x @@ -356,7 +356,7 @@ function PDF_circle($pdfdoc, float $x, float $y, float $r): void /** - * Uses the current path as clipping path, and terminate the path. Returns TRUE on success . + * Uses the current path as clipping path, and terminate the path. Returns TRUE on success. * * @param resource $p * @throws PdfException @@ -373,7 +373,7 @@ function PDF_clip($p): void /** - * Closes the page handle, and frees all page-related resources. Returns TRUE on success . + * Closes the page handle, and frees all page-related resources. Returns TRUE on success. * * @param resource $p * @param int $page @@ -391,7 +391,7 @@ function PDF_close_pdi_page($p, int $page): void /** - * Closes all open page handles, and closes the input PDF document. Returns TRUE on success . + * Closes all open page handles, and closes the input PDF document. Returns TRUE on success. * * This function is deprecated since PDFlib version 7, * use PDF_close_pdi_document instead. @@ -413,7 +413,7 @@ function PDF_close_pdi($p, int $doc): void /** * Closes the generated PDF file, and frees all document-related resources. - * Returns TRUE on success . + * Returns TRUE on success. * * This function is deprecated since PDFlib version 6, use * PDF_end_document instead. @@ -433,7 +433,7 @@ function PDF_close($p): void /** - * Closes the path, fills, and strokes it. Returns TRUE on success . + * Closes the path, fills, and strokes it. Returns TRUE on success. * * @param resource $p * @throws PdfException @@ -450,7 +450,7 @@ function PDF_closepath_fill_stroke($p): void /** - * Closes the path, and strokes it. Returns TRUE on success . + * Closes the path, and strokes it. Returns TRUE on success. * * @param resource $p * @throws PdfException @@ -467,7 +467,7 @@ function PDF_closepath_stroke($p): void /** - * Closes the current path. Returns TRUE on success . + * Closes the current path. Returns TRUE on success. * * @param resource $p * @throws PdfException @@ -484,7 +484,7 @@ function PDF_closepath($p): void /** - * Concatenates a matrix to the current transformation matrix (CTM). Returns TRUE on success . + * Concatenates a matrix to the current transformation matrix (CTM). Returns TRUE on success. * * @param resource $p * @param float $a @@ -507,7 +507,7 @@ function PDF_concat($p, float $a, float $b, float $c, float $d, float $e, float /** - * Prints text at the next line. Returns TRUE on success . + * Prints text at the next line. Returns TRUE on success. * * @param resource $p * @param string $text @@ -526,7 +526,7 @@ function PDF_continue_text($p, string $text): void /** * Draws a Bezier curve from the current point, using 3 more control points. - * Returns TRUE on success . + * Returns TRUE on success. * * @param resource $p * @param float $x1 @@ -549,7 +549,7 @@ function PDF_curveto($p, float $x1, float $y1, float $x2, float $y2, float $x3, /** - * Deletes a PDFlib object, and frees all internal resources. Returns TRUE on success . + * Deletes a PDFlib object, and frees all internal resources. Returns TRUE on success. * * @param resource $pdfdoc * @throws PdfException @@ -566,7 +566,7 @@ function PDF_delete($pdfdoc): void /** - * Deactivates all active layers. Returns TRUE on success . + * Deactivates all active layers. Returns TRUE on success. * * This function requires PDF 1.5. * @@ -585,7 +585,7 @@ function PDF_end_layer($pdfdoc): void /** - * Finishes a page, and applies various options. Returns TRUE on success . + * Finishes a page, and applies various options. Returns TRUE on success. * * @param resource $pdfdoc * @param string $optlist @@ -603,7 +603,7 @@ function PDF_end_page_ext($pdfdoc, string $optlist): void /** - * Finishes the page. Returns TRUE on success . + * Finishes the page. Returns TRUE on success. * * @param resource $p * @throws PdfException @@ -620,7 +620,7 @@ function PDF_end_page($p): void /** - * Finishes the pattern definition. Returns TRUE on success . + * Finishes the pattern definition. Returns TRUE on success. * * @param resource $p * @throws PdfException @@ -637,7 +637,7 @@ function PDF_end_pattern($p): void /** - * Finishes a template definition. Returns TRUE on success . + * Finishes a template definition. Returns TRUE on success. * * @param resource $p * @throws PdfException @@ -655,7 +655,7 @@ function PDF_end_template($p): void /** * Fills and strokes the current path with the current fill and stroke color. - * Returns TRUE on success . + * Returns TRUE on success. * * @param resource $p * @throws PdfException @@ -673,7 +673,7 @@ function PDF_fill_stroke($p): void /** * Fills the interior of the current path with the current fill color. - * Returns TRUE on success . + * Returns TRUE on success. * * @param resource $p * @throws PdfException @@ -691,7 +691,7 @@ function PDF_fill($p): void /** * Places an image or template on the page, subject to various options. - * Returns TRUE on success . + * Returns TRUE on success. * * @param resource $pdfdoc * @param int $image @@ -713,7 +713,7 @@ function PDF_fit_image($pdfdoc, int $image, float $x, float $y, string $optlist) /** * Places an imported PDF page on the page, subject to various options. - * Returns TRUE on success . + * Returns TRUE on success. * * @param resource $pdfdoc * @param int $page @@ -734,7 +734,7 @@ function PDF_fit_pdi_page($pdfdoc, int $page, float $x, float $y, string $optlis /** - * Places a single line of text on the page, subject to various options. Returns TRUE on success . + * Places a single line of text on the page, subject to various options. Returns TRUE on success. * * @param resource $pdfdoc * @param string $text @@ -756,7 +756,7 @@ function PDF_fit_textline($pdfdoc, string $text, float $x, float $y, string $opt /** * Reset all color and graphics state parameters to their defaults. - * Returns TRUE on success . + * Returns TRUE on success. * * @param resource $p * @throws PdfException @@ -773,7 +773,7 @@ function PDF_initgraphics($p): void /** - * Draws a line from the current point to another point. Returns TRUE on success . + * Draws a line from the current point to another point. Returns TRUE on success. * * @param resource $p * @param float $x @@ -793,7 +793,7 @@ function PDF_lineto($p, float $x, float $y): void /** * Finds a built-in spot color name, or makes a named spot color from the - * current fill color. Returns TRUE on success . + * current fill color. Returns TRUE on success. * * @param resource $p * @param string $spotname @@ -813,7 +813,7 @@ function PDF_makespotcolor($p, string $spotname): int /** - * Sets the current point for graphics output. Returns TRUE on success . + * Sets the current point for graphics output. Returns TRUE on success. * * @param resource $p * @param float $x @@ -833,7 +833,7 @@ function PDF_moveto($p, float $x, float $y): void /** * Creates a new PDF file using the supplied file name. - * Returns TRUE on success . + * Returns TRUE on success. * * This function is deprecated since PDFlib version 6, use * PDF_begin_document instead. @@ -854,7 +854,7 @@ function PDF_open_file($p, string $filename): void /** - * Places an image and scales it. Returns TRUE on success . + * Places an image and scales it. Returns TRUE on success. * * This function is deprecated since PDFlib version 5, use * PDF_fit_image instead. @@ -878,7 +878,7 @@ function PDF_place_image($pdfdoc, int $image, float $x, float $y, float $scale): /** - * Places a PDF page and scales it. Returns TRUE on success . + * Places a PDF page and scales it. Returns TRUE on success. * * This function is deprecated since PDFlib version 5, use * PDF_fit_pdi_page instead. @@ -903,7 +903,7 @@ function PDF_place_pdi_page($pdfdoc, int $page, float $x, float $y, float $sx, f /** - * Draws a rectangle. Returns TRUE on success . + * Draws a rectangle. Returns TRUE on success. * * @param resource $p * @param float $x @@ -924,7 +924,7 @@ function PDF_rect($p, float $x, float $y, float $width, float $height): void /** - * Restores the most recently saved graphics state. Returns TRUE on success . + * Restores the most recently saved graphics state. Returns TRUE on success. * * @param resource $p * @throws PdfException @@ -941,7 +941,7 @@ function PDF_restore($p): void /** - * Rotates the coordinate system. Returns TRUE on success . + * Rotates the coordinate system. Returns TRUE on success. * * @param resource $p * @param float $phi @@ -959,7 +959,7 @@ function PDF_rotate($p, float $phi): void /** - * Saves the current graphics state. Returns TRUE on success . + * Saves the current graphics state. Returns TRUE on success. * * @param resource $p * @throws PdfException @@ -976,7 +976,7 @@ function PDF_save($p): void /** - * Scales the coordinate system. Returns TRUE on success . + * Scales the coordinate system. Returns TRUE on success. * * @param resource $p * @param float $sx @@ -995,7 +995,7 @@ function PDF_scale($p, float $sx, float $sy): void /** - * Sets the border color for all kinds of annotations. Returns TRUE on success . + * Sets the border color for all kinds of annotations. Returns TRUE on success. * * This function is deprecated since PDFlib version 6, use * the option annotcolor in @@ -1019,7 +1019,7 @@ function PDF_set_border_color($p, float $red, float $green, float $blue): void /** - * Sets the border dash style for all kinds of annotations. Returns TRUE on success . + * Sets the border dash style for all kinds of annotations. Returns TRUE on success. * * This function is deprecated since PDFlib version 6, use * the option dasharray in @@ -1042,7 +1042,7 @@ function PDF_set_border_dash($pdfdoc, float $black, float $white): void /** - * Sets the border style for all kinds of annotations. Returns TRUE on success . + * Sets the border style for all kinds of annotations. Returns TRUE on success. * * This function is deprecated since PDFlib version 6, use * the options borderstyle and @@ -1067,7 +1067,7 @@ function PDF_set_border_style($pdfdoc, string $style, float $width): void /** * Fill document information field key with - * value. Returns TRUE on success . + * value. Returns TRUE on success. * * @param resource $p * @param string $key @@ -1086,7 +1086,7 @@ function PDF_set_info($p, string $key, string $value): void /** - * Defines hierarchical and group relationships among layers. Returns TRUE on success . + * Defines hierarchical and group relationships among layers. Returns TRUE on success. * * This function requires PDF 1.5. * @@ -1107,7 +1107,7 @@ function PDF_set_layer_dependency($pdfdoc, string $type, string $optlist): void /** - * Sets some PDFlib parameter with string type. Returns TRUE on success . + * Sets some PDFlib parameter with string type. Returns TRUE on success. * * @param resource $p * @param string $key @@ -1126,7 +1126,7 @@ function PDF_set_parameter($p, string $key, string $value): void /** - * Sets the position for text output on the page. Returns TRUE on success . + * Sets the position for text output on the page. Returns TRUE on success. * * @param resource $p * @param float $x @@ -1145,7 +1145,7 @@ function PDF_set_text_pos($p, float $x, float $y): void /** - * Sets the value of some PDFlib parameter with numerical type. Returns TRUE on success . + * Sets the value of some PDFlib parameter with numerical type. Returns TRUE on success. * * @param resource $p * @param string $key @@ -1164,7 +1164,7 @@ function PDF_set_value($p, string $key, float $value): void /** - * Sets the current color space and color. Returns TRUE on success . + * Sets the current color space and color. Returns TRUE on success. * * @param resource $p * @param string $fstype @@ -1188,7 +1188,7 @@ function PDF_setcolor($p, string $fstype, string $colorspace, float $c1, float $ /** * Sets the current dash pattern to b black - * and w white units. Returns TRUE on success . + * and w white units. Returns TRUE on success. * * @param resource $pdfdoc * @param float $b @@ -1207,7 +1207,7 @@ function PDF_setdash($pdfdoc, float $b, float $w): void /** - * Sets a dash pattern defined by an option list. Returns TRUE on success . + * Sets a dash pattern defined by an option list. Returns TRUE on success. * * @param resource $pdfdoc * @param string $optlist @@ -1225,7 +1225,7 @@ function PDF_setdashpattern($pdfdoc, string $optlist): void /** - * Sets the flatness parameter. Returns TRUE on success . + * Sets the flatness parameter. Returns TRUE on success. * * @param resource $pdfdoc * @param float $flatness @@ -1245,7 +1245,7 @@ function PDF_setflat($pdfdoc, float $flatness): void /** * Sets the current font in the specified fontsize, using a * font handle returned by PDF_load_font. - * Returns TRUE on success . + * Returns TRUE on success. * * @param resource $pdfdoc * @param int $font @@ -1265,7 +1265,7 @@ function PDF_setfont($pdfdoc, int $font, float $fontsize): void /** * Sets the current fill color to a gray value between 0 and 1 inclusive. - * Returns TRUE on success . + * Returns TRUE on success. * * This function is deprecated since PDFlib version 4, use * PDF_setcolor instead. @@ -1287,7 +1287,7 @@ function PDF_setgray_fill($p, float $g): void /** * Sets the current stroke color to a gray value between 0 and 1 inclusive. - * Returns TRUE on success . + * Returns TRUE on success. * * This function is deprecated since PDFlib version 4, use * PDF_setcolor instead. @@ -1308,7 +1308,7 @@ function PDF_setgray_stroke($p, float $g): void /** - * Sets the current fill and stroke color to a gray value between 0 and 1 inclusive. Returns TRUE on success . + * Sets the current fill and stroke color to a gray value between 0 and 1 inclusive. Returns TRUE on success. * * This function is deprecated since PDFlib version 4, use * PDF_setcolor instead. @@ -1330,7 +1330,7 @@ function PDF_setgray($p, float $g): void /** * Sets the linejoin parameter to specify the shape - * at the corners of paths that are stroked. Returns TRUE on success . + * at the corners of paths that are stroked. Returns TRUE on success. * * @param resource $p * @param int $value @@ -1348,7 +1348,7 @@ function PDF_setlinejoin($p, int $value): void /** - * Sets the current line width. Returns TRUE on success . + * Sets the current line width. Returns TRUE on success. * * @param resource $p * @param float $width @@ -1366,7 +1366,7 @@ function PDF_setlinewidth($p, float $width): void /** - * Explicitly sets the current transformation matrix. Returns TRUE on success . + * Explicitly sets the current transformation matrix. Returns TRUE on success. * * @param resource $p * @param float $a @@ -1389,7 +1389,7 @@ function PDF_setmatrix($p, float $a, float $b, float $c, float $d, float $e, flo /** - * Sets the miter limit.Returns TRUE on success . + * Sets the miter limit.Returns TRUE on success. * * @param resource $pdfdoc * @param float $miter @@ -1407,7 +1407,7 @@ function PDF_setmiterlimit($pdfdoc, float $miter): void /** - * Sets the current fill color to the supplied RGB values. Returns TRUE on success . + * Sets the current fill color to the supplied RGB values. Returns TRUE on success. * * This function is deprecated since PDFlib version 4, use * PDF_setcolor instead. @@ -1430,7 +1430,7 @@ function PDF_setrgbcolor_fill($p, float $red, float $green, float $blue): void /** - * Sets the current stroke color to the supplied RGB values. Returns TRUE on success . + * Sets the current stroke color to the supplied RGB values. Returns TRUE on success. * * This function is deprecated since PDFlib version 4, use * PDF_setcolor instead. @@ -1454,7 +1454,7 @@ function PDF_setrgbcolor_stroke($p, float $red, float $green, float $blue): void /** * Sets the current fill and stroke color to the supplied RGB values. - * Returns TRUE on success . + * Returns TRUE on success. * * This function is deprecated since PDFlib version 4, use * PDF_setcolor instead. @@ -1477,7 +1477,7 @@ function PDF_setrgbcolor($p, float $red, float $green, float $blue): void /** - * Prints text in the current font. Returns TRUE on success . + * Prints text in the current font. Returns TRUE on success. * * @param resource $p * @param string $text @@ -1498,7 +1498,7 @@ function PDF_show_xy($p, string $text, float $x, float $y): void /** * Prints text in the current font and size at - * the current position. Returns TRUE on success . + * the current position. Returns TRUE on success. * * @param resource $pdfdoc * @param string $text @@ -1517,7 +1517,7 @@ function PDF_show($pdfdoc, string $text): void /** * Skews the coordinate system in x and y direction by alpha - * and beta degrees, respectively. Returns TRUE on success . + * and beta degrees, respectively. Returns TRUE on success. * * @param resource $p * @param float $alpha @@ -1537,7 +1537,7 @@ function PDF_skew($p, float $alpha, float $beta): void /** * Strokes the path with the current color and line width, and clear it. - * Returns TRUE on success . + * Returns TRUE on success. * * @param resource $p * @throws PdfException diff --git a/generated/pgsql.php b/generated/pgsql.php index bfad97bf..3f0ff7dc 100644 --- a/generated/pgsql.php +++ b/generated/pgsql.php @@ -35,7 +35,7 @@ function pg_cancel_query($connection): void * connection is not present, the default connection * is used. The default connection is the last connection made by * pg_connect or pg_pconnect. - * @return string The client encoding, . + * @return string The client encoding. * @throws PgsqlException * */ @@ -180,7 +180,7 @@ function pg_connection_reset($connection): void * @param int $options Any number of PGSQL_CONV_IGNORE_DEFAULT, * PGSQL_CONV_FORCE_NULL or * PGSQL_CONV_IGNORE_NOT_NULL, combined. - * @return array An array of converted values, . + * @return array An array of converted values. * @throws PgsqlException * */ @@ -272,7 +272,7 @@ function pg_copy_to($connection, string $table_name, string $delimiter = null, s * is used. The default connection is the last connection made by * pg_connect or pg_pconnect. * @return string A string containing the name of the database the - * connection is to, . + * connection is to. * @throws PgsqlException * */ @@ -324,7 +324,7 @@ function pg_dbname($connection = null): string * PGSQL_DML_STRING combined. If PGSQL_DML_STRING is part of the * options then query string is returned. When PGSQL_DML_NO_CONV * or PGSQL_DML_ESCAPE is set, it does not call pg_convert internally. - * @return mixed Returns TRUE on success . Returns string if PGSQL_DML_STRING is passed + * @return mixed Returns TRUE on success. Returns string if PGSQL_DML_STRING is passed * via options. * @throws PgsqlException * @@ -399,7 +399,7 @@ function pg_end_copy($connection = null): void * must match the number of placeholders. * * Elements are converted to strings by calling this function. - * @return resource A query result resource on success . + * @return resource A query result resource on success. * @throws PgsqlException * */ @@ -432,7 +432,7 @@ function pg_execute($connection = null, string $stmtname = null, array $params = * pg_query_params or pg_execute * (among others). * @param int $field_number Field number, starting from 0. - * @return string The field name, . + * @return string The field name. * @throws PgsqlException * */ @@ -482,7 +482,7 @@ function pg_field_table($result, int $field_number, bool $oid_only = false) * pg_query_params or pg_execute * (among others). * @param int $field_number Field number, starting from 0. - * @return string A string containing the base name of the field's type, . + * @return string A string containing the base name of the field's type. * @throws PgsqlException * */ @@ -504,7 +504,7 @@ function pg_field_type($result, int $field_number): string * @param resource $connection PostgreSQL database connection resource. * @return mixed Returns TRUE if the flush was successful or no data was waiting to be * flushed, 0 if part of the pending data was flushed but - * more remains . + * more remains. * @throws PgsqlException * */ @@ -553,7 +553,7 @@ function pg_free_result($result): void * is used. The default connection is the last connection made by * pg_connect or pg_pconnect. * @return string A string containing the name of the host the - * connection is to, . + * connection is to. * @throws PgsqlException * */ @@ -606,7 +606,7 @@ function pg_host($connection = null): string * PGSQL_DML_STRING combined. If PGSQL_DML_STRING is part of the * options then query string is returned. When PGSQL_DML_NO_CONV * or PGSQL_DML_ESCAPE is set, it does not call pg_convert internally. - * @return mixed Returns the connection resource on success, . Returns string if PGSQL_DML_STRING is passed + * @return mixed Returns the connection resource on success. Returns string if PGSQL_DML_STRING is passed * via options. * @throws PgsqlException * @@ -639,7 +639,7 @@ function pg_insert($connection, string $table_name, array $assoc_array, int $opt * is used. The default connection is the last connection made by * pg_connect or pg_pconnect. * @return string A string containing the last error message on the - * given connection, . + * given connection. * @throws PgsqlException * */ @@ -684,8 +684,7 @@ function pg_last_error($connection = null): string * given connection with * PGSQL_NOTICE_LAST, * an array with PGSQL_NOTICE_ALL, - * a boolean with PGSQL_NOTICE_CLEAR, - * . + * a boolean with PGSQL_NOTICE_CLEAR. * @throws PgsqlException * */ @@ -724,7 +723,7 @@ function pg_last_notice($connection, int $option = PGSQL_NOTICE_LAST) * pg_query_params or pg_execute * (among others). * @return string A string containing the OID assigned to the most recently inserted - * row in the specified connection, or + * row in the specified connection or * no available OID. * @throws PgsqlException * @@ -817,7 +816,7 @@ function pg_lo_export($connection = null, int $oid = null, string $pathname = nu * object id is assigned by the server. The parameter * was added in PHP 5.3 and relies on functionality that first * appeared in PostgreSQL 8.1. - * @return int The OID of the newly created large object, . + * @return int The OID of the newly created large object. * @throws PgsqlException * */ @@ -854,7 +853,7 @@ function pg_lo_import($connection = null, string $pathname = null, $object_id = * @param int $oid The OID of the large object in the database. * @param string $mode Can be either "r" for read-only, "w" for write only or "rw" for read and * write. - * @return resource A large object resource . + * @return resource A large object resource. * @throws PgsqlException * */ @@ -879,7 +878,7 @@ function pg_lo_open($connection, int $oid, string $mode) * enclose it within a transaction block. * * @param resource $large_object PostgreSQL large object (LOB) resource, returned by pg_lo_open. - * @return int Number of bytes read . + * @return int Number of bytes read. * @throws PgsqlException * */ @@ -905,7 +904,7 @@ function pg_lo_read_all($large_object): int * @param resource $large_object PostgreSQL large object (LOB) resource, returned by pg_lo_open. * @param int $len An optional maximum number of bytes to return. * @return string A string containing len bytes from the - * large object, . + * large object. * @throws PgsqlException * */ @@ -969,7 +968,7 @@ function pg_lo_truncate($large_object, int $size): void /** * pg_lo_unlink deletes a large object with the - * oid. Returns TRUE on success . + * oid. Returns TRUE on success. * * To use the large object interface, it is necessary to * enclose it within a transaction block. @@ -1006,7 +1005,7 @@ function pg_lo_unlink($connection, int $oid): void * @param int $len An optional maximum number of bytes to write. Must be greater than zero * and no greater than the length of data. Defaults to * the length of data. - * @return int The number of bytes written to the large object, . + * @return int The number of bytes written to the large object. * @throws PgsqlException * */ @@ -1032,7 +1031,7 @@ function pg_lo_write($large_object, string $data, int $len = null): int * @param resource $connection PostgreSQL database connection resource. * @param string $table_name The name of the table. * @param bool $extended Flag for returning extended meta data. Default to FALSE. - * @return array An array of the table definition, . + * @return array An array of the table definition. * @throws PgsqlException * */ @@ -1057,7 +1056,7 @@ function pg_meta_data($connection, string $table_name, bool $extended = false): * is used. The default connection is the last connection made by * pg_connect or pg_pconnect. * @return string A string containing the connection - * options, . + * options. * @throws PgsqlException * */ @@ -1225,8 +1224,7 @@ function pg_ping($connection = null): void * is used. The default connection is the last connection made by * pg_connect or pg_pconnect. * @return int An int containing the port number of the database - * server the connection is to, - * . + * server the connection is to. * @throws PgsqlException * */ @@ -1276,7 +1274,7 @@ function pg_port($connection = null): int * @param string $query The parameterized SQL statement. Must contain only a single statement. * (multiple statements separated by semi-colons are not allowed.) If any parameters * are used, they are referred to as $1, $2, etc. - * @return resource A query result resource on success . + * @return resource A query result resource on success. * @throws PgsqlException * */ @@ -1383,7 +1381,7 @@ function pg_put_line($connection = null, string $data = null): void * Values intended for bytea fields are not supported as * parameters. Use pg_escape_bytea instead, or use the * large object functions. - * @return resource A query result resource on success . + * @return resource A query result resource on success. * @throws PgsqlException * */ @@ -1441,7 +1439,7 @@ function pg_query_params($connection = null, string $query = null, array $params * * Any user-supplied data substituted directly into a query string should * be properly escaped. - * @return resource A query result resource on success . + * @return resource A query result resource on success. * @throws PgsqlException * */ @@ -1487,7 +1485,7 @@ function pg_query($connection = null, string $query = null) * PGSQL_DIAG_CONTEXT, PGSQL_DIAG_SOURCE_FILE, * PGSQL_DIAG_SOURCE_LINE or * PGSQL_DIAG_SOURCE_FUNCTION. - * @return string|?false A string containing the contents of the error field, NULL if the field does not exist . + * @return string|?false A string containing the contents of the error field, NULL if the field does not exist. * @throws PgsqlException * */ @@ -1558,7 +1556,7 @@ function pg_result_seek($result, int $offset): void * options then query string is returned. When PGSQL_DML_NO_CONV * or PGSQL_DML_ESCAPE is set, it does not call pg_convert internally. * @param int $result_type - * @return mixed Returns TRUE on success . Returns string if PGSQL_DML_STRING is passed + * @return mixed Returns TRUE on success. Returns string if PGSQL_DML_STRING is passed * via options. * @throws PgsqlException * @@ -1713,7 +1711,7 @@ function pg_send_query($connection, string $query): void * corresponding to the socket underlying the given PostgreSQL connection. * * @param resource $connection PostgreSQL database connection resource. - * @return resource A socket resource on success . + * @return resource A socket resource on success. * @throws PgsqlException * */ @@ -1775,7 +1773,7 @@ function pg_trace(string $pathname, string $mode = "w", $connection = null): voi * is used. The default connection is the last connection made by * pg_connect or pg_pconnect. * @return string A string containing the debug TTY of - * the connection, . + * the connection. * @throws PgsqlException * */ @@ -1833,7 +1831,7 @@ function pg_tty($connection = null): string * PGSQL_DML_STRING combined. If PGSQL_DML_STRING is part of the * options then query string is returned. When PGSQL_DML_NO_CONV * or PGSQL_DML_ESCAPE is set, it does not call pg_convert internally. - * @return mixed Returns TRUE on success . Returns string if PGSQL_DML_STRING is passed + * @return mixed Returns TRUE on success. Returns string if PGSQL_DML_STRING is passed * via options. * @throws PgsqlException * diff --git a/generated/posix.php b/generated/posix.php index 9be7f74e..6ae99d88 100644 --- a/generated/posix.php +++ b/generated/posix.php @@ -34,7 +34,7 @@ function posix_access(string $file, int $mode = POSIX_F_OK): void * Gets information about a group provided its name. * * @param string $name The name of the group - * @return array Returns an array on success, . + * @return array Returns an array on success. * The array elements returned are: * * The group information array @@ -96,7 +96,7 @@ function posix_getgrnam(string $name): array /** * Returns the process group identifier of the process - * pid . + * pid. * * @param int $pid The process id. * @return int Returns the identifier, as an integer. diff --git a/generated/ps.php b/generated/ps.php index c77647bf..a66667aa 100644 --- a/generated/ps.php +++ b/generated/ps.php @@ -309,7 +309,7 @@ function ps_begin_page($psdoc, float $width, float $height): void * @param float $ystep The distance in pixel of placements of the pattern in * vertical direction. * @param int $painttype Must be 1 or 2. - * @return int The identifier of the pattern . + * @return int The identifier of the pattern. * @throws PsException * */ @@ -336,7 +336,7 @@ function ps_begin_pattern($psdoc, float $width, float $height, float $xstep, flo * as returned by ps_new. * @param float $width The width of the template in pixel. * @param float $height The height of the template in pixel. - * @return int Returns TRUE on success . + * @return int Returns TRUE on success. * @throws PsException * */ @@ -774,7 +774,7 @@ function ps_fill($psdoc): void * @param float $modifier An identifier needed if a parameter of a resource is requested, * e.g. the size of an image. In such a case the resource id is * passed. - * @return string Returns the value of the parameter . + * @return string Returns the value of the parameter. * @throws PsException * */ @@ -810,7 +810,7 @@ function ps_get_parameter($psdoc, string $name, float $modifier = null): string * interger numbers. Each number is the position of the char in * text after which a hyphenation can take place. * @return array An array of integers indicating the position of possible breaks in - * the text . + * the text. * @throws PsException * */ @@ -897,7 +897,7 @@ function ps_moveto($psdoc, float $x, float $y): void * followed by a call of ps_open_file to actually create * the postscript document. * - * @return resource Resource of PostScript document . The return value + * @return resource Resource of PostScript document. The return value * is passed to all other functions as the first argument. * @throws PsException * @@ -1578,7 +1578,7 @@ function ps_setpolydash($psdoc, float $arr): void * @param int $shadingid The identifier of a shading previously created with * ps_shading. * @param string $optlist This argument is not currently used. - * @return int The identifier of the pattern . + * @return int The identifier of the pattern. * @throws PsException * */ @@ -1623,7 +1623,7 @@ function ps_shading_pattern($psdoc, int $shadingid, string $optlist): int * @param float $c3 * @param float $c4 * @param string $optlist - * @return int Returns the identifier of the pattern . + * @return int Returns the identifier of the pattern. * @throws PsException * */ diff --git a/generated/pspell.php b/generated/pspell.php index 76b1add7..6bcda491 100644 --- a/generated/pspell.php +++ b/generated/pspell.php @@ -86,7 +86,7 @@ function pspell_clear_session(int $dictionary_link): void * 'viscii', 'cp1252', 'machine unsigned 16', 'machine unsigned * 32'. This parameter is largely untested, so be careful when * using. - * @return int Retuns a pspell config identifier, . + * @return int Retuns a pspell config identifier. * @throws PspellException * */ @@ -315,7 +315,7 @@ function pspell_config_save_repl(int $dictionary_link, bool $flag): void * * @param int $config The config parameter is the one returned by * pspell_config_create when the config was created. - * @return int Returns a dictionary link identifier on success, . + * @return int Returns a dictionary link identifier on success. * @throws PspellException * */ @@ -388,7 +388,7 @@ function pspell_new_config(int $config): int * PSPELL_NORMAL and * PSPELL_BAD_SPELLERS are mutually exclusive, so you * should select only one of them. - * @return int Returns the dictionary link identifier on success . + * @return int Returns the dictionary link identifier on success. * @throws PspellException * */ diff --git a/generated/sem.php b/generated/sem.php index ec2a68cb..040b64ac 100644 --- a/generated/sem.php +++ b/generated/sem.php @@ -233,7 +233,7 @@ function sem_acquire($sem_identifier, bool $nowait = false): void * attached to the semaphore. * @param int $auto_release Specifies if the semaphore should be automatically released on request * shutdown. - * @return resource Returns a positive semaphore identifier on success, . + * @return resource Returns a positive semaphore identifier on success. * @throws SemException * */ diff --git a/generated/shmop.php b/generated/shmop.php index 70edec16..0e9ae013 100644 --- a/generated/shmop.php +++ b/generated/shmop.php @@ -30,7 +30,7 @@ function shmop_delete($shmid): void * @param int $start Offset from which to start reading * @param int $count The number of bytes to read. * 0 reads shmop_size($shmid) - $start bytes. - * @return string Returns the data . + * @return string Returns the data. * @throws ShmopException * */ @@ -53,7 +53,7 @@ function shmop_read($shmid, int $start, int $count): string * @param string $data A string to write into shared memory block * @param int $offset Specifies where to start writing data inside the shared memory * segment. - * @return int The size of the written data, . + * @return int The size of the written data. * @throws ShmopException * */ diff --git a/generated/simplexml.php b/generated/simplexml.php index 8b9d0710..118de443 100644 --- a/generated/simplexml.php +++ b/generated/simplexml.php @@ -14,7 +14,7 @@ * simplexml_import_dom will return an object of * the specified class. That class should extend the * SimpleXMLElement class. - * @return \SimpleXMLElement Returns a SimpleXMLElement . + * @return \SimpleXMLElement Returns a SimpleXMLElement. * @throws SimplexmlException * */ @@ -50,7 +50,7 @@ function simplexml_import_dom(\DOMNode $node, string $class_name = "SimpleXMLEle * @param bool $is_prefix TRUE if ns is a prefix, FALSE if it's a URI; * defaults to FALSE. * @return \SimpleXMLElement Returns an object of class SimpleXMLElement with - * properties containing the data held within the XML document, . + * properties containing the data held within the XML document. * @throws SimplexmlException * */ @@ -79,7 +79,7 @@ function simplexml_load_file(string $filename, string $class_name = "SimpleXMLEl * @param bool $is_prefix TRUE if ns is a prefix, FALSE if it's a URI; * defaults to FALSE. * @return \SimpleXMLElement Returns an object of class SimpleXMLElement with - * properties containing the data held within the xml document, . + * properties containing the data held within the xml document. * @throws SimplexmlException * */ diff --git a/generated/sockets.php b/generated/sockets.php index 483bdc09..5fa99711 100644 --- a/generated/sockets.php +++ b/generated/sockets.php @@ -26,7 +26,7 @@ * reused. * * @param resource $socket A valid socket resource created with socket_create. - * @return resource Returns a new socket resource on success, . The actual + * @return resource Returns a new socket resource on success. The actual * error code can be retrieved by calling * socket_last_error. This error code may be passed to * socket_strerror to get a textual explanation of the @@ -120,7 +120,7 @@ function socket_connect($socket, string $address, int $port = 0): void * backlog parameter, see * socket_listen for more information. * @return resource socket_create_listen returns a new socket resource - * on success . The error code can be retrieved with + * on success. The error code can be retrieved with * socket_last_error. This code may be passed to * socket_strerror to get a textual explanation of the * error. @@ -189,8 +189,7 @@ function socket_create_pair(int $domain, int $type, int $protocol, ?array &$fd): * the desired protocol is TCP, or UDP the corresponding constants * SOL_TCP, and SOL_UDP * can also be used. - * @return resource socket_create returns a socket resource on success, - * . The actual error code can be retrieved by calling + * @return resource socket_create returns a socket resource on success. The actual error code can be retrieved by calling * socket_last_error. This error code may be passed to * socket_strerror to get a textual explanation of the * error. @@ -212,7 +211,7 @@ function socket_create(int $domain, int $type, int $protocol) * * * @param resource $socket - * @return resource Return resource . + * @return resource Return resource. * @throws SocketsException * */ @@ -259,7 +258,7 @@ function socket_export_stream($socket) * is sent or the time specified in l_linger * elapses. If the socket is non-blocking, * socket_close will fail and return an error. - * @return mixed Returns the value of the given option, s. + * @return mixed Returns the value of the given options. * @throws SocketsException * */ @@ -403,8 +402,7 @@ function socket_listen($socket, int $backlog = 0): void * * * - * @return string socket_read returns the data as a string on success, - * (including if the remote host has closed the + * @return string socket_read returns the data as a string on success (including if the remote host has closed the * connection). The error code can be retrieved with * socket_last_error. This code may be passed to * socket_strerror to get a textual representation of @@ -469,7 +467,7 @@ function socket_read($socket, int $length, int $type = PHP_BINARY_READ): string * * * - * @return int socket_send returns the number of bytes sent, . + * @return int socket_send returns the number of bytes sent. * @throws SocketsException * */ @@ -490,7 +488,7 @@ function socket_send($socket, string $buf, int $len, int $flags): int * @param resource $socket * @param array $message * @param int $flags - * @return int Returns the number of bytes sent, . + * @return int Returns the number of bytes sent. * @throws SocketsException * */ @@ -555,7 +553,7 @@ function socket_sendmsg($socket, array $message, int $flags = 0): int * @param int $port port is the remote port number at which the data * will be sent. * @return int socket_sendto returns the number of bytes sent to the - * remote host, . + * remote host. * @throws SocketsException * */ @@ -707,7 +705,7 @@ function socket_shutdown($socket, int $how = 2): void * alternate length of bytes written to the socket. If this length is * greater than the buffer length, it is silently truncated to the length * of the buffer. - * @return int Returns the number of bytes successfully written to the socket . + * @return int Returns the number of bytes successfully written to the socket. * The error code can be retrieved with * socket_last_error. This code may be passed to * socket_strerror to get a textual explanation of the diff --git a/generated/sodium.php b/generated/sodium.php index cb83c8db..6cb378ad 100644 --- a/generated/sodium.php +++ b/generated/sodium.php @@ -10,7 +10,7 @@ * @param string $password string; The password to generate a hash for. * @param int $opslimit Represents a maximum amount of computations to perform. Raising this number will make the function require more CPU cycles to compute a key. There are constants available to set the operations limit to appropriate values depending on intended use, in order of strength: SODIUM_CRYPTO_PWHASH_OPSLIMIT_INTERACTIVE, SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE and SODIUM_CRYPTO_PWHASH_OPSLIMIT_SENSITIVE. * @param int $memlimit The maximum amount of RAM that the function will use, in bytes. There are constants to help you choose an appropriate value, in order of size: SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE, SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE, and SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE. Typically these should be paired with the matching opslimit values. - * @return string Returns the hashed password, . + * @return string Returns the hashed password. * * In order to produce the same password hash from the same password, the same values for opslimit and memlimit must be used. These are embedded within the generated hash, so * everything that's needed to verify the hash is included. This allows @@ -39,7 +39,7 @@ function sodium_crypto_pwhash_str(string $password, int $opslimit, int $memlimit * @param int $opslimit Represents a maximum amount of computations to perform. Raising this number will make the function require more CPU cycles to compute a key. There are some constants available to set the operations limit to appropriate values depending on intended use, in order of strength: SODIUM_CRYPTO_PWHASH_OPSLIMIT_INTERACTIVE, SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE and SODIUM_CRYPTO_PWHASH_OPSLIMIT_SENSITIVE. * @param int $memlimit The maximum amount of RAM that the function will use, in bytes. There are constants to help you choose an appropriate value, in order of size: SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE, SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE, and SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE. Typically these should be paired with the matching opslimit values. * @param int $alg integer A number indicating the hash algorithm to use. By default SODIUM_CRYPTO_PWHASH_ALG_DEFAULT (the currently recommended algorithm, which can change from one version of libsodium to another), or explicitly using SODIUM_CRYPTO_PWHASH_ALG_ARGON2ID13, representing the Argon2id algorithm version 1.3. - * @return string Returns the derived key, . The return value is a binary string of the hash, not an ASCII-encoded representation, and does not contain additional information about the parameters used to create the hash, so you will need to keep that information if you are ever going to verify the password in future. Use sodium_crypto_pwhash_str to avoid needing to do all that. + * @return string Returns the derived key. The return value is a binary string of the hash, not an ASCII-encoded representation, and does not contain additional information about the parameters used to create the hash, so you will need to keep that information if you are ever going to verify the password in future. Use sodium_crypto_pwhash_str to avoid needing to do all that. * @throws SodiumException * */ diff --git a/generated/solr.php b/generated/solr.php index 4eb940c9..4d4e0418 100644 --- a/generated/solr.php +++ b/generated/solr.php @@ -7,7 +7,7 @@ /** * This function returns the current version of the extension as a string. * - * @return string It returns a string on success . + * @return string It returns a string on success. * @throws SolrException * */ diff --git a/generated/spl.php b/generated/spl.php index 54eac8cb..b2d0179e 100644 --- a/generated/spl.php +++ b/generated/spl.php @@ -11,7 +11,7 @@ * @param mixed $class An object (class instance) or a string (class or interface name). * @param bool $autoload Whether to allow this function to load the class automatically through * the __autoload magic method. - * @return array An array on success, . + * @return array An array on success. * @throws SplException * */ @@ -33,7 +33,7 @@ function class_implements($class, bool $autoload = true): array * @param mixed $class An object (class instance) or a string (class name). * @param bool $autoload Whether to allow this function to load the class automatically through * the __autoload magic method. - * @return array An array on success, . + * @return array An array on success. * @throws SplException * */ @@ -56,7 +56,7 @@ function class_parents($class, bool $autoload = true): array * @param mixed $class An object (class instance) or a string (class name). * @param bool $autoload Whether to allow this function to load the class automatically through * the __autoload magic method. - * @return array An array on success, . + * @return array An array on success. * @throws SplException * */ diff --git a/generated/ssh2.php b/generated/ssh2.php index fc435bb1..0d5609a5 100644 --- a/generated/ssh2.php +++ b/generated/ssh2.php @@ -300,7 +300,7 @@ function ssh2_auth_pubkey_file($session, string $username, string $pubkeyfile, s * * * - * @return resource Returns a resource on success, . + * @return resource Returns a resource on success. * @throws Ssh2Exception * */ @@ -353,7 +353,7 @@ function ssh2_disconnect($session): void * @param int $width_height_type width_height_type should be one of * SSH2_TERM_UNIT_CHARS or * SSH2_TERM_UNIT_PIXELS. - * @return resource Returns a stream on success . + * @return resource Returns a stream on success. * @throws Ssh2Exception * */ @@ -420,7 +420,7 @@ function ssh2_publickey_add($pkey, string $algoname, string $blob, bool $overwri * * @param resource $session * @return resource Returns an SSH2 Publickey Subsystem resource for use - * with all other ssh2_publickey_*() methods . + * with all other ssh2_publickey_*() methods. * @throws Ssh2Exception * */ diff --git a/generated/stats.php b/generated/stats.php index 7cd245e5..aca98485 100644 --- a/generated/stats.php +++ b/generated/stats.php @@ -9,8 +9,7 @@ * * @param array $a The first array * @param array $b The second array - * @return float Returns the covariance of a and b, - * . + * @return float Returns the covariance of a and b. * @throws StatsException * */ @@ -52,8 +51,7 @@ function stats_standard_deviation(array $a, bool $sample = false): float * * @param array $arr1 The first array * @param array $arr2 The second array - * @return float Returns the Pearson correlation coefficient between arr1 and arr2, - * . + * @return float Returns the Pearson correlation coefficient between arr1 and arr2. * @throws StatsException * */ @@ -73,8 +71,7 @@ function stats_stat_correlation(array $arr1, array $arr2): float * * @param array $arr1 The first array * @param array $arr2 The second array - * @return float Returns the inner product of arr1 and arr2, - * . + * @return float Returns the inner product of arr1 and arr2. * @throws StatsException * */ diff --git a/generated/stream.php b/generated/stream.php index e44e9e3e..1f86a81b 100644 --- a/generated/stream.php +++ b/generated/stream.php @@ -37,7 +37,7 @@ function stream_context_set_params($stream_or_context, array $params): void * @param resource $dest The destination stream * @param int $maxlength Maximum bytes to copy * @param int $offset The offset where to start to copy data - * @return int Returns the total count of bytes copied, . + * @return int Returns the total count of bytes copied. * @throws StreamException * */ @@ -74,7 +74,7 @@ function stream_copy_to_stream($source, $dest, int $maxlength = -1, int $offset * the list and will therefore be called last during stream operations. * To add a filter to the beginning of the list, use * stream_filter_prepend. - * @return resource Returns a resource on success . The resource can be + * @return resource Returns a resource on success. The resource can be * used to refer to this filter instance during a call to * stream_filter_remove. * @@ -123,7 +123,7 @@ function stream_filter_append($stream, string $filtername, int $read_write = nul * to the beginning of the list and will therefore be * called first during stream operations. To add a filter to the end of the * list, use stream_filter_append. - * @return resource Returns a resource on success . The resource can be + * @return resource Returns a resource on success. The resource can be * used to refer to this filter instance during a call to * stream_filter_remove. * @@ -210,7 +210,7 @@ function stream_filter_remove($stream_filter): void * buffer). * @param int $offset Seek to the specified offset before reading. If this number is negative, * no seeking will occur and reading will start from the current position. - * @return string Returns a string . + * @return string Returns a string. * @throws StreamException * */ @@ -247,7 +247,7 @@ function stream_isatty($stream): void * Resolve filename against the include path according to the same rules as fopen/include. * * @param string $filename The filename to resolve. - * @return string Returns a string containing the resolved absolute filename, . + * @return string Returns a string containing the resolved absolute filename. * @throws StreamException * */ @@ -327,7 +327,7 @@ function stream_set_timeout($stream, int $seconds, int $microseconds = 0): void * * Can also be determined later using * stream_socket_get_name. - * @return resource Returns a stream to the accepted socket connection . + * @return resource Returns a stream to the accepted socket connection. * @throws StreamException * */ @@ -435,7 +435,7 @@ function stream_socket_client(string $remote_socket, int &$errno = null, string * STREAM_IPPROTO_RAW, * STREAM_IPPROTO_TCP or * STREAM_IPPROTO_UDP - * @return resource[] Returns an array with the two socket resources on success, . + * @return resource[] Returns an array with the two socket resources on success. * @throws StreamException * */ @@ -488,7 +488,7 @@ function stream_socket_pair(int $domain, int $type, int $protocol): array * For UDP sockets, you must use STREAM_SERVER_BIND as * the flags parameter. * @param resource $context - * @return resource Returns the created stream, . + * @return resource Returns the created stream. * @throws StreamException * */ diff --git a/generated/strings.php b/generated/strings.php index dd86eb02..df470594 100644 --- a/generated/strings.php +++ b/generated/strings.php @@ -8,7 +8,7 @@ * convert_uudecode decodes a uuencoded string. * * @param string $data The uuencoded data. - * @return string Returns the decoded data as a string . + * @return string Returns the decoded data as a string. * @throws StringsException * */ @@ -32,7 +32,7 @@ function convert_uudecode(string $data): string * about 35% larger than the original. * * @param string $data The data to be encoded. - * @return string Returns the uuencoded data . + * @return string Returns the uuencoded data. * @throws StringsException * */ @@ -51,7 +51,7 @@ function convert_uuencode(string $data): string * Decodes a hexadecimally encoded binary string. * * @param string $data Hexadecimal representation of data. - * @return string Returns the binary representation of the given data . + * @return string Returns the binary representation of the given data. * @throws StringsException * */ @@ -108,7 +108,7 @@ function md5_file(string $filename, bool $raw_output = false): string * @param int $phonemes This parameter restricts the returned metaphone key to * phonemes characters in length. * The default value of 0 means no restriction. - * @return string Returns the metaphone key as a string, . + * @return string Returns the metaphone key as a string. * @throws StringsException * */ @@ -477,7 +477,7 @@ function sha1_file(string $filename, bool $raw_output = false): string * The c type specifier ignores padding and width * @param mixed $params * @return string Returns a string produced according to the formatting string - * format, . + * format. * @throws StringsException * */ @@ -541,7 +541,7 @@ function sprintf(string $format, ...$params): string * If length is omitted, the substring starting from * start until the end of the string will be * returned. - * @return string Returns the extracted part of string; , or + * @return string Returns the extracted part of string;, or * an empty string. * @throws StringsException * diff --git a/generated/uodbc.php b/generated/uodbc.php index 44ee414f..5c3882e9 100644 --- a/generated/uodbc.php +++ b/generated/uodbc.php @@ -20,7 +20,7 @@ * occurs. * * If OnOff is set, this function returns TRUE on - * success . + * success. * @throws UodbcException * */ @@ -152,7 +152,7 @@ function odbc_binmode($result_id, int $mode): void * @param string $owner The owner. * @param string $table_name The table name. * @param string $column_name The column name. - * @return resource Returns an ODBC result identifier . + * @return resource Returns an ODBC result identifier. * This result identifier can be used to fetch a list of columns and * associated privileges. * @@ -192,7 +192,7 @@ function odbc_columnprivileges($connection_id, string $qualifier, string $owner, * @param string $schema The owner. * @param string $table_name The table name. * @param string $column_name The column name. - * @return resource Returns an ODBC result identifier . + * @return resource Returns an ODBC result identifier. * * The result set has the following columns: * @@ -287,7 +287,7 @@ function odbc_data_source($connection_id, int $fetch_type): array * @param string $query_string The SQL statement. * @param int $flags This parameter is currently not used. * @return resource Returns an ODBC result identifier if the SQL command was executed - * successfully, . + * successfully. * @throws UodbcException * */ @@ -371,7 +371,7 @@ function odbc_fetch_into($result_id, ?array &$result_array, int $rownumber = nul * * @param resource $result_id The result identifier. * @param int $field_number The field number. Field numbering starts at 1. - * @return int Returns the field length, . + * @return int Returns the field length. * @throws UodbcException * */ @@ -392,7 +392,7 @@ function odbc_field_len($result_id, int $field_number): int * * @param resource $result_id The result identifier. * @param int $field_number The field number. Field numbering starts at 1. - * @return string Returns the field name as a string, . + * @return string Returns the field name as a string. * @throws UodbcException * */ @@ -413,7 +413,7 @@ function odbc_field_name($result_id, int $field_number): string * * @param resource $result_id The result identifier. * @param string $field_name The field name. - * @return int Returns the field number as a integer, . + * @return int Returns the field number as a integer. * Field numbering starts at 1. * @throws UodbcException * @@ -435,7 +435,7 @@ function odbc_field_num($result_id, string $field_name): int * * @param resource $result_id The result identifier. * @param int $field_number The field number. Field numbering starts at 1. - * @return int Returns the field scale as a integer, . + * @return int Returns the field scale as a integer. * @throws UodbcException * */ @@ -456,7 +456,7 @@ function odbc_field_scale($result_id, int $field_number): int * * @param resource $result_id The result identifier. * @param int $field_number The field number. Field numbering starts at 1. - * @return string Returns the field type as a string, . + * @return string Returns the field type as a string. * @throws UodbcException * */ @@ -484,7 +484,7 @@ function odbc_field_type($result_id, int $field_number): string * @param string $fk_qualifier The foreign key qualifier. * @param string $fk_owner The foreign key owner. * @param string $fk_table The foreign key table. - * @return resource Returns an ODBC result identifier . + * @return resource Returns an ODBC result identifier. * * The result set has the following columns: * @@ -523,7 +523,7 @@ function odbc_foreignkeys($connection_id, string $pk_qualifier, string $pk_owner * see odbc_connect for details. * @param int $data_type The data type, which can be used to restrict the information to a * single data type. - * @return resource Returns an ODBC result identifier . + * @return resource Returns an ODBC result identifier. * * The result set has the following columns: * @@ -620,7 +620,7 @@ function odbc_prepare($connection_id, string $query_string) * @param string $qualifier * @param string $owner * @param string $table - * @return resource Returns an ODBC result identifier . + * @return resource Returns an ODBC result identifier. * * The result set has the following columns: * @@ -651,7 +651,7 @@ function odbc_primarykeys($connection_id, string $qualifier, string $owner, stri * * @param resource $result_id The result identifier. * @param string $format Additional overall table formatting. - * @return int Returns the number of rows in the result . + * @return int Returns the number of rows in the result. * @throws UodbcException * */ @@ -763,7 +763,7 @@ function odbc_setoption($id, int $function, int $option, int $param): void * @param string $table The table. * @param int $scope The scope, which orders the result set. * @param int $nullable The nullable option. - * @return resource Returns an ODBC result identifier . + * @return resource Returns an ODBC result identifier. * * The result set has the following columns: * @@ -800,7 +800,7 @@ function odbc_specialcolumns($connection_id, int $type, string $qualifier, strin * @param string $table_name The table name. * @param int $unique The unique attribute. * @param int $accuracy The accuracy. - * @return resource Returns an ODBC result identifier . + * @return resource Returns an ODBC result identifier. * * The result set has the following columns: * @@ -843,7 +843,7 @@ function odbc_statistics($connection_id, string $qualifier, string $owner, strin * ('%' to match zero or more characters and '_' to match a single character) * @param string $name The name. Accepts the following search patterns: * ('%' to match zero or more characters and '_' to match a single character) - * @return resource An ODBC result identifier . + * @return resource An ODBC result identifier. * * The result set has the following columns: * @@ -924,8 +924,7 @@ function odbc_tableprivileges($connection_id, string $qualifier, string $owner, * data source does not support a specified table type, * odbc_tables does not return any results for * that type. - * @return resource Returns an ODBC result identifier containing the information - * . + * @return resource Returns an ODBC result identifier containing the information. * * The result set has the following columns: * diff --git a/generated/url.php b/generated/url.php index 626ad8b5..b0c2b4f4 100644 --- a/generated/url.php +++ b/generated/url.php @@ -12,7 +12,7 @@ * then the base64_decode function will return * FALSE if the input contains character from outside the base64 * alphabet. Otherwise invalid characters will be silently discarded. - * @return string Returns the decoded data . The returned data may be + * @return string Returns the decoded data. The returned data may be * binary. * @throws UrlException * @@ -38,7 +38,7 @@ function base64_decode(string $data, bool $strict = false): string * array's keys. * @param resource $context A valid context resource created with * stream_context_create. - * @return array Returns an indexed or associative array with the headers, . + * @return array Returns an indexed or associative array with the headers. * @throws UrlException * */ diff --git a/generated/xdiff.php b/generated/xdiff.php index b849febf..06cc09e6 100644 --- a/generated/xdiff.php +++ b/generated/xdiff.php @@ -158,7 +158,7 @@ function xdiff_file_rabdiff(string $old_file, string $new_file, string $dest): v * * @param string $str The original binary string. * @param string $patch The binary patch string. - * @return string Returns the patched string, . + * @return string Returns the patched string. * @throws XdiffException * */ @@ -182,7 +182,7 @@ function xdiff_string_bpatch(string $str, string $patch): string * * @param string $str The original binary string. * @param string $patch The binary patch string. - * @return string Returns the patched string, . + * @return string Returns the patched string. * @throws XdiffException * */ @@ -215,7 +215,7 @@ function xdiff_string_patch_binary(string $str, string $patch): string * Starting from version 1.5.0, you can also use binary OR to enable * XDIFF_PATCH_IGNORESPACE flag. * @param string $error If provided then rejected parts are stored inside this variable. - * @return string Returns the patched string, . + * @return string Returns the patched string. * @throws XdiffException * */ diff --git a/generated/xml.php b/generated/xml.php index e4bb8f7a..4f9f6606 100644 --- a/generated/xml.php +++ b/generated/xml.php @@ -18,7 +18,7 @@ * @param string $separator With a namespace aware parser tag parameters passed to the various * handler functions will consist of namespace and tag name separated by * the string specified in separator. - * @return resource Returns a resource handle for the new XML parser, . + * @return resource Returns a resource handle for the new XML parser. * @throws XmlException * */ @@ -55,7 +55,7 @@ function xml_parser_create_ns(string $encoding = null, string $separator = ":") * ISO-8859-1, while in PHP 5.0.2 and upper is UTF-8. The supported * encodings are ISO-8859-1, UTF-8 and * US-ASCII. - * @return resource Returns a resource handle for the new XML parser, . + * @return resource Returns a resource handle for the new XML parser. * @throws XmlException * */ diff --git a/generated/yaml.php b/generated/yaml.php index edb1b79e..bddf9a87 100644 --- a/generated/yaml.php +++ b/generated/yaml.php @@ -17,7 +17,7 @@ * parse callbacks for more * details. * @return mixed Returns the value encoded in input in appropriate - * PHP type . If pos is -1 an + * PHP type. If pos is -1 an * array will be returned with one entry for each document found * in the stream. * @throws YamlException @@ -50,7 +50,7 @@ function yaml_parse_file(string $filename, int $pos = 0, int &$ndocs = null, arr * tag => callable mappings. See * parse callbacks for more * @return mixed Returns the value encoded in input in appropriate - * PHP type . If pos is + * PHP type. If pos is * -1 an array will be returned with one entry * for each document found in the stream. * @throws YamlException @@ -80,7 +80,7 @@ function yaml_parse_url(string $url, int $pos = 0, int &$ndocs = null, array $ca * parse callbacks for more * details. * @return mixed Returns the value encoded in input in appropriate - * PHP type . If pos is -1 an + * PHP type. If pos is -1 an * array will be returned with one entry for each document found * in the stream. * @throws YamlException diff --git a/generated/yaz.php b/generated/yaz.php index 07dead6a..ed7e18a1 100644 --- a/generated/yaz.php +++ b/generated/yaz.php @@ -422,8 +422,8 @@ function yaz_search($id, string $type, string $query): void * returns. The default value for timeout is 15 seconds. * * A boolean. - * @return mixed Returns TRUE on success . - * In event mode, returns resource . + * @return mixed Returns TRUE on success. + * In event mode, returns resource. * @throws YazException * */ diff --git a/generated/zip.php b/generated/zip.php index c06f5db8..8fd22bb9 100644 --- a/generated/zip.php +++ b/generated/zip.php @@ -56,7 +56,7 @@ function zip_entry_open($zip, $zip_entry, string $mode = null): void * @param int $length The number of bytes to return. * * This should be the uncompressed length you wish to read. - * @return string Returns the data read, empty string on end of a file, . + * @return string Returns the data read, empty string on end of a file. * @throws ZipException * */ diff --git a/generated/zlib.php b/generated/zlib.php index 3a6652d2..324bd08e 100644 --- a/generated/zlib.php +++ b/generated/zlib.php @@ -18,7 +18,7 @@ * maximize compression, and ZLIB_FINISH to terminate * with the last chunk of data. See the zlib manual for a * detailed description of these constants. - * @return string Returns a chunk of compressed data, . + * @return string Returns a chunk of compressed data. * @throws ZlibException * */ @@ -111,7 +111,7 @@ function deflate_add($context, string $data, int $flush_mode = ZLIB_SYNC_FLUSH): * A string or an array of strings * of the preset dictionary (default: no preset dictionary). * @return resource Returns a deflate context resource (zlib.deflate) on - * success, . + * success. * @throws ZlibException * */ @@ -158,7 +158,7 @@ function gzclose($zp): void * * If -1 is used, the default compression of the zlib library is used which is 6. * @param int $encoding One of ZLIB_ENCODING_* constants. - * @return string The compressed string . + * @return string The compressed string. * @throws ZlibException * */ @@ -179,7 +179,7 @@ function gzcompress(string $data, int $level = -1, int $encoding = ZLIB_ENCODING * * @param string $data The data to decode, encoded by gzencode. * @param int $length The maximum length of data to decode. - * @return string The decoded string, . + * @return string The decoded string. * @throws ZlibException * */ @@ -211,7 +211,7 @@ function gzdecode(string $data, int $length = null): string * for maximum compression. If not given, the default compression level will * be the default compression level of the zlib library. * @param int $encoding One of ZLIB_ENCODING_* constants. - * @return string The deflated string . + * @return string The deflated string. * @throws ZlibException * */ @@ -249,7 +249,7 @@ function gzdeflate(string $data, int $level = -1, int $encoding = ZLIB_ENCODING_ * In PHP 5.4.0 and later, FORCE_DEFLATE generates * RFC 1950 compliant output, consisting of a zlib header, the deflated * data, and an Adler checksum. - * @return string The encoded string, . + * @return string The encoded string. * @throws ZlibException * */ @@ -272,7 +272,7 @@ function gzencode(string $data, int $level = -1, int $encoding_mode = FORCE_GZIP * @param resource $zp The gz-file pointer. It must be valid, and must point to a file * successfully opened by gzopen. * @param int $length The length of data to get. - * @return string The uncompressed string, . + * @return string The uncompressed string. * @throws ZlibException * */ @@ -301,7 +301,7 @@ function gzgets($zp, int $length = null): string * @param int $length The length of data to get. * @param string $allowable_tags You can use this optional parameter to specify tags which should not * be stripped. - * @return string The uncompressed and stripped string, . + * @return string The uncompressed and stripped string. * @throws ZlibException * */ @@ -325,7 +325,7 @@ function gzgetss($zp, int $length, string $allowable_tags = null): string * * @param string $data The data compressed by gzdeflate. * @param int $length The maximum length of data to decode. - * @return string The original uncompressed data . + * @return string The original uncompressed data. * * The function will return an error if the uncompressed data is more than * 32768 times the length of the compressed input data @@ -351,7 +351,7 @@ function gzinflate(string $data, int $length = 0): string * @param resource $zp The gz-file pointer. It must be valid, and must point to a file * successfully opened by gzopen. * @return int The number of uncompressed characters read from gz - * and passed through to the input, . + * and passed through to the input. * @throws ZlibException * */ @@ -390,7 +390,7 @@ function gzrewind($zp): void * * @param string $data The data compressed by gzcompress. * @param int $length The maximum length of data to decode. - * @return string The original uncompressed data . + * @return string The original uncompressed data. * * The function will return an error if the uncompressed data is more than * 32768 times the length of the compressed input data @@ -413,7 +413,7 @@ function gzuncompress(string $data, int $length = 0): string * * * @param resource $resource - * @return int Returns number of bytes read so far . + * @return int Returns number of bytes read so far. * @throws ZlibException * */ @@ -432,7 +432,7 @@ function inflate_get_read_len($resource): int * Usually returns either ZLIB_OK or ZLIB_STREAM_END. * * @param resource $resource - * @return int Returns decompression status . + * @return int Returns decompression status. * @throws ZlibException * */ @@ -464,7 +464,7 @@ function inflate_get_status($resource): int * maximize compression, and ZLIB_FINISH to terminate * with the last chunk of data. See the zlib manual for a * detailed description of these constants. - * @return string Returns a chunk of uncompressed data, . + * @return string Returns a chunk of uncompressed data. * @throws ZlibException * */ @@ -546,7 +546,7 @@ function inflate_add($context, string $encoded_data, int $flush_mode = ZLIB_SYNC * A string or an array of strings * of the preset dictionary (default: no preset dictionary). * @return resource Returns an inflate context resource (zlib.inflate) on - * success, . + * success. * @throws ZlibException * */ @@ -566,7 +566,7 @@ function inflate_init(int $encoding, array $options = null) * * @param string $data * @param int $max_decoded_len - * @return string Returns the uncompressed data, . + * @return string Returns the uncompressed data. * @throws ZlibException * */ diff --git a/generator/src/Method.php b/generator/src/Method.php index c69ebfe7..19c40a40 100644 --- a/generator/src/Method.php +++ b/generator/src/Method.php @@ -149,7 +149,7 @@ private function stripReturnFalseText(string $string): string private function removeString(string $string, string $search): string { $search = str_replace(' ', '\s+', $search); - return preg_replace('/'.$search.'/m', '', $string); + return preg_replace('/[\s\,]*'.$search.'/m', '', $string); } private function getStringForXPath(string $xpath): string From 0ca738b02a871a332e70ac5344d6815e6f7bb826 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Deruss=C3=A9?= Date: Wed, 27 Feb 2019 23:16:35 +0100 Subject: [PATCH 3/3] Add parse-url method --- generated/functionsList.php | 1 + generated/ibmDb2.php | 2 +- generated/url.php | 87 +++++++++++++++++++++++++++++++++++++ generator/src/DocPage.php | 3 ++ generator/src/Method.php | 1 + rector-migrate.yml | 1 + 6 files changed, 94 insertions(+), 1 deletion(-) diff --git a/generated/functionsList.php b/generated/functionsList.php index 26ca7d76..4a4954e9 100644 --- a/generated/functionsList.php +++ b/generated/functionsList.php @@ -1027,6 +1027,7 @@ 'uopz_implement', 'base64_decode', 'get_headers', + 'parse_url', 'settype', 'xdiff_file_bdiff', 'xdiff_file_bpatch', diff --git a/generated/ibmDb2.php b/generated/ibmDb2.php index c936bdaa..c47dd89a 100644 --- a/generated/ibmDb2.php +++ b/generated/ibmDb2.php @@ -35,7 +35,7 @@ * @return mixed 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 - * 0 indicates that AUTOCOMMIT is off, while a value of 1 indicates that + * DB2_AUTOCOMMIT_OFF indicates that AUTOCOMMIT is off, while a value of DB2_AUTOCOMMIT_ON indicates that * AUTOCOMMIT is on. * * When db2_autocommit receives both the diff --git a/generated/url.php b/generated/url.php index b0c2b4f4..56c08b55 100644 --- a/generated/url.php +++ b/generated/url.php @@ -55,3 +55,90 @@ function get_headers(string $url, int $format = 0, $context = null): array } return $result; } + + +/** + * This function parses a URL and returns an associative array containing any + * of the various components of the URL that are present. + * The values of the array elements are not URL decoded. + * + * This function is not meant to validate + * the given URL, it only breaks it up into the above listed parts. Partial + * URLs are also accepted, parse_url tries its best to + * parse them correctly. + * + * @param string $url The URL to parse. Invalid characters are replaced by + * _. + * @param int $component Specify one of PHP_URL_SCHEME, + * PHP_URL_HOST, PHP_URL_PORT, + * PHP_URL_USER, PHP_URL_PASS, + * PHP_URL_PATH, PHP_URL_QUERY + * or PHP_URL_FRAGMENT to retrieve just a specific + * URL component as a string (except when + * PHP_URL_PORT is given, in which case the return + * value will be an integer). + * @return mixed On seriously malformed URLs, parse_url. + * + * If the component parameter is omitted, an + * associative array is returned. At least one element will be + * present within the array. Potential keys within this array are: + * + * + * + * scheme - e.g. http + * + * + * + * + * host + * + * + * + * + * port + * + * + * + * + * user + * + * + * + * + * pass + * + * + * + * + * path + * + * + * + * + * query - after the question mark ? + * + * + * + * + * fragment - after the hashmark # + * + * + * + * + * If the component parameter is specified, + * parse_url returns a string (or an + * integer, in the case of PHP_URL_PORT) + * instead of an array. If the requested component doesn't exist + * within the given URL, NULL will be returned. + * @throws UrlException + * + */ +function parse_url(string $url, int $component = -1) +{ + error_clear_last(); + $result = \parse_url($url, $component); + if ($result === false) { + throw UrlException::createFromPhpError(); + } + return $result; +} diff --git a/generator/src/DocPage.php b/generator/src/DocPage.php index 96354836..1c859c52 100644 --- a/generator/src/DocPage.php +++ b/generator/src/DocPage.php @@ -56,6 +56,9 @@ public function detectFalsyFunction(): bool if (preg_match('/&false;\s+otherwise/m', $file) && !preg_match('/(returns\s+&true;|&true;\s+on\s+success|&true;\s+if)/im', $file)) { return true; } + if (preg_match('/may\s+return\s+&false;/m', $file) && !preg_match('/(returns\s+&true;|&true;\s+on\s+success|&true;\s+if)/im', $file)) { + return true; + } if (preg_match('/&false;\s+if\s+an\s+error\s+occurred/m', $file)) { return true; } diff --git a/generator/src/Method.php b/generator/src/Method.php index 19c40a40..fd216bb5 100644 --- a/generator/src/Method.php +++ b/generator/src/Method.php @@ -132,6 +132,7 @@ private function stripReturnFalseText(string $string): string { $string = \strip_tags($string); $string = $this->removeString($string, 'or FALSE on failure'); + $string = $this->removeString($string, 'may return FALSE'); $string = $this->removeString($string, 'and FALSE on failure'); $string = $this->removeString($string, 'on success, or FALSE otherwise'); $string = $this->removeString($string, 'or FALSE on error'); diff --git a/rector-migrate.yml b/rector-migrate.yml index fa7f832e..e55e4213 100644 --- a/rector-migrate.yml +++ b/rector-migrate.yml @@ -1028,6 +1028,7 @@ services: uopz_implement: 'Safe\uopz_implement' base64_decode: 'Safe\base64_decode' get_headers: 'Safe\get_headers' + parse_url: 'Safe\parse_url' settype: 'Safe\settype' xdiff_file_bdiff: 'Safe\xdiff_file_bdiff' xdiff_file_bpatch: 'Safe\xdiff_file_bpatch'