From ea4d53c2d4fa3235bbe17d374d37c301db421270 Mon Sep 17 00:00:00 2001 From: Artemy Pestretsov Date: Wed, 26 Jun 2019 15:26:31 +0300 Subject: [PATCH 1/2] Add hand-picked changes from pr553 --- Core/Core.php | 6 +- Core/Core_c.php | 4 +- Ev/Ev.php | 4 +- PDO/PDO.php | 8 +- PhpStormStubsMap.php | 17 +++ Reflection/Reflection.php | 24 ++-- SPL/SPL.php | 2 +- SPL/SPL_c1.php | 20 ++-- SQLite/SQLite.php | 24 ++-- SimpleXML/SimpleXML.php | 2 +- Zend OPcache/OPcache.php | 6 +- ZendCache/ZendCache.php | 16 +-- amqp/amqp.php | 86 +++++++-------- apcu/apcu.php | 16 +-- bz2/bz2.php | 4 +- couchbase/couchbase.php | 10 +- curl/curl.php | 14 +-- date/date.php | 4 +- date/date_c.php | 16 +-- dba/dba.php | 2 +- dom/dom_c.php | 6 +- enchant/enchant.php | 6 +- exif/exif.php | 6 +- fann/fann.php | 120 ++++++++++---------- ffmpeg/ffmpeg.php | 6 +- filter/filter.php | 2 +- ftp/ftp.php | 6 +- gearman/gearman.php | 26 ++--- geoip/geoip.php | 22 ++-- gmagick/gmagick.php | 6 +- gmp/gmp.php | 4 +- gnupg/gnupg.php | 18 +-- hash/hash.php | 10 +- http/http.php | 61 +++++------ ibm_db2/ibm_db2.php | 4 +- imagick/imagick.php | 12 +- imap/imap.php | 20 ++-- inotify/inotify.php | 4 +- interbase/interbase.php | 26 ++--- intl/IntlChar.php | 10 +- intl/intl.php | 108 +++++++++--------- ldap/ldap.php | 22 ++-- libevent/libevent.php | 10 +- mailparse/mailparse.php | 2 +- mapscript/mapscript.php | 30 ++--- mcrypt/mcrypt.php | 12 +- memcache/memcache.php | 30 ++--- memcached/memcached.php | 16 +-- mongo/mongo.php | 50 ++++----- mongodb/mongodb.php | 20 ++-- mssql/mssql.php | 12 +- mysql/mysql.php | 42 +++---- mysqli/mysqli.php | 38 +++---- newrelic/newrelic.php | 26 ++--- oauth/oauth.php | 2 +- oci8/oci8.php | 44 ++++---- odbc/odbc.php | 40 +++---- openssl/openssl.php | 46 ++++---- pcntl/pcntl.php | 2 +- pgsql/pgsql.php | 46 ++++---- posix/posix.php | 4 +- pspell/pspell.php | 4 +- radius/radius.php | 4 +- rar/rar.php | 28 ++--- rdkafka/RdKafka/Metadata/Collection.php | 2 +- recode/recode.php | 2 +- redis/Redis.php | 66 +++++------ redis/RedisCluster.php | 140 ++++++++++++------------ rrd/rrd.php | 14 +-- shmop/shmop.php | 4 +- snmp/snmp.php | 20 ++-- sockets/sockets.php | 8 +- sodium/sodium.php | 41 +++++-- solr/Documents/SolrDocument.php | 6 +- solr/Documents/SolrInputDocument.php | 12 +- solr/Queries/SolrParams.php | 10 +- solr/Utils/SolrUtils.php | 2 +- solr/functions.php | 2 +- sqlite3/sqlite3.php | 6 +- sqlsrv/sqlsrv.php | 10 +- ssh2/ssh2.php | 4 +- standard/_standard_manual.php | 4 +- standard/password.php | 4 +- standard/standard_0.php | 10 +- standard/standard_1.php | 20 ++-- standard/standard_2.php | 12 +- standard/standard_3.php | 6 +- standard/standard_4.php | 8 +- standard/standard_5.php | 30 ++--- standard/standard_6.php | 20 ++-- standard/standard_8.php | 6 +- standard/standard_9.php | 9 +- suhosin/suhosin.php | 2 +- svn/svn.php | 4 +- sybase/sybase_ct.php | 10 +- sysvsem/sysvsem.php | 2 +- wddx/wddx.php | 6 +- win32service/win32service.php | 14 +-- wincache/wincache.php | 42 +++---- xml/xml.php | 8 +- xmlreader/xmlreader.php | 6 +- xsl/xsl.php | 8 +- yaf/yaf.php | 14 +-- yaf/yaf_namespace.php | 14 +-- yar/yar.php | 10 +- zend/zend.php | 46 ++++---- zend/zend_f.php | 22 ++-- zip/zip.php | 8 +- zlib/zlib.php | 28 ++--- 109 files changed, 1026 insertions(+), 994 deletions(-) diff --git a/Core/Core.php b/Core/Core.php index 16701d0a..a3e88055 100644 --- a/Core/Core.php +++ b/Core/Core.php @@ -404,7 +404,7 @@ function property_exists ($class, $property) {} * Checks if the trait exists * @param string $traitname Name of the trait to check * @param bool $autoload [optional] Whether to autoload if not already loaded. - * @return boolean Returns TRUE if trait exists, FALSE if not, NULL in case of an error. + * @return bool Returns TRUE if trait exists, FALSE if not, NULL in case of an error. * @link https://secure.php.net/manual/en/function.trait-exists.php * @since 5.4.0 */ @@ -558,7 +558,7 @@ function get_class_vars ($class_name) {} * @param object $object

* An object instance. *

- * @return array an associative array of defined object accessible non-static properties + * @return array an associative array of defined object accessible non-static properties * for the specified object in scope. If a property have * not been assigned a value, it will be returned with a null value. * @since 4.0 @@ -831,7 +831,7 @@ function extension_loaded ($name) {} *

* This parameter must be in lowercase. *

- * @return array an array with all the functions, or false if + * @return array an array with all the functions, or false if * module_name is not a valid extension. * @since 4.0 * @since 5.0 diff --git a/Core/Core_c.php b/Core/Core_c.php index 3139e392..e27b9c82 100644 --- a/Core/Core_c.php +++ b/Core/Core_c.php @@ -74,7 +74,7 @@ interface Iterator extends Traversable { /** * Checks if current position is valid * @link https://php.net/manual/en/iterator.valid.php - * @return boolean The return value will be casted to boolean and then evaluated. + * @return bool The return value will be casted to boolean and then evaluated. * Returns true on success or false on failure. * @since 5.0.0 */ @@ -101,7 +101,7 @@ interface ArrayAccess { * @param mixed $offset

* An offset to check for. *

- * @return boolean true on success or false on failure. + * @return bool true on success or false on failure. *

*

* The return value will be casted to boolean if non-boolean was returned. diff --git a/Ev/Ev.php b/Ev/Ev.php index 9af54a0c..17554266 100644 --- a/Ev/Ev.php +++ b/Ev/Ev.php @@ -388,8 +388,8 @@ final class Ev /** * Class EvWatcher * - * @property-read $is_active boolean TRUE if the watcher is active. FALSE otherwise. - * @property-read $is_pending boolean TRUE if the watcher is pending, i.e. it has outstanding events, but its callback + * @property-read $is_active bool TRUE if the watcher is active. FALSE otherwise. + * @property-read $is_pending bool TRUE if the watcher is pending, i.e. it has outstanding events, but its callback * has not yet been invoked. FALSE otherwise. As long, as a watcher is pending (but not active), one must not * change its priority. */ diff --git a/PDO/PDO.php b/PDO/PDO.php index f5f761e6..f8424c82 100644 --- a/PDO/PDO.php +++ b/PDO/PDO.php @@ -941,7 +941,7 @@ class PDO { *

* Data inside the query should be properly escaped. *

- * @return int PDO::exec returns the number of rows that were modified + * @return int|false PDO::exec returns the number of rows that were modified * or deleted by the SQL statement you issued. If no rows were affected, * PDO::exec returns 0. *

@@ -1116,7 +1116,7 @@ class PDO { * @param int $parameter_type [optional]

* Provides a data type hint for drivers that have alternate quoting styles. *

- * @return string a quoted string that is theoretically safe to pass into an + * @return string|false a quoted string that is theoretically safe to pass into an * SQL statement. Returns FALSE if the driver does not support quoting in * this way. */ @@ -1471,7 +1471,7 @@ class PDOStatement implements Traversable { * @param int $column

* The 0-indexed column in the result set. *

- * @return array an associative array containing the following values representing + * @return array|false an associative array containing the following values representing * the metadata for a single column: *

* @@ -1537,7 +1537,7 @@ class PDOStatement implements Traversable { * Class name or object *

* @param array $ctorarfg [optional]

Constructor arguments.

- * @return bool 1 on success or FALSE on failure. + * @return bool TRUE on success or FALSE on failure. */ public function setFetchMode ($mode, $classNameObject = null, array $ctorarfg = array()) {} diff --git a/PhpStormStubsMap.php b/PhpStormStubsMap.php index 57ab51bd..35ccfc58 100644 --- a/PhpStormStubsMap.php +++ b/PhpStormStubsMap.php @@ -9615,6 +9615,10 @@ const CONSTANTS = array ( 'SOCK_RDM' => 'sockets/sockets.php', 'SOCK_SEQPACKET' => 'sockets/sockets.php', 'SOCK_STREAM' => 'sockets/sockets.php', + 'SODIUM_BASE64_VARIANT_ORIGINAL' => 'sodium/sodium.php', + 'SODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDING' => 'sodium/sodium.php', + 'SODIUM_BASE64_VARIANT_URLSAFE' => 'sodium/sodium.php', + 'SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING' => 'sodium/sodium.php', 'SODIUM_CRYPTO_AEAD_AES256GCM_ABYTES' => 'sodium/sodium.php', 'SODIUM_CRYPTO_AEAD_AES256GCM_KEYBYTES' => 'sodium/sodium.php', 'SODIUM_CRYPTO_AEAD_AES256GCM_NPUBBYTES' => 'sodium/sodium.php', @@ -9627,6 +9631,10 @@ const CONSTANTS = array ( 'SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_KEYBYTES' => 'sodium/sodium.php', 'SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_NPUBBYTES' => 'sodium/sodium.php', 'SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_NSECBYTES' => 'sodium/sodium.php', + 'SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES' => 'sodium/sodium.php', + 'SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES' => 'sodium/sodium.php', + 'SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES' => 'sodium/sodium.php', + 'SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NSECBYTES' => 'sodium/sodium.php', 'SODIUM_CRYPTO_AUTH_BYTES' => 'sodium/sodium.php', 'SODIUM_CRYPTO_AUTH_KEYBYTES' => 'sodium/sodium.php', 'SODIUM_CRYPTO_BOX_KEYPAIRBYTES' => 'sodium/sodium.php', @@ -9653,6 +9661,7 @@ const CONSTANTS = array ( 'SODIUM_CRYPTO_KX_SEEDBYTES' => 'sodium/sodium.php', 'SODIUM_CRYPTO_KX_SESSIONKEYBYTES' => 'sodium/sodium.php', 'SODIUM_CRYPTO_PWHASH_ALG_ARGON2I13' => 'sodium/sodium.php', + 'SODIUM_CRYPTO_PWHASH_ALG_ARGON2ID13' => 'sodium/sodium.php', 'SODIUM_CRYPTO_PWHASH_ALG_DEFAULT' => 'sodium/sodium.php', 'SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE' => 'sodium/sodium.php', 'SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE' => 'sodium/sodium.php', @@ -9673,6 +9682,14 @@ const CONSTANTS = array ( 'SODIUM_CRYPTO_SECRETBOX_KEYBYTES' => 'sodium/sodium.php', 'SODIUM_CRYPTO_SECRETBOX_MACBYTES' => 'sodium/sodium.php', 'SODIUM_CRYPTO_SECRETBOX_NONCEBYTES' => 'sodium/sodium.php', + 'SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_ABYTES' => 'sodium/sodium.php', + 'SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_HEADERBYTES' => 'sodium/sodium.php', + 'SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_KEYBYTES' => 'sodium/sodium.php', + 'SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_MESSAGEBYTES_MAX' => 'sodium/sodium.php', + 'SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL' => 'sodium/sodium.php', + 'SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE' => 'sodium/sodium.php', + 'SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_PUSH' => 'sodium/sodium.php', + 'SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_REKEY' => 'sodium/sodium.php', 'SODIUM_CRYPTO_SHORTHASH_BYTES' => 'sodium/sodium.php', 'SODIUM_CRYPTO_SHORTHASH_KEYBYTES' => 'sodium/sodium.php', 'SODIUM_CRYPTO_SIGN_BYTES' => 'sodium/sodium.php', diff --git a/Reflection/Reflection.php b/Reflection/Reflection.php index cffb7a1e..5e2f2de5 100644 --- a/Reflection/Reflection.php +++ b/Reflection/Reflection.php @@ -156,7 +156,7 @@ abstract class ReflectionFunctionAbstract implements Reflector { /** * Gets doc comment * @link https://php.net/manual/en/reflectionfunctionabstract.getdoccomment.php - * @return string|bool The doc comment if it exists, otherwise FALSE + * @return string|false The doc comment if it exists, otherwise FALSE * @since 5.1.0 */ public function getDocComment () {} @@ -164,7 +164,7 @@ abstract class ReflectionFunctionAbstract implements Reflector { /** * Gets end line number * @link https://php.net/manual/en/reflectionfunctionabstract.getendline.php - * @return int The ending line number of the user defined function, or FALSE if unknown. + * @return int|false The ending line number of the user defined function, or FALSE if unknown. * @since 5.0 */ public function getEndLine () {} @@ -236,7 +236,7 @@ abstract class ReflectionFunctionAbstract implements Reflector { /** * Gets the specified return type of a function * @link https://php.net/manual/en/reflectionfunctionabstract.getreturntype.php - * @return ReflectionType|NULL Returns a ReflectionType object if a return type is specified, NULL otherwise. + * @return ReflectionType|null Returns a ReflectionType object if a return type is specified, NULL otherwise. * @since 7.0 */ public function getReturnType () {} @@ -458,7 +458,7 @@ class ReflectionParameter implements Reflector { /** * Gets a parameter's type * @link https://php.net/manual/en/reflectionparameter.gettype.php - * @return ReflectionType|NULL Returns a ReflectionType object if a parameter type is specified, NULL otherwise. + * @return ReflectionType|null Returns a ReflectionType object if a parameter type is specified, NULL otherwise. * @since 7.0 */ public function getType() {} @@ -524,7 +524,7 @@ class ReflectionParameter implements Reflector { /** * Returns whether parameter MUST be callable * @link https://php.net/manual/en/reflectionparameter.iscallable.php - * @return bool Returns TRUE if the parameter is callable, FALSE if it is not or NULL on failure. + * @return bool|null Returns TRUE if the parameter is callable, FALSE if it is not or NULL on failure. * @since 5.4.0 */ public function isCallable () {} @@ -572,7 +572,7 @@ class ReflectionParameter implements Reflector { /** * Returns whether the default value of this parameter is constant - * @return boolean + * @return bool * @since 5.4.6 */ public function isDefaultValueConstant () {} @@ -944,7 +944,7 @@ class ReflectionClass implements Reflector { /** * Gets the filename of the file in which the class has been defined * @link https://php.net/manual/en/reflectionclass.getfilename.php - * @return string the filename of the file in which the class has been defined. + * @return string|false the filename of the file in which the class has been defined. * If the class is defined in the PHP core or in a PHP extension, FALSE * is returned. * @since 5.0 @@ -962,7 +962,7 @@ class ReflectionClass implements Reflector { /** * Gets end line * @link https://php.net/manual/en/reflectionclass.getendline.php - * @return int The ending line number of the user defined class, or FALSE if unknown. + * @return int|false The ending line number of the user defined class, or FALSE if unknown. * @since 5.0 */ public function getEndLine () {} @@ -970,7 +970,7 @@ class ReflectionClass implements Reflector { /** * Gets doc comments * @link https://php.net/manual/en/reflectionclass.getdoccomment.php - * @return string|bool The doc comment if it exists, otherwise FALSE + * @return string|false The doc comment if it exists, otherwise FALSE * @since 5.1.0 */ public function getDocComment () {} @@ -1355,7 +1355,7 @@ class ReflectionClass implements Reflector { /** * Gets the name of the extension which defined the class * @link https://php.net/manual/en/reflectionclass.getextensionname.php - * @return string The name of the extension which defined the class, or FALSE for user-defined classes. + * @return string|false The name of the extension which defined the class, or FALSE for user-defined classes. * @since 5.0 */ public function getExtensionName () {} @@ -1581,7 +1581,7 @@ class ReflectionProperty implements Reflector { /** * Gets doc comment * @link https://php.net/manual/en/reflectionproperty.getdoccomment.php - * @return string|bool The doc comment if it exists, otherwise FALSE + * @return string|false The doc comment if it exists, otherwise FALSE * @since 5.1.0 */ public function getDocComment () {} @@ -2052,7 +2052,7 @@ class ReflectionClassConstant implements Reflector { * Gets doc comments * @since 7.1 * @link https://php.net/manual/en/reflectionclassconstant.getdoccomment.php - * @return string|bool The doc comment if it exists, otherwise FALSE + * @return string|false The doc comment if it exists, otherwise FALSE */ public function getDocComment() {} diff --git a/SPL/SPL.php b/SPL/SPL.php index 2c6e320a..11c33d78 100644 --- a/SPL/SPL.php +++ b/SPL/SPL.php @@ -137,7 +137,7 @@ class EmptyIterator implements Iterator { /** * Checks if current position is valid * @link https://php.net/manual/en/iterator.valid.php - * @return boolean The return value will be casted to boolean and then evaluated. + * @return bool The return value will be casted to boolean and then evaluated. * Returns true on success or false on failure. * @since 5.0.0 */ diff --git a/SPL/SPL_c1.php b/SPL/SPL_c1.php index c67907f8..540e8cc7 100644 --- a/SPL/SPL_c1.php +++ b/SPL/SPL_c1.php @@ -618,7 +618,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, SeekableIt /** * Gets line from file * @link https://php.net/manual/en/splfileobject.fgets.php - * @return string a string containing the next line from the file, or false on error. + * @return string|false a string containing the next line from the file, or false on error. * @since 5.1.0 */ public function fgets () {} @@ -629,7 +629,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, SeekableIt * @param int $length

* The number of bytes to read. *

- * @return string returns the string read from the file or FALSE on failure. + * @return string|false returns the string read from the file or FALSE on failure. * @since 5.5.11 */ public function fread ($length) {} @@ -668,7 +668,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, SeekableIt * The field enclosure character (one character only). Defaults as a double quotation mark or the value set using SplFileObject::setCsvControl. *

* @param string $escape The optional escape parameter sets the escape character (one character only). - * @return int Returns the length of the written string or FALSE on failure. + * @return int|false Returns the length of the written string or FALSE on failure. * @since 5.4.0 *

*/ @@ -724,7 +724,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, SeekableIt /** * Return current file position * @link https://php.net/manual/en/splfileobject.ftell.php - * @return int the position of the file pointer as an integer, or false on error. + * @return int|false the position of the file pointer as an integer, or false on error. * @since 5.1.0 */ public function ftell () {} @@ -754,7 +754,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, SeekableIt /** * Gets character from file * @link https://php.net/manual/en/splfileobject.fgetc.php - * @return string a string containing a single character read from the file or false on EOF. + * @return string|false a string containing a single character read from the file or false on EOF. * @since 5.1.0 */ public function fgetc () {} @@ -762,7 +762,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, SeekableIt /** * Output all remaining data on a file pointer * @link https://php.net/manual/en/splfileobject.fpassthru.php - * @return int the number of characters read from handle + * @return int|false the number of characters read from handle * and passed through to the output. * @since 5.1.0 */ @@ -775,7 +775,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, SeekableIt * You can use the optional third parameter to specify tags which should * not be stripped. *

- * @return string a string containing the next line of the file with HTML and PHP + * @return string|false a string containing the next line of the file with HTML and PHP * code stripped, or false on error. * @since 5.1.0 * @deprecated 7.3 @@ -937,7 +937,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, SeekableIt /** * Alias of SplFileObject::fgets * @link https://php.net/manual/en/splfileobject.getcurrentline.php - * @return string Returns a string containing the next line from the file, or FALSE on error. + * @return string|false Returns a string containing the next line from the file, or FALSE on error. * @since 5.1.2 */ public function getCurrentLine () {} @@ -2153,7 +2153,7 @@ class MultipleIterator implements Iterator { * @param Iterator $iterator

* The new iterator to attach. *

- * @param string $infos [optional]

+ * @param int|string|null $infos [optional]

* The associative information for the Iterator, which must be an * integer, a string, or null. *

@@ -2203,7 +2203,7 @@ class MultipleIterator implements Iterator { /** * Checks the validity of sub iterators * @link https://php.net/manual/en/multipleiterator.valid.php - * @return boolean true if one or all sub iterators are valid depending on flags, + * @return bool true if one or all sub iterators are valid depending on flags, * otherwise false * @since 5.3.0 */ diff --git a/SQLite/SQLite.php b/SQLite/SQLite.php index f2bf5896..285b3e1a 100644 --- a/SQLite/SQLite.php +++ b/SQLite/SQLite.php @@ -28,7 +28,7 @@ class SQLiteDatabase { * @param $result_type [optional] *

The optional result_type parameter accepts a constant and determines how the returned array will be indexed. Using SQLITE_ASSOC will return only associative indices (named fields) while SQLITE_NUM will return only numerical indices (ordinal field numbers). SQLITE_BOTH will return both associative and numerical indices. SQLITE_BOTH is the default for this function.

* @param $error_message [optional]

The specified variable will be filled if an error occurs. This is specially important because SQL syntax errors can't be fetched using the {@see sqlite_last_error()} function.

- * @return resource|bool

+ * @return resource|false

* This function will return a result handle or FALSE on failure. * For queries that return rows, the result handle can then be used with * functions such as {@see sqlite_fetch_array()} and @@ -61,7 +61,7 @@ class SQLiteDatabase { *

* @param string $error_message [optional]

The specified variable will be filled if an error occurs. This is specially important because SQL syntax errors can't be fetched using the * {@see sqlite_last_error()} function.

- * @return boolean

+ * @return bool

* This function will return a boolean result; TRUE for success or FALSE for failure. * If you need to run a query that returns rows, see {@see sqlite_query()}. *

@@ -381,7 +381,7 @@ final class SQLiteResult implements Iterator, Countable { /** * Checks if current position is valid * @link https://php.net/manual/en/iterator.valid.php - * @return boolean

+ * @return bool

* Returns TRUE if there are more rows available from the * result handle, or FALSE otherwise. *

@@ -411,7 +411,7 @@ final class SQLiteResult implements Iterator, Countable { /** * Seek to the previous row number of a result set * @link https://php.net/manual/en/function.sqlite-prev.php - * @return boolean

Returns TRUE on success, or FALSE if there are no more previous rows. + * @return bool

Returns TRUE on success, or FALSE if there are no more previous rows. *

* @since 5.4.0 */ @@ -562,7 +562,7 @@ final class SQLiteException extends RuntimeException { * Passed by reference and is set to hold a descriptive error message * explaining why the database could not be opened if there was an error. *

- * @return resource a resource (database handle) on success, false on error. + * @return resource|false a resource (database handle) on success, false on error. */ function sqlite_open ($filename, $mode = null, &$error_message = null) {} @@ -586,7 +586,7 @@ function sqlite_open ($filename, $mode = null, &$error_message = null) {} * Passed by reference and is set to hold a descriptive error message * explaining why the database could not be opened if there was an error. *

- * @return resource

a resource (database handle) on success, false on error.

+ * @return resource|false

a resource (database handle) on success, false on error.

*/ function sqlite_popen ($filename, $mode = null, &$error_message = null) {} @@ -627,7 +627,7 @@ function sqlite_close ($dbhandle) {} * the * {@see sqlite_last_error} function. *

- * @return resource This function will return a result handle or FALSE on failure. + * @return resource|false This function will return a result handle or FALSE on failure. * For queries that return rows, the result handle can then be used with * functions such as * {@see sqlite_fetch_array} and @@ -703,7 +703,7 @@ function sqlite_exec ($dbhandle, $query, &$error_msg = null) {} * {@link sqlite_escape_string()}. You should normally leave this * value at its default, unless you are interoperating with databases created by * other sqlite capable applications.

- * @return array an array of the entire result set; false otherwise. + * @return array|false an array of the entire result set; false otherwise. *

The column names returned by * SQLITE_ASSOC and SQLITE_BOTH will be * case-folded according to the value of the @@ -731,7 +731,7 @@ function sqlite_single_query ($db, $query, $first_row_only = null, $decode_binar * @param resource $result

The SQLite result resource. This parameter is not required when using the object-oriented method.

* @param int $result_type [optional] &sqlite.result-type; * @param bool $decode_binary [optional] &sqlite.decode-bin; - * @return array

an array of the next row from a result set; false if the + * @return array|false

an array of the next row from a result set; false if the * next position is beyond the final row.

*/ function sqlite_fetch_array ($result, $result_type = SQLITE_BOTH, $decode_binary = null) {} @@ -802,7 +802,7 @@ function sqlite_fetch_all ($result_type = null, $decode_binary = null) {} * @param resource $result

The SQLite result resource. This parameter is not required when using the object-oriented method.

* @param int $result_type [optional]

The optional result_type parameter accepts a constant and determines how the returned array will be indexed. Using SQLITE_ASSOC will return only associative indices (named fields) while SQLITE_NUM will return only numerical indices (ordinal field numbers). SQLITE_BOTH will return both associative and numerical indices. SQLITE_BOTH is the default for this function.

* @param bool $decode_binary [optional]

When the decode_binary parameter is set to TRUE (the default), PHP will decode the binary encoding it applied to the data if it was encoded using the sqlite_escape_string(). You should normally leave this value at its default, unless you are interoperating with databases created by other sqlite capable applications.

- * @return array an array of the current row from a result set; false if the + * @return array|false an array of the current row from a result set; false if the * current position is beyond the final row. */ function sqlite_current ($result, $result_type = null, $decode_binary = null) {} @@ -1081,7 +1081,7 @@ function sqlite_error_string ($error_code) {} * specially important because SQL syntax errors can't be fetched using * the sqlite_last_error function. *

- * @return SQLiteUnbuffered a result handle or false on failure. + * @return SQLiteUnbuffered|false a result handle or false on failure. *

*

* sqlite_unbuffered_query returns a sequential @@ -1201,7 +1201,7 @@ function sqlite_udf_decode_binary ($data) {} * numerical indices. SQLITE_ASSOC is the default for * this function. *

- * @return array an array of column data types; false on error. + * @return array|false an array of column data types; false on error. * @since 5.0 */ function sqlite_fetch_column_types ($dbhandle, $table_name, $result_type = null) {} diff --git a/SimpleXML/SimpleXML.php b/SimpleXML/SimpleXML.php index 1d7a93b3..7067057a 100644 --- a/SimpleXML/SimpleXML.php +++ b/SimpleXML/SimpleXML.php @@ -220,7 +220,7 @@ class SimpleXMLElement implements Traversable, ArrayAccess, Countable { * Class provides access to children by position, and attributes by name * @access private Method not callable directly, stub exists for typehint only * @param string|int $offset - * @return boolean true on success or false on failure. + * @return bool true on success or false on failure. */ private function offsetExists ($offset) {} diff --git a/Zend OPcache/OPcache.php b/Zend OPcache/OPcache.php index 00326080..11db3159 100644 --- a/Zend OPcache/OPcache.php +++ b/Zend OPcache/OPcache.php @@ -5,7 +5,7 @@ * Compiles and caches a PHP script without executing it * @link https://secure.php.net/manual/en/function.opcache-compile-file.php * @param string $file The path to the PHP script to be compiled. - * @return boolean + * @return bool * Returns TRUE if the opcode cache for script was * invalidated or if there was nothing to invalidate, or FALSE if the opcode * cache is disabled. @@ -18,7 +18,7 @@ function opcache_compile_file($file) { } * @link https://secure.php.net/manual/en/function.opcache-invalidate.php * @param string $script

The path to the script being invalidated.

* @param bool $force [optional]

If set to TRUE, the script will be invalidated regardless of whether invalidation is necessary.

- * @return boolean + * @return bool * Returns TRUE if the opcode cache for script was * invalidated or if there was nothing to invalidate, or FALSE if the opcode * cache is disabled. @@ -29,7 +29,7 @@ function opcache_invalidate($script, $force = FALSE) { } * (PHP 5 >= 5.5.0, PECL ZendOpcache >= 7.0.0 )
* Resets the contents of the opcode cache * @link https://secure.php.net/manual/en/function.opcache-reset.php - * @return boolean Returns TRUE if the opcode cache was reset, or FALSE if the opcode cache is disabled. + * @return bool Returns TRUE if the opcode cache was reset, or FALSE if the opcode cache is disabled. */ function opcache_reset() { } diff --git a/ZendCache/ZendCache.php b/ZendCache/ZendCache.php index 8b33f8b8..fd001eb1 100644 --- a/ZendCache/ZendCache.php +++ b/ZendCache/ZendCache.php @@ -9,7 +9,7 @@ * @param $value mixed can be any PHP object that can be serialized. * @param $ttl int [optional] time to live in seconds. ZendCache keeps the objects in the cache as long as the TTL is no expired, once expired it will be removed from the cache * - * @return boolean FALSE when stored failed, TRUE otherwise + * @return bool FALSE when stored failed, TRUE otherwise */ function zend_shm_cache_store($key, $value, $ttl = 0) {} @@ -19,7 +19,7 @@ function zend_shm_cache_store($key, $value, $ttl = 0) {} * * @param $key string the data's key. Possibly prefixed with namespace * - * @return NULL|mixed NULL when no data matching the key is found, else it returns the stored data + * @return null|mixed NULL when no data matching the key is found, else it returns the stored data */ function zend_shm_cache_fetch($key) {} @@ -28,7 +28,7 @@ function zend_shm_cache_fetch($key) {} * * @param $key string the data's key. Possibly prefixed with namespace * - * @return NULL|mixed when no data matching the key is found, else it returns the stored data + * @return null|mixed when no data matching the key is found, else it returns the stored data */ function zend_shm_cache_delete($key) {} @@ -37,7 +37,7 @@ function zend_shm_cache_delete($key) {} * * @param $namespace string [optional] Namespace to clear. If blank or is not passed, it will clear entire cache. * - * @return boolean TRUE on success, FALSE otherwise + * @return bool TRUE on success, FALSE otherwise */ function zend_shm_cache_clear($namespace = '') {} @@ -48,7 +48,7 @@ function zend_shm_cache_clear($namespace = '') {} * @param $value mixed can be any PHP object that can be serialized * @param $ttl [optional] int time to live in seconds. ZendCache keeps the objects in the cache as long as the TTL is no expired, once expired it will be removed from the cache * - * @return boolean FALSE when stored failed, TRUE otherwise + * @return bool FALSE when stored failed, TRUE otherwise */ function zend_disk_cache_store($key, $value, $ttl = 0) {} @@ -57,7 +57,7 @@ function zend_disk_cache_store($key, $value, $ttl = 0) {} * * @param $key string NULL when no data matching the key is found, else it returns the stored data * - * @return NULL|mixed NULL when no data matching the key is found, else it returns the stored data + * @return null|mixed NULL when no data matching the key is found, else it returns the stored data */ function zend_disk_cache_fetch($key) {} @@ -66,7 +66,7 @@ function zend_disk_cache_fetch($key) {} * * @param $key string the data's key. Possibly prefixed with namespace * - * @return NULL|mixed when no data matching the key is found, else it returns the stored data + * @return null|mixed when no data matching the key is found, else it returns the stored data */ function zend_disk_cache_delete($key) {} @@ -75,7 +75,7 @@ function zend_disk_cache_delete($key) {} * * @param $namespace string [optional] Namespace to clear. If blank or is not passed, it will clear entire cache. * - * @return boolean TRUE on success, FALSE otherwise + * @return bool TRUE on success, FALSE otherwise */ function zend_disk_cache_clear($namespace = '') {} diff --git a/amqp/amqp.php b/amqp/amqp.php index 1fb5c41b..b081556f 100644 --- a/amqp/amqp.php +++ b/amqp/amqp.php @@ -364,7 +364,7 @@ class AMQPChannel * * @throws AMQPConnectionException If the connection to the broker was lost. * - * @return boolean TRUE on success or FALSE on failure. + * @return bool TRUE on success or FALSE on failure. */ public function setPrefetchCount($count) { } @@ -511,7 +511,7 @@ class AMQPConnection * This method will initiate a connection with the AMQP broker. * * @throws AMQPConnectionException - * @return boolean TRUE on success or throw an exception on failure. + * @return bool TRUE on success or throw an exception on failure. */ public function connect() { } @@ -559,7 +559,7 @@ class AMQPConnection * * This method will close an open connection with the AMQP broker. * - * @return boolean true if connection was successfully closed, false otherwise. + * @return bool TRUE if connection was successfully closed, FALSE otherwise. */ public function disconnect() { } @@ -603,7 +603,7 @@ class AMQPConnection * * It does so by checking the return status of the last connect-command. * - * @return boolean True if connected, false otherwise. + * @return bool TRUE if connected, FALSE otherwise. */ public function isConnected() { } @@ -614,7 +614,7 @@ class AMQPConnection * or reuse an existing one if present. * * @throws AMQPConnectionException - * @return boolean TRUE on success or throws an exception on failure. + * @return bool TRUE on success or throws an exception on failure. */ public function pconnect() { } @@ -624,8 +624,8 @@ class AMQPConnection * This method will close an open persistent connection with the AMQP * broker. * - * @return boolean true if connection was found and closed, - * false if no persistent connection with this host, + * @return bool TRUE if connection was found and closed, + * FALSE if no persistent connection with this host, * port, vhost and login could be found, */ public function pdisconnect() { } @@ -633,14 +633,14 @@ class AMQPConnection /** * Close any open transient connections and initiate a new one with the AMQP broker. * - * @return boolean TRUE on success or FALSE on failure. + * @return bool TRUE on success or FALSE on failure. */ public function reconnect() { } /** * Close any open persistent connections and initiate a new one with the AMQP broker. * - * @return boolean TRUE on success or FALSE on failure. + * @return bool TRUE on success or FALSE on failure. */ public function preconnect() { } @@ -652,7 +652,7 @@ class AMQPConnection * * @throws AMQPConnectionException If host is longer then 1024 characters. * - * @return boolean TRUE on success or FALSE on failure. + * @return bool TRUE on success or FALSE on failure. */ public function setHost($host) { } @@ -664,7 +664,7 @@ class AMQPConnection * * @throws AMQPConnectionException If login is longer then 32 characters. * - * @return boolean TRUE on success or FALSE on failure. + * @return bool TRUE on success or FALSE on failure. */ public function setLogin($login) { } @@ -676,7 +676,7 @@ class AMQPConnection * * @throws AMQPConnectionException If password is longer then 32characters. * - * @return boolean TRUE on success or FALSE on failure. + * @return bool TRUE on success or FALSE on failure. */ public function setPassword($password) { } @@ -688,7 +688,7 @@ class AMQPConnection * @throws AMQPConnectionException If port is longer not between * 1 and 65535. * - * @return boolean TRUE on success or FALSE on failure. + * @return bool TRUE on success or FALSE on failure. */ public function setPort($port) { } @@ -700,7 +700,7 @@ class AMQPConnection * * @throws AMQPConnectionException If host is longer then 32 characters. * - * @return boolean true on success or false on failure. + * @return bool TRUE on success or FALSE on failure. */ public function setVhost($vhost) { } @@ -953,7 +953,7 @@ class AMQPEnvelope extends AMQPBasicProperties * * @param string $header_key Name of the header to get the value from. * - * @return string|boolean The contents of the specified header or FALSE + * @return string|false The contents of the specified header or FALSE * if not set. */ public function getHeader($header_key) { } @@ -963,7 +963,7 @@ class AMQPEnvelope extends AMQPBasicProperties * * @param string $header_key Name of the header to check. * - * @return boolean + * @return bool */ public function hasHeader($header_key) { } } @@ -1003,7 +1003,7 @@ class AMQPExchange * @throws AMQPExchangeException On failure. * @throws AMQPChannelException If the channel is not open. * @throws AMQPConnectionException If the connection to the broker was lost. - * @return boolean true on success or false on failure. + * @return bool TRUE on success or FALSE on failure. */ public function bind($exchange_name, $routing_key = '', array $arguments = array()) { } @@ -1019,7 +1019,7 @@ class AMQPExchange * @throws AMQPExchangeException On failure. * @throws AMQPChannelException If the channel is not open. * @throws AMQPConnectionException If the connection to the broker was lost. - * @return boolean true on success or false on failure. + * @return bool TRUE on success or FALSE on failure. */ public function unbind($exchange_name, $routing_key = '', array $arguments = array()) { } @@ -1046,7 +1046,7 @@ class AMQPExchange * @throws AMQPChannelException If the channel is not open. * @throws AMQPConnectionException If the connection to the broker was lost. * - * @return boolean TRUE on success or FALSE on failure. + * @return bool TRUE on success or FALSE on failure. */ public function declareExchange() { } @@ -1063,7 +1063,7 @@ class AMQPExchange * @throws AMQPChannelException If the channel is not open. * @throws AMQPConnectionException If the connection to the broker was lost. * - * @return boolean true on success or false on failure. + * @return bool TRUE on success or FALSE on failure. */ public function delete($exchangeName = null, $flags = AMQP_NOPARAM) { } @@ -1072,9 +1072,9 @@ class AMQPExchange * * @param string $key The key to look up. * - * @return string|integer|boolean The string or integer value associated - * with the given key, or FALSE if the key - * is not set. + * @return string|integer|false The string or integer value associated + * with the given key, or FALSE if the key + * is not set. */ public function getArgument($key) { } @@ -1134,7 +1134,7 @@ class AMQPExchange * @throws AMQPChannelException If the channel is not open. * @throws AMQPConnectionException If the connection to the broker was lost. * - * @return boolean TRUE on success or FALSE on failure. + * @return bool TRUE on success or FALSE on failure. */ public function publish( $message, @@ -1150,7 +1150,7 @@ class AMQPExchange * @param string $key Name of the argument to set. * @param string|integer $value Value of the argument to set. * - * @return boolean TRUE on success or FALSE on failure. + * @return bool TRUE on success or FALSE on failure. */ public function setArgument($key, $value) { } @@ -1159,7 +1159,7 @@ class AMQPExchange * * @param array $arguments An array of key/value pairs of arguments. * - * @return boolean TRUE on success or FALSE on failure. + * @return bool TRUE on success or FALSE on failure. */ public function setArguments(array $arguments) { } @@ -1238,7 +1238,7 @@ class AMQPQueue * @throws AMQPChannelException If the channel is not open. * @throws AMQPConnectionException If the connection to the broker was lost. * - * @return boolean + * @return bool */ public function ack($delivery_tag, $flags = AMQP_NOPARAM) { } @@ -1252,7 +1252,7 @@ class AMQPQueue * @throws AMQPChannelException If the channel is not open. * @throws AMQPConnectionException If the connection to the broker was lost. * - * @return boolean + * @return bool */ public function bind($exchange_name, $routing_key = null, array $arguments = array()) { } @@ -1292,7 +1292,7 @@ class AMQPQueue * Blocking function that will retrieve the next message from the queue as * it becomes available and will pass it off to the callback. * - * @param callable | null $callback A callback function to which the + * @param callable|null $callback A callback function to which the * consumed message will be passed. The * function must accept at a minimum * one parameter, an AMQPEnvelope object, @@ -1378,7 +1378,7 @@ class AMQPQueue * @throws AMQPChannelException If the channel is not open. * @throws AMQPConnectionException If the connection to the broker was lost. * - * @return AMQPEnvelope|boolean + * @return AMQPEnvelope|false */ public function get($flags = AMQP_NOPARAM) { } @@ -1387,9 +1387,9 @@ class AMQPQueue * * @param string $key The key to look up. * - * @return string|integer|boolean The string or integer value associated - * with the given key, or false if the key - * is not set. + * @return string|integer|false The string or integer value associated + * with the given key, or false if the key + * is not set. */ public function getArgument($key) { } @@ -1436,7 +1436,7 @@ class AMQPQueue * @throws AMQPChannelException If the channel is not open. * @throws AMQPConnectionException If the connection to the broker was lost. * - * @return boolean + * @return bool */ public function nack($delivery_tag, $flags = AMQP_NOPARAM) { } @@ -1455,7 +1455,7 @@ class AMQPQueue * @throws AMQPChannelException If the channel is not open. * @throws AMQPConnectionException If the connection to the broker was lost. * - * @return boolean + * @return bool */ public function reject($delivery_tag, $flags = AMQP_NOPARAM) { } @@ -1465,7 +1465,7 @@ class AMQPQueue * @throws AMQPChannelException If the channel is not open. * @throws AMQPConnectionException If the connection to the broker was lost. * - * @return boolean + * @return bool */ public function purge() { } @@ -1475,7 +1475,7 @@ class AMQPQueue * @param string $key The key to set. * @param mixed $value The value to set. * - * @return boolean + * @return bool */ public function setArgument($key, $value) { } @@ -1486,7 +1486,7 @@ class AMQPQueue * * @param array $arguments An array of key/value pairs of arguments. * - * @return boolean + * @return bool */ public function setArguments(array $arguments) { } @@ -1495,7 +1495,7 @@ class AMQPQueue * * @param string $key The key to check. * - * @return boolean + * @return bool */ public function hasArgument($key) { } @@ -1506,7 +1506,7 @@ class AMQPQueue * AMQP_DURABLE, AMQP_PASSIVE, * AMQP_EXCLUSIVE, AMQP_AUTODELETE. * - * @return boolean + * @return bool */ public function setFlags($flags) { } @@ -1515,7 +1515,7 @@ class AMQPQueue * * @param string $queue_name The name of the queue. * - * @return boolean + * @return bool */ public function setName($queue_name) { } @@ -1531,7 +1531,7 @@ class AMQPQueue * @throws AMQPChannelException If the channel is not open. * @throws AMQPConnectionException If the connection to the broker was lost. * - * @return boolean + * @return bool */ public function unbind($exchange_name, $routing_key = null, array $arguments = array()) { } @@ -1552,7 +1552,7 @@ class AMQPQueue /** * Get latest consumer tag. If no consumer available or the latest on was canceled null will be returned. * - * @return string | null + * @return string|null */ public function getConsumerTag() { } diff --git a/apcu/apcu.php b/apcu/apcu.php index 00e963c9..ed692189 100644 --- a/apcu/apcu.php +++ b/apcu/apcu.php @@ -96,7 +96,7 @@ function apcu_clear_cache(){} * @param bool $limited When set to FALSE (default) apcu_sma_info() will * return a detailed information about each segment. * - * @return array|bool Array of Shared Memory Allocation data; FALSE on failure. + * @return array|false Array of Shared Memory Allocation data; FALSE on failure. */ function apcu_sma_info($limited = false){} @@ -167,7 +167,7 @@ function apcu_exists($keys){} * @param string $key The key of the value being increased. * @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|bool Returns the current value of key's value on success, or FALSE on failure. + * @return int|false Returns the current value of key's value on success, or FALSE on failure. */ function apcu_inc($key, $step = 1, &$success = null){} @@ -177,7 +177,7 @@ function apcu_inc($key, $step = 1, &$success = null){} * @param string $key The key of the value being decreased. * @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|bool Returns the current value of key's value on success, or FALSE on failure. + * @return int|false Returns the current value of key's value on success, or FALSE on failure. */ function apcu_dec($key, $step = 1, &$success = null){} @@ -232,7 +232,7 @@ function apcu_entry($key, callable $generator, $ttl = 0){} * * @param bool $limited If limited is TRUE, the return value will exclude the individual list of cache entries. * This is useful when trying to optimize calls for statistics gathering. - * @return array|bool Array of cached data (and meta-data) or FALSE on failure + * @return array|false Array of cached data (and meta-data) or FALSE on failure */ function apcu_cache_info($limited = false){} @@ -285,7 +285,7 @@ class APCUIterator implements Iterator /** * Gets the current iterator key * @link https://php.net/manual/en/apcuiterator.key.php - * @return string|int|bool Returns the key on success, or FALSE upon failure. + * @return string|int|false Returns the key on success, or FALSE upon failure. */ public function key(){} @@ -299,21 +299,21 @@ class APCUIterator implements Iterator /** * Gets the total number of cache hits * @link https://php.net/manual/en/apcuiterator.gettotalhits.php - * @return int|bool The number of hits on success, or FALSE on failure. + * @return int|false The number of hits on success, or FALSE on failure. */ public function getTotalHits(){} /** * Gets the total cache size * @link https://php.net/manual/en/apcuiterator.gettotalsize.php - * @return int|bool The total cache size. + * @return int|false The total cache size. */ public function getTotalSize(){} /** * Get the total count * @link https://php.net/manual/en/apcuiterator.gettotalcount.php - * @return int|bool The total count. + * @return int|false The total count. */ public function getTotalCount(){} } diff --git a/bz2/bz2.php b/bz2/bz2.php index 394ec6d4..6afd0fbd 100644 --- a/bz2/bz2.php +++ b/bz2/bz2.php @@ -64,7 +64,7 @@ function bzwrite ($bz, $data, $length = null) {} * The file pointer. It must be valid and must point to a file * successfully opened by bzopen. *

- * @return int TRUE on success or FALSE on failure. + * @return bool TRUE on success or FALSE on failure. * @since 4.0.4 * @since 5.0 */ @@ -77,7 +77,7 @@ function bzflush ($bz) {} * The file pointer. It must be valid and must point to a file * successfully opened by bzopen. *

- * @return int TRUE on success or FALSE on failure. + * @return bool TRUE on success or FALSE on failure. * @since 4.0.4 * @since 5.0 */ diff --git a/couchbase/couchbase.php b/couchbase/couchbase.php index 36dda5b1..7887db1e 100644 --- a/couchbase/couchbase.php +++ b/couchbase/couchbase.php @@ -2435,7 +2435,7 @@ namespace Couchbase { /** * Change the expiry of the enclosing document as part of the mutation. * - * @param expiry the new expiry to apply (or 0 to avoid changing the expiry) + * @param mixed $expiry the new expiry to apply (or 0 to avoid changing the expiry) * @return MutateInBuilder */ public function withExpiry($expiry) {} @@ -2736,7 +2736,7 @@ namespace Couchbase { * If no sort is provided, it is equal to sort("-_score"), since the server will sort it by score in descending * order. * - * @param sort the fields that should take part in the sorting. + * @param mixed $sort the fields that should take part in the sorting. * @return SearchQuery */ public function sort(...$sort) {} @@ -3570,7 +3570,7 @@ namespace Couchbase { /** * Set type of the field * - * @param string type the type + * @param string $type the type * * @see SearchSortField::TYPE_AUTO * @see SearchSortField::TYPE_STRING @@ -3582,7 +3582,7 @@ namespace Couchbase { /** * Set mode of the sort * - * @param string mode the mode + * @param string $mode the mode * * @see SearchSortField::MODE_MIN * @see SearchSortField::MODE_MAX @@ -3592,7 +3592,7 @@ namespace Couchbase { /** * Set where the hits with missing field will be inserted * - * @param string missing strategy for hits with missing fields + * @param string $missing strategy for hits with missing fields * * @see SearchSortField::MISSING_FIRST * @see SearchSortField::MISSING_LAST diff --git a/curl/curl.php b/curl/curl.php index 46b739f9..0203f198 100644 --- a/curl/curl.php +++ b/curl/curl.php @@ -2238,7 +2238,7 @@ function curl_share_setopt ($sh, $option, $value ) {} * @param int $errornum

* One of the {@link https://curl.haxx.se/libcurl/c/libcurl-errors.html  cURL error codes} constants. *

- * @return string|NULL Returns error description or NULL for invalid error code. + * @return string|null Returns error description or NULL for invalid error code. * @since 5.5.0 */ function curl_strerror ($errornum ) {} @@ -2252,7 +2252,7 @@ function curl_strerror ($errornum ) {} * @param string $str

* The URL encoded string to be decoded. *

- * @return string|bool Returns decoded string or FALSE on failure. + * @return string|false Returns decoded string or FALSE on failure. * @since 5.5.0 */ function curl_unescape ($ch, $str) {} @@ -2332,7 +2332,7 @@ function curl_errno ($ch) {} * {@link https://secure.php.net/manual/en/function.curl-init.php curl_init()}.

* @param string $str

* The string to be encoded.

- * @return string|boolean Returns escaped string or FALSE on failure. + * @return string|false Returns escaped string or FALSE on failure. * @since 5.5.0 */ function curl_escape($ch, $str) {} @@ -2363,7 +2363,7 @@ function curl_close ($ch) {} /** * Returns a new cURL multi handle * @link https://php.net/manual/en/function.curl-multi-init.php - * @return resource a cURL multi handle resource on success, false on failure. + * @return resource|false a cURL multi handle resource on success, false on failure. * @since 5.0 */ function curl_multi_init () {} @@ -2384,7 +2384,7 @@ function curl_multi_add_handle ($mh, $ch) {} * @link https://php.net/manual/en/function.curl-multi-remove-handle.php * @param resource $mh * @param resource $ch - * @return int On success, returns a cURL handle, false on failure. + * @return int Returns 0 on success, or one of the CURLM_XXX error codes. * @since 5.0 */ function curl_multi_remove_handle ($mh, $ch) {} @@ -2450,7 +2450,7 @@ function curl_multi_select ($mh, $timeout = null) {} * * *
- * @return boolean Returns TRUE on success or FALSE on failure. + * @return bool Returns TRUE on success or FALSE on failure. * @since 5.5.0 */ function curl_multi_setopt ($mh, $option, $value) {} @@ -2462,7 +2462,7 @@ function curl_multi_setopt ($mh, $option, $value) {} * @param int $errornum

* One of the {@link https://curl.haxx.se/libcurl/c/libcurl-errors.html CURLM error codes} constants. *

- * @return string|NULL Returns error string for valid error code, NULL otherwise. + * @return string|null Returns error string for valid error code, NULL otherwise. * @since 5.5.0 */ function curl_multi_strerror ($errornum) {} diff --git a/date/date.php b/date/date.php index c836eaa1..60e2a371 100644 --- a/date/date.php +++ b/date/date.php @@ -1094,7 +1094,7 @@ function date_offset_get ($object) {} * @link https://php.net/manual/en/function.date-diff.php * @param DateTime $object * @param DateTime $object2 The date to compare to - * @param boolean $absolute [optional] Whether to return absolute difference. + * @param bool $absolute [optional] Whether to return absolute difference. * @return DateInterval|false The DateInterval object representing the difference between the two dates or FALSE on failure. * @since 5.3.0 */ @@ -1223,7 +1223,7 @@ function timezone_name_from_abbr ($abbr, $gmtOffset = null, $isdst = null) {} * returned by * {@see timezone_open()}

* @param $datetime

DateTime that contains the date/time to compute the offset from.

- * @return int|boolean

Returns time zone offset in seconds on success or FALSE on failure.

+ * @return int|false

Returns time zone offset in seconds on success or FALSE on failure.

* @since 5.1.0 */ function timezone_offset_get ($object, $datetime) {} diff --git a/date/date_c.php b/date/date_c.php index 29697cdf..479e4a8a 100644 --- a/date/date_c.php +++ b/date/date_c.php @@ -176,7 +176,7 @@ class DateTimeImmutable implements DateTimeInterface { * @param int $year

Year of the date.

* @param int $month

Month of the date.

* @param int $day

Day of the date.

- * @return static|bool + * @return static|false * Returns the {@link https://secure.php.net/manual/en/class.datetimeimmutable.php DateTimeImmutable} object for method chaining or FALSE on failure. * */ @@ -189,7 +189,7 @@ class DateTimeImmutable implements DateTimeInterface { * @param int $year

Year of the date.

* @param int $week

Week of the date.

* @param int $day [optional]

Offset from the first day of the week.

- * @return static|bool + * @return static|false * Returns the {@link https://secure.php.net/manual/en/class.datetimeimmutable.php DateTimeImmutable} object for method chaining or FALSE on failure. */ public function setISODate($year, $week, $day = 1) { } @@ -213,7 +213,7 @@ class DateTimeImmutable implements DateTimeInterface { * Sets the date and time based on an Unix timestamp * @link https://secure.php.net/manual/en/datetimeimmutable.settimestamp.php * @param int $unixtimestamp

Unix timestamp representing the date.

- * @return static|bool + * @return static|false * Returns the {@link https://secure.php.net/manual/en/class.datetimeimmutable.php DateTimeImmutable} object for method chaining or FALSE on failure. */ public function setTimestamp($unixtimestamp) { } @@ -226,7 +226,7 @@ class DateTimeImmutable implements DateTimeInterface { * A {@link https://secure.php.net/manual/en/class.datetimezone.php DateTimeZone} object representing the * desired time zone. *

- * @return static|bool + * @return static|false * Returns the {@link https://secure.php.net/manual/en/class.datetimeimmutable.php DateTimeImmutable} object for method chaining or FALSE on failure. */ public function setTimezone(DateTimeZone $timezone) { } @@ -238,7 +238,7 @@ class DateTimeImmutable implements DateTimeInterface { * @param DateInterval $interval

* A {@link https://secure.php.net/manual/en/class.dateinterval.php DateInterval} object *

- * @return static|bool + * @return static|false * Returns the {@link https://secure.php.net/manual/en/class.datetimeimmutable.php DateTimeImmutable} object for method chaining or FALSE on failure. */ public function sub(DateInterval $interval) { } @@ -460,8 +460,8 @@ class DateTime implements DateTimeInterface { /** * Returns the difference between two DateTime objects represented as a DateInterval. * @param DateTimeInterface $datetime2 The date to compare to. - * @param boolean $absolute [optional] Whether to return absolute difference. - * @return DateInterval|boolean The DateInterval object representing the difference between the two dates or FALSE on failure. + * @param bool $absolute [optional] Whether to return absolute difference. + * @return DateInterval|false The DateInterval object representing the difference between the two dates or FALSE on failure. * @link https://php.net/manual/en/datetime.diff.php */ public function diff ($datetime2, $absolute = false) {} @@ -472,7 +472,7 @@ class DateTime implements DateTimeInterface { * @param string $format Format accepted by date(). * @param string $time String representing the time. * @param DateTimeZone $timezone A DateTimeZone object representing the desired time zone. - * @return DateTime|boolean + * @return DateTime|false * @link https://php.net/manual/en/datetime.createfromformat.php */ public static function createFromFormat ($format, $time, DateTimeZone $timezone=null) {} diff --git a/dba/dba.php b/dba/dba.php index 8710b3a8..281c5822 100644 --- a/dba/dba.php +++ b/dba/dba.php @@ -208,7 +208,7 @@ function dba_exists ($key, $handle) {} * The database handler, returned by dba_open or * dba_popen. *

- * @return string the associated string if the key/data pair is found, FALSE + * @return string|false the associated string if the key/data pair is found, FALSE * otherwise. * @since 4.0 * @since 5.0 diff --git a/dom/dom_c.php b/dom/dom_c.php index 53d6ca35..3b40a707 100644 --- a/dom/dom_c.php +++ b/dom/dom_c.php @@ -294,7 +294,7 @@ class DOMNode { /** * @param DOMNode $arg - * @return boolean + * @return bool */ public function isEqualNode (DOMNode $arg) {} @@ -352,7 +352,7 @@ class DOMNode { * @param $with_comments [optional] Retain comments in output. * @param $xpath [optional] An array of xpaths to filter the nodes by. * @param $ns_prefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return int Number of bytes written or FALSE on failure + * @return int|false Number of bytes written or FALSE on failure */ public function C14NFile ($uri, $exclusive, array $with_comments, array $xpath = null, $ns_prefixes = null) {} @@ -1147,7 +1147,7 @@ class DOMNodeList implements Traversable, Countable { * @param int $index

* Index of the node into the collection. *

- * @return DOMNode|null The node at the indexth position in the + * @return DOMNode|null The node at the indexth position in the * DOMNodeList, or &null; if that is not a valid * index. * @since 5.0 diff --git a/enchant/enchant.php b/enchant/enchant.php index 0bbd0e07..c173fcf3 100644 --- a/enchant/enchant.php +++ b/enchant/enchant.php @@ -135,7 +135,7 @@ function enchant_broker_set_ordering ($broker, $tag, $ordering) {} * @param resource $broker

* Broker resource *

- * @return array TRUE on success or FALSE on failure. + * @return array */ function enchant_broker_describe ($broker) {} @@ -177,7 +177,7 @@ function enchant_dict_suggest ($dict, $word) {} * @param string $word

* The word to add *

- * @return void TRUE on success or FALSE on failure. + * @return void */ function enchant_dict_add_to_personal ($dict, $word) {} @@ -222,7 +222,7 @@ function enchant_dict_is_in_session ($dict, $word) {} * @param string $cor

* The correct word *

- * @return void TRUE on success or FALSE on failure. + * @return void */ function enchant_dict_store_replacement ($dict, $mis, $cor) {} diff --git a/exif/exif.php b/exif/exif.php index f67960ee..4e0a8493 100644 --- a/exif/exif.php +++ b/exif/exif.php @@ -98,7 +98,7 @@ function read_exif_data ($filename, $sections = null, $arrays = false, $thumbnai * @param int $index

* The Tag ID for which a Tag Name will be looked up. *

- * @return string the header name, or FALSE if index is + * @return string|false the header name, or FALSE if index is * not a defined EXIF tag id. * @since 4.2.0 * @since 5.0 @@ -122,7 +122,7 @@ function exif_tagname ($index) {} * The returned image type of the returned thumbnail. This is either * TIFF or JPEG. *

- * @return string the embedded thumbnail, or FALSE if the image contains no + * @return string|false the embedded thumbnail, or FALSE if the image contains no * thumbnail. * @since 4.2.0 * @since 5.0 @@ -133,7 +133,7 @@ function exif_thumbnail ($filename, &$width = null, &$height = null, &$imagetype * Determine the type of an image * @link https://php.net/manual/en/function.exif-imagetype.php * @param string $filename The image being checked. - * @return int When a correct signature is found, the appropriate constant value will be + * @return int|false When a correct signature is found, the appropriate constant value will be * returned otherwise the return value is FALSE. The return value is the * same value that getimagesize returns in index 2 but * exif_imagetype is much faster. diff --git a/fann/fann.php b/fann/fann.php index bbcaceef..6400f770 100644 --- a/fann/fann.php +++ b/fann/fann.php @@ -115,7 +115,7 @@ function fann_clear_scaling_params($ann) * * @param resource $ann * - * @return resource Returns a copy of neural network resource on success, or false on error + * @return resource|false Returns a copy of neural network resource on success, or false on error */ function fann_copy($ann) { @@ -142,7 +142,7 @@ function fann_create_from_file($configuration_file) * @param int $num_layers * @param array $layers * - * @return resource Returns a neural network resource on success, or false on error. + * @return resource|false Returns a neural network resource on success, or false on error. */ function fann_create_shortcut_array($num_layers, $layers) { @@ -159,7 +159,7 @@ function fann_create_shortcut_array($num_layers, $layers) * @param int $num_neurons2 * @param int $_ * - * @return reference Returns a neural network resource on success, or false on error. + * @return resource|false Returns a neural network resource on success, or false on error. */ function fann_create_shortcut($num_layers, $num_neurons1, $num_neurons2, $_ = NULL) { @@ -174,7 +174,7 @@ function fann_create_shortcut($num_layers, $num_neurons1, $num_neurons2, $_ = NU * @param int $num_layers * @param array $layers * - * @return ReturnType Returns a neural network resource on success, or false on error. + * @return resource|false Returns a neural network resource on success, or false on error. */ function fann_create_sparse_array($connection_rate, $num_layers, $layers) { @@ -192,7 +192,7 @@ function fann_create_sparse_array($connection_rate, $num_layers, $layers) * @param int $num_neurons2 * @param int $_ * - * @return ReturnType Returns a neural network resource on success, or false on error. + * @return resource|false Returns a neural network resource on success, or false on error. */ function fann_create_sparse($connection_rate, $num_layers, $num_neurons1, $num_neurons2, $_ = NULL) { @@ -206,7 +206,7 @@ function fann_create_sparse($connection_rate, $num_layers, $num_neurons1, $num_n * @param int $num_layers * @param array $layers * - * @return resource Returns a neural network resource on success, or false on error. + * @return resource|false Returns a neural network resource on success, or false on error. */ function fann_create_standard_array($num_layers, $layers) { @@ -223,7 +223,7 @@ function fann_create_standard_array($num_layers, $layers) * @param int $num_neurons2 * @param int $_ * - * @return resource Returns a neural network resource on success, or false on error. + * @return resource|false Returns a neural network resource on success, or false on error. */ function fann_create_standard($num_layers, $num_neurons1, $num_neurons2, $_ = NULL) { @@ -350,7 +350,7 @@ function fann_duplicate_train_data($data) * @param int $layer * @param int $neuron * - * @return int constant or -1 if the neuron is not defined in the neural network, or false on error. + * @return int|false constant or -1 if the neuron is not defined in the neural network, or false on error. */ function fann_get_activation_function($ann, $layer, $neuron) { @@ -365,7 +365,7 @@ function fann_get_activation_function($ann, $layer, $neuron) * @param int $layer * @param int $neuron * - * @return float The activation steepness for the neuron or -1 if the neuron is not defined in the neural network, or false on error. + * @return float|false The activation steepness for the neuron or -1 if the neuron is not defined in the neural network, or false on error. */ function fann_get_activation_steepness($ann, $layer, $neuron) { @@ -391,7 +391,7 @@ function fann_get_bias_array($ann) * * @param resource $ann * - * @return float The bit fail limit, or false on error. + * @return float|false The bit fail limit, or false on error. */ function fann_get_bit_fail_limit($ann) { @@ -404,7 +404,7 @@ function fann_get_bit_fail_limit($ann) * * @param resource $ann * - * @return int The number of bits fail, or false on error. + * @return int|false The number of bits fail, or false on error. */ function fann_get_bit_fail($ann) { @@ -417,7 +417,7 @@ function fann_get_bit_fail($ann) * * @param resource $ann * - * @return int The number of cascade activation functions, or false on error. + * @return int|false The number of cascade activation functions, or false on error. */ function fann_get_cascade_activation_functions_count($ann) { @@ -430,7 +430,7 @@ function fann_get_cascade_activation_functions_count($ann) * * @param resource $ann * - * @return array The cascade activation functions, or false on error. + * @return array|false The cascade activation functions, or false on error. */ function fann_get_cascade_activation_functions($ann) { @@ -443,7 +443,7 @@ function fann_get_cascade_activation_functions($ann) * * @param resource $ann * - * @return int The number of activation steepnesses, or false on error. + * @return int|false The number of activation steepnesses, or false on error. */ function fann_get_cascade_activation_steepnesses_count($ann) { @@ -456,7 +456,7 @@ function fann_get_cascade_activation_steepnesses_count($ann) * * @param resource $ann * - * @return array The cascade activation steepnesses, or false on error. + * @return array|false The cascade activation steepnesses, or false on error. */ function fann_get_cascade_activation_steepnesses($ann) { @@ -469,7 +469,7 @@ function fann_get_cascade_activation_steepnesses($ann) * * @param resource $ann * - * @return float The cascade candidate change fraction, or false on error. + * @return float|false The cascade candidate change fraction, or false on error. */ function fann_get_cascade_candidate_change_fraction($ann) { @@ -482,7 +482,7 @@ function fann_get_cascade_candidate_change_fraction($ann) * * @param resource $ann * - * @return float The candidate limit, or false on error. + * @return float|false The candidate limit, or false on error. */ function fann_get_cascade_candidate_limit($ann) { @@ -495,7 +495,7 @@ function fann_get_cascade_candidate_limit($ann) * * @param resource $ann * - * @return float The number of cascade candidate stagnation epochs, or false on error. + * @return float|false The number of cascade candidate stagnation epochs, or false on error. */ function fann_get_cascade_candidate_stagnation_epochs($ann) { @@ -508,7 +508,7 @@ function fann_get_cascade_candidate_stagnation_epochs($ann) * * @param resource $ann * - * @return int The maximum candidate epochs, or false on error. + * @return int|false The maximum candidate epochs, or false on error. */ function fann_get_cascade_max_cand_epochs($ann) { @@ -521,7 +521,7 @@ function fann_get_cascade_max_cand_epochs($ann) * * @param resource $ann * - * @return int The maximum out epochs, or false on error. + * @return int|false The maximum out epochs, or false on error. */ function fann_get_cascade_max_out_epochs($ann) { @@ -534,7 +534,7 @@ function fann_get_cascade_max_out_epochs($ann) * * @param resource $ann * - * @return int The minimum candidate epochs, or false on error. + * @return int|false The minimum candidate epochs, or false on error. */ function fann_get_cascade_min_cand_epochs($ann) { @@ -547,7 +547,7 @@ function fann_get_cascade_min_cand_epochs($ann) * * @param resource $ann * - * @return int The minimum out epochs, or false on error. + * @return int|false The minimum out epochs, or false on error. */ function fann_get_cascade_min_out_epochs($ann) { @@ -560,7 +560,7 @@ function fann_get_cascade_min_out_epochs($ann) * * @param resource $ann * - * @return int The number of candidate groups, or false on error. + * @return int|false The number of candidate groups, or false on error. */ function fann_get_cascade_num_candidate_groups($ann) { @@ -573,7 +573,7 @@ function fann_get_cascade_num_candidate_groups($ann) * * @param resource $ann * - * @return int The number of candidates used during training, or false on error. + * @return int|false The number of candidates used during training, or false on error. */ function fann_get_cascade_num_candidates($ann) { @@ -586,7 +586,7 @@ function fann_get_cascade_num_candidates($ann) * * @param resource $ann * - * @return float The cascade output change fraction, or false on error. + * @return float|false The cascade output change fraction, or false on error. */ function fann_get_cascade_output_change_fraction($ann) { @@ -599,7 +599,7 @@ function fann_get_cascade_output_change_fraction($ann) * * @param resource $ann * - * @return int The number of cascade output stagnation epochs, or false on error. + * @return int|false The number of cascade output stagnation epochs, or false on error. */ function fann_get_cascade_output_stagnation_epochs($ann) { @@ -612,7 +612,7 @@ function fann_get_cascade_output_stagnation_epochs($ann) * * @param resource $ann * - * @return float The weight multiplier, or false on error. + * @return float|false The weight multiplier, or false on error. */ function fann_get_cascade_weight_multiplier($ann) { @@ -638,7 +638,7 @@ function fann_get_connection_array($ann) * * @param resource $ann * - * @return float The connection rate used when the network was created, or false on error. + * @return float|false The connection rate used when the network was created, or false on error. */ function fann_get_connection_rate($ann) { @@ -651,7 +651,7 @@ function fann_get_connection_rate($ann) * * @param resource $errdat * - * @return int The error number, or false on error. + * @return int|false The error number, or false on error. */ function fann_get_errno($errdat) { @@ -664,7 +664,7 @@ function fann_get_errno($errdat) * * @param resource $errdat * - * @return string The last error string, or false on error. + * @return string|false The last error string, or false on error. */ function fann_get_errstr($errdat) { @@ -690,7 +690,7 @@ function fann_get_layer_array($ann) * * @param resource $ann * - * @return float The learning momentum, or false on error. + * @return float|false The learning momentum, or false on error. */ function fann_get_learning_momentum($ann) { @@ -703,7 +703,7 @@ function fann_get_learning_momentum($ann) * * @param resource $ann * - * @return float The learning rate, or false on error. + * @return float|false The learning rate, or false on error. */ function fann_get_learning_rate($ann) { @@ -716,7 +716,7 @@ function fann_get_learning_rate($ann) * * @param resource $ann * - * @return float The mean square error, or false on error. + * @return float|false The mean square error, or false on error. */ function fann_get_MSE($ann) { @@ -729,7 +729,7 @@ function fann_get_MSE($ann) * * @param resource $ann * - * @return int constant, or false on error. + * @return int|false constant, or false on error. */ function fann_get_network_type($ann) { @@ -742,7 +742,7 @@ function fann_get_network_type($ann) * * @param resource $ann * - * @return int Number of input neurons, or false on error + * @return int|false Number of input neurons, or false on error */ function fann_get_num_input($ann) { @@ -755,7 +755,7 @@ function fann_get_num_input($ann) * * @param resource $ann * - * @return int The number of leayers in the neural network, or false on error. + * @return int|false The number of leayers in the neural network, or false on error. */ function fann_get_num_layers($ann) { @@ -768,7 +768,7 @@ function fann_get_num_layers($ann) * * @param resource $ann * - * @return int Number of output neurons, or false on error + * @return int|false Number of output neurons, or false on error */ function fann_get_num_output($ann) { @@ -781,7 +781,7 @@ function fann_get_num_output($ann) * * @param resource $ann * - * @return float The decay, or false on error. + * @return float|false The decay, or false on error. */ function fann_get_quickprop_decay($ann) { @@ -794,7 +794,7 @@ function fann_get_quickprop_decay($ann) * * @param resource $ann * - * @return float The mu factor, or false on error. + * @return float|false The mu factor, or false on error. */ function fann_get_quickprop_mu($ann) { @@ -807,7 +807,7 @@ function fann_get_quickprop_mu($ann) * * @param resource $ann * - * @return float The decrease factor, or false on error. + * @return float|false The decrease factor, or false on error. */ function fann_get_rprop_decrease_factor($ann) { @@ -820,7 +820,7 @@ function fann_get_rprop_decrease_factor($ann) * * @param resource $ann * - * @return float The maximum step-size, or false on error. + * @return float|false The maximum step-size, or false on error. */ function fann_get_rprop_delta_max($ann) { @@ -833,7 +833,7 @@ function fann_get_rprop_delta_max($ann) * * @param resource $ann * - * @return float The minimum step-size, or false on error. + * @return float|false The minimum step-size, or false on error. */ function fann_get_rprop_delta_min($ann) { @@ -846,7 +846,7 @@ function fann_get_rprop_delta_min($ann) * * @param resource $ann * - * @return ReturnType The initial step-size, or false on error. + * @return int|false The initial step-size, or false on error. */ function fann_get_rprop_delta_zero($ann) { @@ -859,7 +859,7 @@ function fann_get_rprop_delta_zero($ann) * * @param resource $ann * - * @return float The increase factor, or false on error. + * @return float|false The increase factor, or false on error. */ function fann_get_rprop_increase_factor($ann) { @@ -872,7 +872,7 @@ function fann_get_rprop_increase_factor($ann) * * @param resource $ann * - * @return float The sarprop step error shift , or false on error. + * @return float|false The sarprop step error shift , or false on error. */ function fann_get_sarprop_step_error_shift($ann) { @@ -885,7 +885,7 @@ function fann_get_sarprop_step_error_shift($ann) * * @param resource $ann * - * @return float The sarprop step error threshold factor, or false on error. + * @return float|false The sarprop step error threshold factor, or false on error. */ function fann_get_sarprop_step_error_threshold_factor($ann) { @@ -898,7 +898,7 @@ function fann_get_sarprop_step_error_threshold_factor($ann) * * @param resource $ann * - * @return float The sarprop temperature, or false on error. + * @return float|false The sarprop temperature, or false on error. */ function fann_get_sarprop_temperature($ann) { @@ -911,7 +911,7 @@ function fann_get_sarprop_temperature($ann) * * @param resource $ann * - * @return float The sarprop weight decay shift, or false on error. + * @return float|false The sarprop weight decay shift, or false on error. */ function fann_get_sarprop_weight_decay_shift($ann) { @@ -924,7 +924,7 @@ function fann_get_sarprop_weight_decay_shift($ann) * * @param resource $ann * - * @return int Total number of connections in the entire network, or false on error + * @return int|false Total number of connections in the entire network, or false on error */ function fann_get_total_connections($ann) { @@ -937,7 +937,7 @@ function fann_get_total_connections($ann) * * @param resource $ann * - * @return int Total number of neurons in the entire network, or false on error. + * @return int|false Total number of neurons in the entire network, or false on error. */ function fann_get_total_neurons($ann) { @@ -950,7 +950,7 @@ function fann_get_total_neurons($ann) * * @param resource $ann * - * @return int The constant, or false on error. + * @return int|false The constant, or false on error. */ function fann_get_train_error_function($ann) { @@ -963,7 +963,7 @@ function fann_get_train_error_function($ann) * * @param resource $ann * - * @return int constant, or false on error. + * @return int|false constant, or false on error. */ function fann_get_training_algorithm($ann) { @@ -976,7 +976,7 @@ function fann_get_training_algorithm($ann) * * @param resource $ann * - * @return int The constant, or false on error. + * @return int|false The constant, or false on error. */ function fann_get_train_stop_function($ann) { @@ -1003,7 +1003,7 @@ function fann_init_weights($ann, $train_data) * * @param resource $data * - * @return int Number of elements in the train data ``resource``, or false on error. + * @return int|false Number of elements in the train data ``resource``, or false on error. */ function fann_length_train_data($data) { @@ -1017,7 +1017,7 @@ function fann_length_train_data($data) * @param resource $data1 * @param resource $data2 * - * @return resource New merged train data ``resource``, or false on error. + * @return resource|false New merged train data ``resource``, or false on error. */ function fann_merge_train_data($data1, $data2) { @@ -1030,7 +1030,7 @@ function fann_merge_train_data($data1, $data2) * * @param resource $data * - * @return int The number of inputs, or false on error. + * @return int|false The number of inputs, or false on error. */ function fann_num_input_train_data($data) { @@ -1043,7 +1043,7 @@ function fann_num_input_train_data($data) * * @param resource $data * - * @return int The number of outputs, or false on error. + * @return int|false The number of outputs, or false on error. */ function fann_num_output_train_data($data) { @@ -1137,7 +1137,7 @@ function fann_reset_MSE($ann) * @param resource $ann * @param array $input * - * @return array Array of output values, or false on error + * @return array|false Array of output values, or false on error */ function fann_run($ann, $input) { @@ -1940,7 +1940,7 @@ function fann_subset_train_data($data, $pos, $length) * @param resource $ann * @param resource $data * - * @return float The updated MSE, or false on error. + * @return float|false The updated MSE, or false on error. */ function fann_test_data($ann, $data) { @@ -1969,7 +1969,7 @@ function fann_test($ann, $input, $desired_output) * @param resource $ann * @param resource $data * - * @return float The MSE, or false on error. + * @return float|false The MSE, or false on error. */ function fann_train_epoch($ann, $data) { diff --git a/ffmpeg/ffmpeg.php b/ffmpeg/ffmpeg.php index a8d16639..483aaca2 100644 --- a/ffmpeg/ffmpeg.php +++ b/ffmpeg/ffmpeg.php @@ -3,7 +3,7 @@ class ffmpeg_movie { /** Open a video or audio file and return it as an object. * @param string $path_to_media - File path of video or audio file to open. - * @param boolean $persistent - Whether to open this media as a persistent resource. See the PHP documentation for more info about persistent resources + * @param bool $persistent - Whether to open this media as a persistent resource. See the PHP documentation for more info about persistent resources */ public function __construct($path_to_media, $persistent) { } @@ -146,13 +146,13 @@ class ffmpeg_movie { } /** Return boolean value indicating whether the movie has an audio stream. - * @return boolean + * @return bool */ public function hasAudio() { } /** Return boolean value indicating whether the movie has a video stream. - * @return boolean + * @return bool */ public function hasVideo() { } diff --git a/filter/filter.php b/filter/filter.php index 69327be9..1f91690a 100644 --- a/filter/filter.php +++ b/filter/filter.php @@ -182,7 +182,7 @@ function filter_has_var ($type, $variable_name) {} * @param string $filtername

* Name of a filter to get. *

- * @return int ID of a filter on success or FALSE if filter doesn't exist. + * @return int|false ID of a filter on success or FALSE if filter doesn't exist. * @since 5.2.0 */ function filter_id ($filtername) {} diff --git a/ftp/ftp.php b/ftp/ftp.php index ff9ea149..c8e71b26 100644 --- a/ftp/ftp.php +++ b/ftp/ftp.php @@ -37,7 +37,7 @@ function ftp_mlsd ($ftp, $directory) {} * queried at any time with ftp_set_option and * ftp_get_option. *

- * @return resource a FTP stream on success or FALSE on error. + * @return resource|false a FTP stream on success or FALSE on error. * @since 4.0 * @since 5.0 */ @@ -60,7 +60,7 @@ function ftp_connect ($host, $port = 21, $timeout = 90) {} * queried at any time with ftp_set_option and * ftp_get_option. *

- * @return resource a SSL-FTP stream on success or FALSE on error. + * @return resource|false a SSL-FTP stream on success or FALSE on error. * @since 4.3.0 * @since 5.0 */ @@ -200,7 +200,7 @@ function ftp_rmdir ($ftp_stream, $directory) {} * @param string $filename

* The remote file. *

- * @return int the new file permissions on success or FALSE on error. + * @return int|false the new file permissions on success or FALSE on error. * @since 5.0 */ function ftp_chmod ($ftp_stream, $mode, $filename) {} diff --git a/gearman/gearman.php b/gearman/gearman.php index 00a8af12..5c153b47 100644 --- a/gearman/gearman.php +++ b/gearman/gearman.php @@ -1606,7 +1606,7 @@ class GearmanClient { * @param string $workload * @param mixed $context * @param string $unique - * @return GearmanTask A GearmanTask object or false if the task could not be added + * @return GearmanTask|false A GearmanTask object or false if the task could not be added */ public function addTask($function_name, $workload, $context = null, $unique = null) {} @@ -1621,7 +1621,7 @@ class GearmanClient { * @param string $workload * @param mixed $context * @param string $unique - * @return GearmanTask A GearmanTask object or false if the task could not be added + * @return GearmanTask|false A GearmanTask object or false if the task could not be added */ public function addTaskHigh($function_name, $workload, $context = null, $unique = null) {} @@ -1636,7 +1636,7 @@ class GearmanClient { * @param string $workload * @param mixed $context * @param string $unique - * @return GearmanTask A GearmanTask object or false if the task could not be added + * @return GearmanTask|false A GearmanTask object or false if the task could not be added */ public function addTaskLow($function_name, $workload, $context = null, $unique = null) {} @@ -1650,7 +1650,7 @@ class GearmanClient { * @param string $workload * @param mixed $context * @param string $unique - * @return GearmanTask A GearmanTask object or false if the task could not be added + * @return GearmanTask|false A GearmanTask object or false if the task could not be added */ public function addTaskBackground($function_name, $workload, $context = null, $unique = null) {} @@ -1665,7 +1665,7 @@ class GearmanClient { * @param string $workload * @param mixed $context * @param string $unique - * @return GearmanTask A GearmanTask object or false if the task could not be added + * @return GearmanTask|false A GearmanTask object or false if the task could not be added */ public function addTaskHighBackground($function_name, $workload, $context = null, $unique = null) {} @@ -1680,7 +1680,7 @@ class GearmanClient { * @param string $workload * @param mixed $context * @param string $unique - * @return GearmanTask A GearmanTask object or false if the task could not be added + * @return GearmanTask|false A GearmanTask object or false if the task could not be added */ public function addTaskLowBackground($function_name, $workload, $context = null, $unique = null) {} @@ -1837,7 +1837,7 @@ class GearmanTask { * server. * * @link https://php.net/manual/en/gearmantask.unique.php - * @return string The unique identifier, or false if no identifier is assigned + * @return string|false The unique identifier, or false if no identifier is assigned */ public function unique() {} @@ -1871,7 +1871,7 @@ class GearmanTask { * as a fraction. * * @link https://php.net/manual/en/gearmantask.tasknumerator.php - * @return int A number between 0 and 100, or false if cannot be determined + * @return int|false A number between 0 and 100, or false if cannot be determined */ public function taskNumerator() {} @@ -1880,7 +1880,7 @@ class GearmanTask { * as a fraction. * * @link https://php.net/manual/en/gearmantask.taskdenominator.php - * @return int A number between 0 and 100, or false if cannot be determined + * @return int|false A number between 0 and 100, or false if cannot be determined */ public function taskDenominator() {} @@ -1889,7 +1889,7 @@ class GearmanTask { * * @link https://php.net/manual/en/gearmantask.sendworkload.php * @param string $data Data to send to the worker - * @return int The length of data sent, or false if the send failed + * @return int|false The length of data sent, or false if the send failed */ public function sendWorkload($data) {} @@ -1897,7 +1897,7 @@ class GearmanTask { * Returns data being returned for a task by a worker. * * @link https://php.net/manual/en/gearmantask.data.php - * @return string The serialized data, or false if no data is present + * @return string|false The serialized data, or false if no data is present */ public function data() {} @@ -1905,7 +1905,7 @@ class GearmanTask { * Returns the size of the data being returned for a task. * * @link https://php.net/manual/en/gearmantask.datasize.php - * @return int The data size, or false if there is no data + * @return int|false The data size, or false if there is no data */ public function dataSize() {} @@ -1914,7 +1914,7 @@ class GearmanTask { * * @link https://php.net/manual/en/gearmantask.recvdata.php * @param int $data_len Length of data to be read - * @return array An array whose first element is the length of data read and the second is + * @return array|false An array whose first element is the length of data read and the second is * the data buffer. Returns false if the read failed */ public function recvData($data_len) {} diff --git a/geoip/geoip.php b/geoip/geoip.php index 5ec47af2..add89b32 100644 --- a/geoip/geoip.php +++ b/geoip/geoip.php @@ -22,7 +22,7 @@ function geoip_database_info ($database = GEOIP_COUNTRY_EDITION) {} * @param string $hostname

* The hostname or IP address whose location is to be looked-up. *

- * @return string the two letter ISO country code on success, or FALSE + * @return string|false the two letter ISO country code on success, or FALSE * if the address cannot be found in the database. */ function geoip_country_code_by_name ($hostname) {} @@ -34,7 +34,7 @@ function geoip_country_code_by_name ($hostname) {} * @param string $hostname

* The hostname or IP address whose location is to be looked-up. *

- * @return string the three letter country code on success, or FALSE + * @return string|false the three letter country code on success, or FALSE * if the address cannot be found in the database. */ function geoip_country_code3_by_name ($hostname) {} @@ -46,7 +46,7 @@ function geoip_country_code3_by_name ($hostname) {} * @param string $hostname

* The hostname or IP address whose location is to be looked-up. *

- * @return string the country name on success, or FALSE if the address cannot + * @return string|false the country name on success, or FALSE if the address cannot * be found in the database. */ function geoip_country_name_by_name ($hostname) {} @@ -58,7 +58,7 @@ function geoip_country_name_by_name ($hostname) {} * @param string $hostname

* The hostname or IP address whose location is to be looked-up. *

- * @return string the two letter continent code on success, or FALSE if the + * @return string|false the two letter continent code on success, or FALSE if the * address cannot be found in the database. */ function geoip_continent_code_by_name ($hostname) {} @@ -70,7 +70,7 @@ function geoip_continent_code_by_name ($hostname) {} * @param string $hostname

* The hostname or IP address. *

- * @return string the organization name on success, or FALSE if the address + * @return string|false the organization name on success, or FALSE if the address * cannot be found in the database. */ function geoip_org_by_name ($hostname) {} @@ -82,7 +82,7 @@ function geoip_org_by_name ($hostname) {} * @param string $hostname

* The hostname or IP address whose record is to be looked-up. *

- * @return array the associative array on success, or FALSE if the address + * @return array|false the associative array on success, or FALSE if the address * cannot be found in the database. */ function geoip_record_by_name ($hostname) {} @@ -105,7 +105,7 @@ function geoip_id_by_name ($hostname) {} * @param string $hostname

* The hostname or IP address whose region is to be looked-up. *

- * @return array the associative array on success, or FALSE if the address + * @return array|false the associative array on success, or FALSE if the address * cannot be found in the database. */ function geoip_region_by_name ($hostname) {} @@ -117,7 +117,7 @@ function geoip_region_by_name ($hostname) {} * @param string $hostname

* The hostname or IP address. *

- * @return string the ISP name on success, or FALSE if the address + * @return string|false the ISP name on success, or FALSE if the address * cannot be found in the database. */ function geoip_isp_by_name ($hostname) {} @@ -131,7 +131,7 @@ function geoip_isp_by_name ($hostname) {} * various constants defined with * this extension (ie: GEOIP_*_EDITION). *

- * @return bool TRUE is database exists, FALSE if not found, or NULL on error. + * @return bool|false TRUE is database exists, FALSE if not found, or NULL on error. */ function geoip_db_avail ($database) {} @@ -168,7 +168,7 @@ function geoip_db_filename ($database) {} * The two-letter (or digit) region code (see * geoip_region_by_name) *

- * @return string the region name on success, or FALSE if the country and region code + * @return string|false the region name on success, or FALSE if the country and region code * combo cannot be found. */ function geoip_region_name_by_code ($country_code, $region_code) {} @@ -185,7 +185,7 @@ function geoip_region_name_by_code ($country_code, $region_code) {} * The two-letter (or digit) region code (see * geoip_region_by_name) *

- * @return string the time zone on success, or FALSE if the country and region code + * @return string|false the time zone on success, or FALSE if the country and region code * combo cannot be found. */ function geoip_time_zone_by_country_and_region ($country_code, $region_code = null) {} diff --git a/gmagick/gmagick.php b/gmagick/gmagick.php index 3458cb28..b94b5ef4 100644 --- a/gmagick/gmagick.php +++ b/gmagick/gmagick.php @@ -1037,7 +1037,7 @@ class Gmagick * * @link https://php.net/manual/en/gmagick.getimagematte.php * - * @return int Returns TRUE if the image has a matte channel, otherwise FALSE. + * @return bool Returns TRUE if the image has a matte channel, otherwise FALSE. * * @throws GmagickException On error. */ @@ -2625,7 +2625,7 @@ class GmagickDraw * * @link https://php.net/manual/en/gmagickdraw.getfont.php * - * @return string|bool A string on success and false if no font is set. + * @return string|false A string on success and false if no font is set. */ public function getfont() { @@ -2713,7 +2713,7 @@ class GmagickDraw * * @link https://php.net/manual/en/gmagickdraw.gettextencoding.php * - * @return string|bool Returns a string specifying the code set or false if text encoding is not set. + * @return string|false Returns a string specifying the code set or false if text encoding is not set. */ public function gettextencoding() { diff --git a/gmp/gmp.php b/gmp/gmp.php index a1ba90ce..f2a9fed9 100644 --- a/gmp/gmp.php +++ b/gmp/gmp.php @@ -705,7 +705,7 @@ function gmp_hamdist ($a, $b) {} * @param integer $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 integer $options Default value is GMP_MSW_FIRST | GMP_NATIVE_ENDIAN. - * @return GMP|bool Returns a GMP number or FALSE on failure. + * @return GMP|false Returns a GMP number or FALSE on failure. * @since 5.6.1 */ function gmp_import ($data, $word_size = 1, $options = GMP_MSW_FIRST | GMP_NATIVE_ENDIAN) {} @@ -717,7 +717,7 @@ function gmp_import ($data, $word_size = 1, $options = GMP_MSW_FIRST | GMP_NATIV * @param integer $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 integer $options Default value is GMP_MSW_FIRST | GMP_NATIVE_ENDIAN. - * @return string|bool Returns a string or FALSE on failure. + * @return string|false Returns a string or FALSE on failure. * @since 5.6.1 */ function gmp_export (GMP $gmpnumber, $word_size = 1, $options = GMP_MSW_FIRST | GMP_NATIVE_ENDIAN) {} diff --git a/gnupg/gnupg.php b/gnupg/gnupg.php index 718fa504..f1881d00 100644 --- a/gnupg/gnupg.php +++ b/gnupg/gnupg.php @@ -58,7 +58,7 @@ class gnupg { * @param string $signature * @param string $plaintext * - * @return array On success, this function returns information about the signature. + * @return array|false On success, this function returns information about the signature. * On failure, this function returns false. */ function verify($signed_text, $signature, &$plaintext = NULL) @@ -134,7 +134,7 @@ class gnupg { * * @param string $text * - * @return string On success, this function returns the decrypted text. + * @return string|false On success, this function returns the decrypted text. * On failure, this function returns false. */ function decrypt($text) @@ -149,7 +149,7 @@ class gnupg { * @param string $text * @param string $plaintext * - * @return array On success, this function returns information about the signature and + * @return array|false On success, this function returns information about the signature and * fills the parameter with the decrypted text. * On failure, this function returns false. */ @@ -164,7 +164,7 @@ class gnupg { * * @param string $plaintext * - * @return string On success, this function returns the encrypted text. + * @return string|false On success, this function returns the encrypted text. * On failure, this function returns false. */ function encrypt($plaintext) @@ -178,7 +178,7 @@ class gnupg { * * @param string $plaintext * - * @return string On success, this function returns the encrypted and signed text. + * @return string|false On success, this function returns the encrypted and signed text. * On failure, this function returns false. */ function encryptsign($plaintext) @@ -192,7 +192,7 @@ class gnupg { * * @param string $fingerprint * - * @return string On success, this function returns the keydata. + * @return string|false On success, this function returns the keydata. * On failure, this function returns false. */ function export($fingerprint) @@ -205,7 +205,7 @@ class gnupg { * @phpstub * * - * @return string Returns an errortext, if an error has occurred, otherwise false. + * @return string|false Returns an errortext, if an error has occurred, otherwise false. */ function geterror() { @@ -232,7 +232,7 @@ class gnupg { * * @param string $keydata * - * @return array On success, this function returns and info-array about the importprocess. + * @return array|false On success, this function returns and info-array about the importprocess. * On failure, this function returns false. */ function import($keydata) @@ -310,7 +310,7 @@ class gnupg { * * @param string $plaintext * - * @return string On success, this function returns the signed text or the signature. + * @return string|false On success, this function returns the signed text or the signature. * On failure, this function returns false. */ function sign($plaintext) diff --git a/hash/hash.php b/hash/hash.php index 39e9352d..4f86d818 100644 --- a/hash/hash.php +++ b/hash/hash.php @@ -27,7 +27,7 @@ function hash ($algo, $data, $raw_output = false) {} * @link https://php.net/manual/en/function.hash-equals.php * @param string $known_string

The string of known length to compare against

* @param string $user_string

The user-supplied string

- * @return boolean

Returns TRUE when the two strings are equal, FALSE otherwise.

+ * @return bool

Returns TRUE when the two strings are equal, FALSE otherwise.

* @since 5.6.0 */ function hash_equals($known_string, $user_string) {} @@ -225,7 +225,7 @@ function hash_algos () {} * If length is 0, the output length will default to the chosen hash function size. * @param string $info [optional]

Application/context-specific info string.

* @param string $salt [optional]

Salt to use during derivation. 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); or FALSE on failure.

+ * @return string|false

Returns a string containing a raw binary representation of the derived key (also known as output keying material - OKM); or FALSE on failure.

*/ function hash_hkdf(string $algo , string $ikm, int $length = 0, string $info = '', string $salt = '') {} @@ -272,7 +272,7 @@ function hash_pbkdf2 ($algo, $password, $salt, $iterations, $length = 0, $raw_ou * @param int $bytes

* The key length, in bytes. *

- * @return string the generated key as a string, or FALSE on error. + * @return string|false the generated key as a string, or FALSE on error. * @since 4.0.4 * @since 5.0 */ @@ -284,7 +284,7 @@ function mhash_keygen_s2k ($hash, $password, $salt, $bytes) {} * @param int $hash

* The hash ID. One of the MHASH_hashname constants. *

- * @return int the size in bytes or FALSE, if the hash + * @return int|false the size in bytes or FALSE, if the hash * does not exist. * @since 4.0 * @since 5.0 @@ -297,7 +297,7 @@ function mhash_get_block_size ($hash) {} * @param int $hash

* The hash ID. One of the MHASH_hashname constants. *

- * @return string the name of the hash or FALSE, if the hash does not exist. + * @return string|false the name of the hash or FALSE, if the hash does not exist. * @since 4.0 * @since 5.0 */ diff --git a/http/http.php b/http/http.php index 707139c0..c298ac90 100644 --- a/http/http.php +++ b/http/http.php @@ -69,7 +69,7 @@ class HttpDeflateStream { * @param string $data

* data to deflate *

- * @return string deflated data on success or false on failure. + * @return string|false deflated data on success or false on failure. */ public function update ($data) {} @@ -80,7 +80,7 @@ class HttpDeflateStream { * @param string $data [optional]

* more data to deflate *

- * @return string some deflated data as string on success or false on failure. + * @return string|false some deflated data as string on success or false on failure. */ public function flush ($data = null) {} @@ -137,7 +137,7 @@ class HttpInflateStream { * @param string $data

* data to inflate *

- * @return string inflated data on success or false on failure. + * @return string|false inflated data on success or false on failure. */ public function update ($data) {} @@ -148,7 +148,7 @@ class HttpInflateStream { * @param string $data [optional]

* more data to inflate *

- * @return string some inflated data as string on success or false on failure. + * @return string|false some inflated data as string on success or false on failure. */ public function flush ($data = null) {} @@ -234,7 +234,7 @@ class HttpMessage implements Countable, Serializable, Iterator { * @param string $header

* header name *

- * @return string the header value on success or NULL if the header does not exist. + * @return string|null the header value on success or NULL if the header does not exist. */ public function getHeader ($header) {} @@ -269,7 +269,7 @@ class HttpMessage implements Countable, Serializable, Iterator { * header will be converted to an array containing both header values, otherwise * it will be overwritten with the new header value *

- * @return void true on success or false on failure. + * @return void */ public function addHeaders (array $headers, $append = null) {} @@ -344,7 +344,7 @@ class HttpMessage implements Countable, Serializable, Iterator { * (PECL pecl_http >= 0.10.0)
* Get request method * @link https://php.net/manual/en/function.httpmessage-getrequestmethod.php - * @return string the request method name on success, or FALSE if the message is + * @return string|false the request method name on success, or FALSE if the message is * not of type HttpMessage::TYPE_REQUEST. */ public function getRequestMethod () {} @@ -365,7 +365,7 @@ class HttpMessage implements Countable, Serializable, Iterator { * (PECL pecl_http >= 0.21.0)
* Get request URL * @link https://php.net/manual/en/function.httpmessage-getrequesturl.php - * @return string the request URL as string on success, or FALSE if the message + * @return string|false the request URL as string on success, or FALSE if the message * is not of type HttpMessage::TYPE_REQUEST. */ public function getRequestUrl () {} @@ -411,7 +411,7 @@ class HttpMessage implements Countable, Serializable, Iterator { * @param int $magic_mode [optional]

* flags for libmagic *

- * @return string the guessed content type on success or false on failure. + * @return string|false the guessed content type on success or false on failure. */ public function guessContentType ($magic_file, $magic_mode = null) {} @@ -446,7 +446,7 @@ class HttpMessage implements Countable, Serializable, Iterator { * (PECL pecl_http >= 0.22.0)
* Create HTTP object regarding message type * @link https://php.net/manual/en/function.httpmessage-tomessagetypeobject.php - * @return HttpRequest|HttpResponse either an HttpRequest or HttpResponse object on success, or NULL on failure. + * @return HttpRequest|HttpResponse|null either an HttpRequest or HttpResponse object on success, or NULL on failure. */ public function toMessageTypeObject () {} @@ -484,7 +484,7 @@ class HttpMessage implements Countable, Serializable, Iterator { * @param string $class_name [optional]

* a class extending HttpMessage *

- * @return HttpMessage an HttpMessage object on success or NULL on failure. + * @return HttpMessage|null an HttpMessage object on success or NULL on failure. */ public static function factory ($raw_message = null, $class_name = null) {} @@ -498,7 +498,7 @@ class HttpMessage implements Countable, Serializable, Iterator { * @param string $class_name [optional]

* a class extending HttpMessage *

- * @return HttpMessage an HttpMessage object on success or NULL on failure. + * @return HttpMessage|null an HttpMessage object on success or NULL on failure. */ public static function fromString ($raw_message = null, $class_name = null) {} @@ -512,7 +512,7 @@ class HttpMessage implements Countable, Serializable, Iterator { * @param string $class_name [optional]

* a class extending HttpMessage *

- * @return HttpMessage an HttpMessage object on success or NULL on failure. + * @return HttpMessage|null an HttpMessage object on success or NULL on failure. */ public static function fromEnv ($message_type, $class_name = null) {} @@ -755,7 +755,7 @@ class HttpQueryString implements Serializable, ArrayAccess { * @param mixed $offset

* An offset to check for. *

- * @return boolean true on success or false on failure. + * @return bool true on success or false on failure. *

*

* The return value will be casted to boolean if non-boolean was returned. @@ -1787,7 +1787,7 @@ class HttpResponse { * @param int $magic_mode [optional]

* flags for libmagic *

- * @return string the guessed content type on success or false on failure. + * @return string|false the guessed content type on success or false on failure. */ public static function guessContentType ($magic_file, $magic_mode = null) {} @@ -2230,8 +2230,7 @@ function http_negotiate_content_type (array $supported, array &$result = null ) * @param int $status [optional]

* custom response status code *

- * @return void &returns.http.false.orexits; with the specified redirection status code. - * &see.http.configuration.force_exit; + * @return void */ function http_redirect ($url = null, array $params = null , $session = null, $status = null) {} @@ -2390,7 +2389,7 @@ function http_send_stream ($stream) {} * @param string $encoded

* chunked encoded string *

- * @return string the decoded string on success or false on failure. + * @return string|false the decoded string on success or false on failure. */ function http_chunked_decode ($encoded) {} @@ -2412,7 +2411,7 @@ function http_parse_message ($message) {} * @param string $header

* string containing HTTP headers *

- * @return array an array on success or false on failure. + * @return array|false an array on success or false on failure. */ function http_parse_headers ($header) {} @@ -2430,7 +2429,7 @@ function http_parse_headers ($header) {} * array containing recognized extra keys; * by default all unknown keys will be treated as cookie names *

- * @return stdClass|object a stdClass object on success or false on failure. + * @return stdClass|false a stdClass object on success or false on failure. */ function http_parse_cookie ($cookie, $flags = null, array $allowed_extras = null ) {} @@ -2455,7 +2454,7 @@ function http_build_cookie (array $cookie) {} * @param int $flags [optional]

* Parse flags *

- * @return stdClass|object parameter list as stdClass object. + * @return stdClass parameter list as stdClass object. */ function http_parse_params ($param, $flags = null) {} @@ -2471,7 +2470,7 @@ function http_get_request_headers () {} * (PECL pecl_http >= 0.10.0)
* Get request body as string * @link https://php.net/manual/en/function.http-get-request-body.php - * @return string the raw request body as string on success or NULL on failure. + * @return string|null the raw request body as string on success or NULL on failure. */ function http_get_request_body () {} @@ -2479,7 +2478,7 @@ function http_get_request_body () {} * (PECL pecl_http >= 0.22.0)
* Get request body as stream * @link https://php.net/manual/en/function.http-get-request-body-stream.php - * @return resource the raw request body as stream on success or NULL on failure. + * @return resource|null the raw request body as stream on success or NULL on failure. */ function http_get_request_body_stream () {} @@ -2504,7 +2503,7 @@ function http_match_request_header ($header, $value, $match_case = null) {} * (PECL pecl_http >= 1.5.0)
* Stat persistent handles * @link https://php.net/manual/en/function.http-persistent-handles-count.php - * @return stdClass|object persistent handles statistics as stdClass object on success or false on failure. + * @return stdClass|false persistent handles statistics as stdClass object on success or false on failure. */ function http_persistent_handles_count () {} @@ -2524,7 +2523,7 @@ function http_persistent_handles_clean ($ident = null) {} * @param string $ident

* the identification string *

- * @return string the prior ident as string on success or false on failure. + * @return string|false the prior ident as string on success or false on failure. */ function http_persistent_handles_ident ($ident) {} @@ -2698,7 +2697,7 @@ function http_request ($method, $url = null, $body = null, array $options = null * @param array $files

* POST files *

- * @return string encoded string on success or false on failure. + * @return string|false encoded string on success or false on failure. */ function http_request_body_encode (array $fields, array $files) {} @@ -2709,7 +2708,7 @@ function http_request_body_encode (array $fields, array $files) {} * @param string $method

* the request method name to register *

- * @return int the ID of the request method on success or false on failure. + * @return int|false the ID of the request method on success or false on failure. */ function http_request_method_register ($method) {} @@ -2731,7 +2730,7 @@ function http_request_method_unregister ($method) {} * @param mixed $method

* request method name or ID *

- * @return int true if the request method is known, else false. + * @return bool true if the request method is known, else false. */ function http_request_method_exists ($method) {} @@ -2742,7 +2741,7 @@ function http_request_method_exists ($method) {} * @param int $method

* request method ID *

- * @return string the request method name as string on success or false on failure. + * @return string|false the request method name as string on success or false on failure. */ function http_request_method_name ($method) {} @@ -2766,7 +2765,7 @@ function ob_etaghandler ($data, $mode) {} * @param int $flags [optional]

* deflate options *

- * @return string the encoded string on success, or NULL on failure. + * @return string|null the encoded string on success, or NULL on failure. */ function http_deflate ($data, $flags = null) {} @@ -2777,7 +2776,7 @@ function http_deflate ($data, $flags = null) {} * @param string $data

* string containing the compressed data *

- * @return string the decoded string on success, or NULL on failure. + * @return string|null the decoded string on success, or NULL on failure. */ function http_inflate ($data) {} diff --git a/ibm_db2/ibm_db2.php b/ibm_db2/ibm_db2.php index cd580888..7b242852 100644 --- a/ibm_db2/ibm_db2.php +++ b/ibm_db2/ibm_db2.php @@ -1548,7 +1548,7 @@ function db2_free_result ($stmt) {} /** * Set options for connection or statement resources * @link https://php.net/manual/en/function.db2-set-option.php - * @param resource resource

+ * @param resource $resource

* A valid statement resource as returned from * db2_prepare or a valid connection resource as * returned from db2_connect or @@ -1672,7 +1672,7 @@ function db2_lob_read ($stmt, $colnum, $length) {} /** * Retrieves an option value for a statement resource or a connection resource * @link https://php.net/manual/en/function.db2-get-option.php - * @param resource resource

+ * @param resource $resource

* A valid statement resource as returned from * db2_prepare or a valid connection resource as * returned from db2_connect or diff --git a/imagick/imagick.php b/imagick/imagick.php index 85f54b83..12c88953 100644 --- a/imagick/imagick.php +++ b/imagick/imagick.php @@ -980,7 +980,7 @@ class Imagick implements Iterator, Countable { * @param string $name

* name of the property (for example Exif:DateTime) *

- * @return string a string containing the image property, false if a + * @return string|false a string containing the image property, false if a * property with the given name does not exist. */ public function getImageProperty ($name) {} @@ -1253,7 +1253,7 @@ class Imagick implements Iterator, Countable { * (PECL imagick 2.1.0)
* Gets font * @link https://php.net/manual/en/imagick.getfont.php - * @return string the string containing the font name or FALSE if not font is set. + * @return string|false the string containing the font name or FALSE if not font is set. */ public function getFont () {} @@ -4563,7 +4563,7 @@ class Imagick implements Iterator, Countable { * Get the StringRegistry entry for the named key or false if not set. * @link https://php.net/manual/en/imagick.getregistry.php * @param string $key - * @return string + * @return string|false * @throws Exception Since version >=3.4.3. Throws an exception if the key does not exist, rather than terminating the program. * @since 3.3.0 */ @@ -5017,7 +5017,7 @@ class ImagickDraw { * (PECL imagick 2.0.0)
* Returns the font * @link https://php.net/manual/en/imagickdraw.getfont.php - * @return string a string on success and false if no font is set. + * @return string|false a string on success and false if no font is set. */ public function getFont () {} @@ -5025,7 +5025,7 @@ class ImagickDraw { * (PECL imagick 2.0.0)
* Returns the font family * @link https://php.net/manual/en/imagickdraw.getfontfamily.php - * @return string the font family currently selected or false if font family is not set. + * @return string|false the font family currently selected or false if font family is not set. */ public function getFontFamily () {} @@ -5422,7 +5422,7 @@ class ImagickDraw { * (PECL imagick 2.0.0)
* Obtains the current clipping path ID * @link https://php.net/manual/en/imagickdraw.getclippath.php - * @return string a string containing the clip path ID or false if no clip path exists. + * @return string|false a string containing the clip path ID or false if no clip path exists. */ public function getClipPath () {} diff --git a/imap/imap.php b/imap/imap.php index 5d5a164b..0129465e 100644 --- a/imap/imap.php +++ b/imap/imap.php @@ -44,7 +44,7 @@ * Connection parameters, the following (string) keys maybe used * to set one or more connection parameters: * DISABLE_AUTHENTICATOR - Disable authentication properties - * @return resource an IMAP stream on success or FALSE on error. + * @return resource|false an IMAP stream on success or FALSE on error. * @since 4.0 * @since 5.0 */ @@ -532,7 +532,7 @@ function imap_undelete ($imap_stream, $msg_number, $flags = 0) {} * Check current mailbox * @link https://php.net/manual/en/function.imap-check.php * @param resource $imap_stream - * @return object the information in an object with following properties: + * @return object|false the information in an object with following properties: * Date - current system time formatted according to RFC2822 * Driver - protocol used to access this mailbox: * POP3, IMAP, NNTP @@ -853,7 +853,7 @@ function imap_status_current ($stream_id, $options) {} * Get information about the current mailbox * @link https://php.net/manual/en/function.imap-mailboxmsginfo.php * @param resource $imap_stream - * @return object the information in an object with following properties: + * @return object|false the information in an object with following properties: * * Mailbox properties * @@ -1089,7 +1089,7 @@ function imap_fetch_overview ($imap_stream, $sequence, $options = 0) {} /** * Returns all IMAP alert messages that have occurred * @link https://php.net/manual/en/function.imap-alerts.php - * @return array an array of all of the IMAP alert messages generated or FALSE if + * @return array|false an array of all of the IMAP alert messages generated or FALSE if * no alert messages are available. * @since 4.0 * @since 5.0 @@ -1099,7 +1099,7 @@ function imap_alerts () {} /** * Returns all of the IMAP errors that have occurred * @link https://php.net/manual/en/function.imap-errors.php - * @return array This function returns an array of all of the IMAP error messages + * @return array|false This function returns an array of all of the IMAP error messages * generated since the last imap_errors call, * or the beginning of the page. Returns FALSE if no error messages are * available. @@ -1111,7 +1111,7 @@ function imap_errors () {} /** * Gets the last IMAP error that occurred during this page request * @link https://php.net/manual/en/function.imap-last-error.php - * @return string the full text of the last IMAP error message that occurred on the + * @return string|false the full text of the last IMAP error message that occurred on the * current page. Returns FALSE if no error messages are available. * @since 4.0 * @since 5.0 @@ -1134,7 +1134,7 @@ function imap_last_error () {} * contain UIDs instead of messages sequence numbers. *

* @param string $charset [optional] - * @return array an array of message numbers or UIDs. + * @return array|false an array of message numbers or UIDs. *

*

* Return FALSE if it does not understand the search @@ -1233,7 +1233,7 @@ function imap_thread ($imap_stream, $options = SE_FREE) {} * @param int $timeout [optional]

* The timeout, in seconds. *

- * @return mixed If the timeout parameter is set, this function + * @return int|bool If the timeout parameter is set, this function * returns TRUE on success and FALSE on failure. *

*

@@ -1254,7 +1254,7 @@ function imap_timeout ($timeout_type, $timeout = -1) {} * user.name where name is the mailbox you wish to * retrieve information about. *

- * @return array an array with integer values limit and usage for the given + * @return array|false an array with integer values limit and usage for the given * mailbox. The value of limit represents the total amount of space * allowed for this mailbox. The usage value represents the mailboxes * current level of capacity. Will return FALSE in the case of failure. @@ -1283,7 +1283,7 @@ function imap_get_quota ($imap_stream, $quota_root) {} * quota_root should normally be in the form of * which mailbox (i.e. INBOX). *

- * @return array an array of integer values pertaining to the specified user + * @return array|false an array of integer values pertaining to the specified user * mailbox. All values contain a key based upon the resource name, and a * corresponding array with the usage and limit values within. *

diff --git a/inotify/inotify.php b/inotify/inotify.php index 6bc9b234..57e3762c 100644 --- a/inotify/inotify.php +++ b/inotify/inotify.php @@ -23,7 +23,7 @@ function inotify_add_watch( $inotify_instance, $pathname, $mask ) * Initialize an inotify instance for use with {@see inotify_add_watch} * * @link https://php.net/manual/en/function.inotify-init.php - * @return resource a stream resource or FALSE on error. + * @return resource|false a stream resource or FALSE on error. */ function inotify_init() { @@ -53,7 +53,7 @@ function inotify_queue_len( $inotify_instance ) * * @param resource $inotify_instance

resource returned by {@link https://php.net/manual/en/function.inotify-init.php inotify_init()}

* - * @return array an array of inotify events or FALSE if no events + * @return array|false an array of inotify events or FALSE if no events * were pending and inotify_instance is non-blocking. Each event * is an array with the following keys: * diff --git a/interbase/interbase.php b/interbase/interbase.php index 89d80bcd..1df9c79d 100644 --- a/interbase/interbase.php +++ b/interbase/interbase.php @@ -40,7 +40,7 @@ *

* @param int $sync [optional]

*

- * @return resource an InterBase link identifier on success, or false on error. + * @return resource|false an InterBase link identifier on success, or false on error. * @since 4.0 * @since 5.0 */ @@ -84,7 +84,7 @@ function ibase_connect ($database = null, $username = null, $password = null, $c *

* @param int $sync [optional]

*

- * @return resource an InterBase link identifier on success, or false on error. + * @return resource|false an InterBase link identifier on success, or false on error. * @since 4.0 * @since 5.0 */ @@ -128,7 +128,7 @@ function ibase_drop_db ($connection = null) {} *

* @param int $bind_args [optional]

*

- * @return resource If the query raises an error, returns false. If it is successful and + * @return resource|false If the query raises an error, returns false. If it is successful and * there is a (possibly empty) result set (such as with a SELECT query), * returns a result identifier. If the query was successful and there were * no results, returns true. @@ -157,7 +157,7 @@ function ibase_query ($link_identifier = null, $query, $bind_args = null) {} * IBASE_UNIXTIME will cause this function to return * date/time values as Unix timestamps instead of as formatted strings. *

- * @return array an array that corresponds to the fetched row, or false if there + * @return array|false an array that corresponds to the fetched row, or false if there * are no more rows. Each result column is stored in an array offset, * starting at offset 0. * @since 4.0 @@ -179,7 +179,7 @@ function ibase_fetch_row ($result_identifier, $fetch_flag = null) {} * IBASE_UNIXTIME will cause this function to return * date/time values as Unix timestamps instead of as formatted strings. *

- * @return array an associative array that corresponds to the fetched row. + * @return array|false an associative array that corresponds to the fetched row. * Subsequent calls will return the next row in the result set, or false if * there are no more rows. * @since 4.3.0 @@ -202,7 +202,7 @@ function ibase_fetch_assoc ($result, $fetch_flag = null) {} * IBASE_UNIXTIME will cause this function to return * date/time values as Unix timestamps instead of as formatted strings. *

- * @return object an object with the next row information, or false if there are + * @return object|false an object with the next row information, or false if there are * no more rows. * @since 4.0 * @since 5.0 @@ -242,7 +242,7 @@ function ibase_name_result ($result, $name) {} * @param string $query

* An InterBase query. *

- * @return resource a prepared query handle, or false on error. + * @return resource|false a prepared query handle, or false on error. * @since 4.0 * @since 5.0 */ @@ -257,7 +257,7 @@ function ibase_prepare ($query) {} * @param mixed $bind_arg [optional]

*

* @param mixed $_ [optional] - * @return resource If the query raises an error, returns false. If it is successful and + * @return resource|false If the query raises an error, returns false. If it is successful and * there is a (possibly empty) result set (such as with a SELECT query), * returns a result identifier. If the query was successful and there were * no results, returns true. @@ -382,7 +382,7 @@ function ibase_param_info ($query, $param_number) {} * An InterBase link identifier. If omitted, the last opened link is * assumed. *

- * @return resource a transaction handle, or false on error. + * @return resource|false a transaction handle, or false on error. * @since 4.0 * @since 5.0 */ @@ -555,7 +555,7 @@ function ibase_blob_open ($link_identifier, $blob_id) {} * @param int $len

* Size of returned data. *

- * @return string at most len bytes from the BLOB, or false + * @return string|false at most len bytes from the BLOB, or false * on failure. * @since 4.0 * @since 5.0 @@ -583,7 +583,7 @@ function ibase_blob_echo ($blob_id) {} * @param resource $file_handle

* The file handle is a handle returned by fopen. *

- * @return string the BLOB id on success, or false on error. + * @return string|false the BLOB id on success, or false on error. * @since 4.0 * @since 5.0 */ @@ -592,7 +592,7 @@ function ibase_blob_import ($link_identifier, $file_handle) {} /** * Return error messages * @link https://php.net/manual/en/function.ibase-errmsg.php - * @return string the error message as a string, or false if no error occurred. + * @return string|false the error message as a string, or false if no error occurred. * @since 4.0 * @since 5.0 */ @@ -601,7 +601,7 @@ function ibase_errmsg () {} /** * Return an error code * @link https://php.net/manual/en/function.ibase-errcode.php - * @return int the error code as an integer, or false if no error occurred. + * @return int|false the error code as an integer, or false if no error occurred. * @since 5.0 */ function ibase_errcode () {} diff --git a/intl/IntlChar.php b/intl/IntlChar.php index c6788045..7880334c 100644 --- a/intl/IntlChar.php +++ b/intl/IntlChar.php @@ -746,7 +746,7 @@ class IntlChar { *
  • IntlChar::CHAR_NAME_ALIAS
    • *
  • IntlChar::CHAR_NAME_CHOICE_COUNT
    • * - * @return int The Unicode value of the code point with the given name (as an integer), or FALSE if there is no such code point. + * @return int|false The Unicode value of the code point with the given name (as an integer), or FALSE if there is no such code point. * @since 7.0 */ public static function charFromName($characterName, $nameChoice = IntlChar::UNICODE_CHAR_NAME) {} @@ -838,7 +838,7 @@ class IntlChar { * @link https://php.net/manual/ru/intlchar.digit.php * @param string $codepoint

    The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

    * @param int $radix

    The radix (defaults to 10).

    - * @return int Returns the numeric value represented by the character in the specified radix, or FALSE if there is no value or if the value exceeds the radix. + * @return int|false Returns the numeric value represented by the character in the specified radix, or FALSE if there is no value or if the value exceeds the radix. * @since 7.0 */ public static function digit ($codepoint,$radix = 10 ) {} @@ -1007,7 +1007,7 @@ class IntlChar { *

    IntlChar::PROPERTY_INVALID_CODE should not be used. Also, if property is out of range, FALSE is returned.

    * @param int $nameChoice

    Selector for which name to get. If out of range, FALSE is returned.

    *

    All properties have a long name. Most have a short name, but some do not. Unicode allows for additional names; if present these will be returned by adding 1, 2, etc. to IntlChar::LONG_PROPERTY_NAME.

    - * @return string

    + * @return string|false

    * Returns the name, or FALSE if either the property or the nameChoice * is out of range. *

    @@ -1056,7 +1056,7 @@ class IntlChar { * Selector for which name to get. If out of range, FALSE is returned. * All values have a long name. Most have a short name, but some do not. Unicode allows for additional names; if present these will be returned by adding 1, 2, etc. to IntlChar::LONG_PROPERTY_NAME. *

    - * @return string Returns the name, or FALSE if either the property or the nameChoice is out of range. + * @return string|false Returns the name, or FALSE if either the property or the nameChoice is out of range. * If a given nameChoice returns FALSE, then all larger values of nameChoice will return FALSE, with one exception: if FALSE is returned for IntlChar::SHORT_PROPERTY_NAME, then IntlChar::LONG_PROPERTY_NAME (and higher) may still return a non-FALSE value. * @since 7.0 */ @@ -1244,7 +1244,7 @@ class IntlChar { * Check if code point is a titlecase letter * @link https://php.net/manual/ru/intlchar.istitle.php * @param mixed $codepoint The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return boolean Returns TRUE if codepoint is a titlecase letter, FALSE if not. + * @return bool Returns TRUE if codepoint is a titlecase letter, FALSE if not. * @since 7.0 */ public static function istitle ($codepoint ){} diff --git a/intl/intl.php b/intl/intl.php index f1175f4d..00c3b11c 100644 --- a/intl/intl.php +++ b/intl/intl.php @@ -338,7 +338,7 @@ class Collator { * @param int $attr

    * Attribute to get value for. *

    - * @return int Attribute value, or boolean FALSE on error. + * @return int|false Attribute value, or boolean FALSE on error. */ public function getAttribute($attr) { } @@ -358,7 +358,7 @@ class Collator { * (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
    * Get current collation strength * @link https://php.net/manual/en/collator.getstrength.php - * @return int current collation strength, or boolean FALSE on error. + * @return int|false current collation strength, or boolean FALSE on error. */ public function getStrength() { } @@ -899,7 +899,7 @@ class NumberFormatter { * @param string $pattern [optional]

    * Pattern string if the chosen style requires a pattern. *

    - * @return NumberFormatter NumberFormatter object or FALSE on error. + * @return NumberFormatter|false NumberFormatter object or FALSE on error. */ public static function create($locale, $style, $pattern = null) { } @@ -915,7 +915,7 @@ class NumberFormatter { * The * formatting type to use. *

    - * @return string the string containing formatted value, or FALSE on error. + * @return string|false the string containing formatted value, or FALSE on error. */ public function format($value, $type = null) { } @@ -964,7 +964,7 @@ class NumberFormatter { * Offset in the string at which to begin parsing. On return, this value * will hold the offset at which parsing ended. *

    - * @return float The parsed numeric value or FALSE on error. + * @return float|false The parsed numeric value or FALSE on error. */ public function parseCurrency($value, &$currency, &$position = null) { } @@ -991,7 +991,7 @@ class NumberFormatter { * Attribute specifier - one of the * numeric attribute constants. *

    - * @return int Return attribute value on success, or FALSE on error. + * @return int|false Return attribute value on success, or FALSE on error. */ public function getAttribute($attr) { } @@ -1019,7 +1019,7 @@ class NumberFormatter { * Attribute specifier - one of the * text attribute constants. *

    - * @return string Return attribute value on success, or FALSE on error. + * @return string|false Return attribute value on success, or FALSE on error. */ public function getTextAttribute($attr) { } @@ -1046,7 +1046,7 @@ class NumberFormatter { * Symbol specifier, one of the * format symbol constants. *

    - * @return string The symbol string or FALSE on error. + * @return string|false The symbol string or FALSE on error. */ public function getSymbol($attr) { } @@ -1067,7 +1067,7 @@ class NumberFormatter { * (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
    * Get formatter pattern * @link https://php.net/manual/en/numberformatter.getpattern.php - * @return string Pattern string that is used by the formatter, or FALSE if an error happens. + * @return string|false Pattern string that is used by the formatter, or FALSE if an error happens. */ public function getPattern() { } @@ -1527,7 +1527,7 @@ class MessageFormatter { * @param array $args

    * Arguments to insert into the format string *

    - * @return string The formatted string, or FALSE if an error occurred + * @return string|false The formatted string, or FALSE if an error occurred */ public function format(array $args) { } @@ -1547,7 +1547,7 @@ class MessageFormatter { * @param array $args

    * The array of values to insert into the format string *

    - * @return string The formatted pattern string or FALSE if an error occurred + * @return string|false The formatted pattern string or FALSE if an error occurred */ public static function formatMessage($locale, $pattern, array $args) { } @@ -1558,7 +1558,7 @@ class MessageFormatter { * @param string $value

    * The string to parse *

    - * @return array An array containing the items extracted, or FALSE on error + * @return array|false An array containing the items extracted, or FALSE on error */ public function parse($value) { } @@ -1575,7 +1575,7 @@ class MessageFormatter { * @param string $source

    * The string to parse, conforming to the pattern. *

    - * @return array An array containing items extracted, or FALSE on error + * @return array|false An array containing items extracted, or FALSE on error */ public static function parseMessage($locale, $pattern, $source) { } @@ -1774,7 +1774,7 @@ class IntlDateFormatter { * (PHP 5 >= 5.5.0, PECL intl >= 3.0.0)
    * Get formatter's timezone * @link https://secure.php.net/manual/en/intldateformatter.gettimezone.php - * @return IntlTimeZone|bool The associated IntlTimeZone object or FALSE on failure. + * @return IntlTimeZone|false The associated IntlTimeZone object or FALSE on failure. */ public function getTimeZone() { } @@ -1857,7 +1857,7 @@ class IntlDateFormatter { * Get the locale used by formatter * @link https://php.net/manual/en/intldateformatter.getlocale.php * @param int $which [optional] - * @return string the locale of this formatter or 'false' if error + * @return string|false the locale of this formatter or 'false' if error */ public function getLocale($which = null) { } @@ -1890,7 +1890,7 @@ class IntlDateFormatter { * since epoch, UTC) or an array in the format output by * localtime. *

    - * @return string The formatted string or, if an error occurred, FALSE. + * @return string|false The formatted string or, if an error occurred, FALSE. */ public function format($value) { } @@ -1916,7 +1916,7 @@ class IntlDateFormatter { *

    * @param string $locale [optional]

    * The locale to use, or NULL to use the {@link "https://secure.php.net/manual/en/intl.configuration.php#ini.intl.default-locale"default one}.

    - * @return string A string with result or FALSE on failure. + * @return string|false A string with result or FALSE on failure. */ public static function formatObject($object, $format = NULL, $locale = NULL) { } @@ -1994,7 +1994,7 @@ class ResourceBundle implements Traversable { * @param bool $fallback [optional]

    * Whether locale should match exactly or fallback to parent locale is allowed. *

    - * @return ResourceBundle ResourceBundle object or FALSE on error. + * @return ResourceBundle|false ResourceBundle object or FALSE on error. */ public static function create($locale, $bundlename, $fallback = null) { } @@ -2133,7 +2133,7 @@ class Transliterator { * transformed, exclusive. Indexing starts at 0. The text after will be * left as is. *

    - * @return string The transfomed string on success, or FALSE on failure. + * @return string|false The transfomed string on success, or FALSE on failure. */ public function transliterate($subject, $start = null, $end = null) { } @@ -2587,7 +2587,7 @@ class IntlCalendar { *

    * Whether to show only the values commonly used for the specified locale. *

    - * @return Iterator An iterator that yields strings with the locale keyword values or FALSE on failure. + * @return Iterator|false An iterator that yields strings with the locale keyword values or FALSE on failure. */ public static function getKeywordValuesForLocale($key, $locale, $commonlyUsed) { } @@ -2770,7 +2770,7 @@ class IntlCalendar { * (PHP 5 >=5.5.0 PECL intl >= 3.0.0a1)
    * Whether a certain date/time is in the weekend * @link https://secure.php.net/manual/en/intlcalendar.isweekend.php - * @param float $date [optional]

    + * @param float|null $date [optional]

    * An optional timestamp representing the number of milliseconds since the * epoch, excluding leap seconds. If NULL, this object's current time is * used instead. @@ -2883,7 +2883,7 @@ class IntlCalendar { * @param string $isLenient

    * Use TRUE to activate the lenient mode; FALSE otherwise. *

    - * @return boolean Returns TRUE on success. Failure can only happen due to invalid parameters. + * @return bool Returns TRUE on success. Failure can only happen due to invalid parameters. */ public function setLenient($isLenient) { } @@ -2975,7 +2975,7 @@ class IntlCalendar { * (PHP 5 >=5.5.0 PECL intl >= 3.0.0a2)
    * Convert an IntlCalendar into a DateTime object * @link https://secure.php.net/manual/en/intlcalendar.todatetime.php - * @return DateTime|bool + * @return DateTime|false * A {@link https://secure.php.net/manual/en/class.datetime.php DateTime} object with the same timezone as this * object (though using PHP's database instead of ICU's) and the same time, * except for the smaller precision (second precision instead of millisecond). @@ -3279,7 +3279,7 @@ function collator_compare(Collator $object, $str1, $str2) { } * @param int $attr

    * Attribute to get value for. *

    - * @return int Attribute value, or boolean FALSE on error. + * @return int|false Attribute value, or boolean FALSE on error. */ function collator_get_attribute(Collator $object, $attr) { } @@ -3301,7 +3301,7 @@ function collator_set_attribute(Collator $object, $attr, $val) { } * Get current collation strength * @link https://php.net/manual/en/collator.getstrength.php * @param Collator $object - * @return int current collation strength, or boolean FALSE on error. + * @return int|false current collation strength, or boolean FALSE on error. */ function collator_get_strength(Collator $object) { } @@ -3435,7 +3435,7 @@ function collator_get_sort_key(Collator $object, $str) { } * @param string $pattern [optional]

    * Pattern string if the chosen style requires a pattern. *

    - * @return NumberFormatter NumberFormatter object or FALSE on error. + * @return NumberFormatter|false NumberFormatter object or FALSE on error. */ function numfmt_create($locale, $style, $pattern = null) { } @@ -3452,7 +3452,7 @@ function numfmt_create($locale, $style, $pattern = null) { } * The * formatting type to use. *

    - * @return string the string containing formatted value, or FALSE on error. + * @return string|false the string containing formatted value, or FALSE on error. */ function numfmt_format(NumberFormatter $fmt, $value, $type = null) { } @@ -3504,7 +3504,7 @@ function numfmt_format_currency(NumberFormatter $fmt, $value, $currency) { } * Offset in the string at which to begin parsing. On return, this value * will hold the offset at which parsing ended. *

    - * @return float The parsed numeric value or FALSE on error. + * @return float|false The parsed numeric value or FALSE on error. */ function numfmt_parse_currency(NumberFormatter $fmt, $value, &$currency, &$position = null) { } @@ -3533,7 +3533,7 @@ function numfmt_set_attribute(NumberFormatter $fmt, $attr, $value) { } * Attribute specifier - one of the * numeric attribute constants. *

    - * @return int Return attribute value on success, or FALSE on error. + * @return int|false Return attribute value on success, or FALSE on error. */ function numfmt_get_attribute(NumberFormatter $fmt, $attr) { } @@ -3563,7 +3563,7 @@ function numfmt_set_text_attribute(NumberFormatter $fmt, $attr, $value) { } * Attribute specifier - one of the * text attribute constants. *

    - * @return string Return attribute value on success, or FALSE on error. + * @return string|false Return attribute value on success, or FALSE on error. */ function numfmt_get_text_attribute(NumberFormatter $fmt, $attr) { } @@ -3592,7 +3592,7 @@ function numfmt_set_symbol(NumberFormatter $fmt, $attr, $value) { } * Symbol specifier, one of the * format symbol constants. *

    - * @return string The symbol string or FALSE on error. + * @return string|false The symbol string or FALSE on error. */ function numfmt_get_symbol(NumberFormatter $fmt, $attr) { } @@ -3616,7 +3616,7 @@ function numfmt_set_pattern(NumberFormatter $fmt, $pattern) { } * @link https://php.net/manual/en/numberformatter.getpattern.php * @param NumberFormatter $fmt * @param $nf - * @return string Pattern string that is used by the formatter, or FALSE if an error happens. + * @return string|false Pattern string that is used by the formatter, or FALSE if an error happens. */ function numfmt_get_pattern(NumberFormatter $fmt, $nf) { } @@ -3939,7 +3939,7 @@ function msgfmt_create($locale, $pattern) { } * @param array $args

    * Arguments to insert into the format string *

    - * @return string The formatted string, or FALSE if an error occurred + * @return string|false The formatted string, or FALSE if an error occurred */ function msgfmt_format(MessageFormatter $fmt, array $args) { } @@ -3959,7 +3959,7 @@ function msgfmt_format(MessageFormatter $fmt, array $args) { } * @param array $args

    * The array of values to insert into the format string *

    - * @return string The formatted pattern string or FALSE if an error occurred + * @return string|false The formatted pattern string or FALSE if an error occurred */ function msgfmt_format_message(string $locale, string $pattern, array $args) { } @@ -3971,7 +3971,7 @@ function msgfmt_format_message(string $locale, string $pattern, array $args) { } * @param string $value

    * The string to parse *

    - * @return array An array containing the items extracted, or FALSE on error + * @return array|false An array containing the items extracted, or FALSE on error */ function msgfmt_parse(MessageFormatter $fmt, $value) { } @@ -3989,7 +3989,7 @@ function msgfmt_parse(MessageFormatter $fmt, $value) { } * @param string $source

    * The string to parse, conforming to the pattern. *

    - * @return array An array containing items extracted, or FALSE on error + * @return array|false An array containing items extracted, or FALSE on error */ function msgfmt_parse_message(MessageFormatter $fmt, $locale, $pattern, $source) { } @@ -4131,7 +4131,7 @@ function datefmt_set_calendar(MessageFormatter $mf, $which) { } * @link https://php.net/manual/en/intldateformatter.getlocale.php * @param MessageFormatter $mf * @param int $which [optional] - * @return string the locale of this formatter or 'false' if error + * @return string|false the locale of this formatter or 'false' if error */ function datefmt_get_locale(MessageFormatter $mf, $which = null) { } @@ -4156,7 +4156,7 @@ function datefmt_get_calendar_object() { } * (PHP 5 >= 5.5.0, PECL intl >= 3.0.0)
    * Get formatter's timezone * @link https://secure.php.net/manual/en/intldateformatter.gettimezone.php - * @return IntlTimeZone|bool The associated IntlTimeZone object or FALSE on failure. + * @return IntlTimeZone|false The associated IntlTimeZone object or FALSE on failure. */ function datefmt_get_timezone() { } @@ -4270,7 +4270,7 @@ function datefmt_set_lenient(MessageFormatter $mf, $lenient) { } * since epoch, UTC) or an array in the format output by * localtime. *

    - * @return string The formatted string or, if an error occurred, FALSE. + * @return string|false The formatted string or, if an error occurred, FALSE. */ function datefmt_format(MessageFormatter $mf, $value) { } @@ -4294,9 +4294,9 @@ function datefmt_format(MessageFormatter $mf, $value) { } * described in {@link http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details the ICU documentation} * documentation. If NULL, the default style will be used. *

    - * @param string $locale [optional]

    + * @param string|null $locale [optional]

    * The locale to use, or NULL to use the default one.

    - * @return string The formatted string or, if an error occurred, FALSE. + * @return string|false The formatted string or, if an error occurred, FALSE. */ function datefmt_format_object($object, $format = NULL, $locale = NULL) { } @@ -4383,7 +4383,7 @@ function grapheme_strlen($input) { } * The position returned is still relative to the beginning of haystack * regardless of the value of $offset. *

    - * @return int the position as an integer. If needle is not found, strpos() will return boolean FALSE. + * @return int|false the position as an integer. If needle is not found, strpos() will return boolean FALSE. */ function grapheme_strpos($haystack, $needle, $offset = 0) { } @@ -4403,7 +4403,7 @@ function grapheme_strpos($haystack, $needle, $offset = 0) { } * The position returned is still relative to the beginning of haystack * regardless of the value of $offset. *

    - * @return int the position as an integer. If needle is not found, grapheme_stripos() will return boolean FALSE. + * @return int|false the position as an integer. If needle is not found, grapheme_stripos() will return boolean FALSE. */ function grapheme_stripos($haystack, $needle, $offset = 0) { } @@ -4423,7 +4423,7 @@ function grapheme_stripos($haystack, $needle, $offset = 0) { } * The position returned is still relative to the beginning of haystack * regardless of the value of $offset. *

    - * @return int the position as an integer. If needle is not found, grapheme_strrpos() will return boolean FALSE. + * @return int|false the position as an integer. If needle is not found, grapheme_strrpos() will return boolean FALSE. */ function grapheme_strrpos($haystack, $needle, $offset = 0) { } @@ -4443,7 +4443,7 @@ function grapheme_strrpos($haystack, $needle, $offset = 0) { } * The position returned is still relative to the beginning of haystack * regardless of the value of $offset. *

    - * @return int the position as an integer. If needle is not found, grapheme_strripos() will return boolean FALSE. + * @return int|false the position as an integer. If needle is not found, grapheme_strripos() will return boolean FALSE. */ function grapheme_strripos($haystack, $needle, $offset = 0) { } @@ -4490,7 +4490,7 @@ function grapheme_substr($string, $start, $length = null) { } * If TRUE, grapheme_strstr() returns the part of the * haystack before the first occurrence of the needle (excluding the needle). *

    - * @return string the portion of string, or FALSE if needle is not found. + * @return string|false the portion of string, or FALSE if needle is not found. */ function grapheme_strstr($haystack, $needle, $before_needle = false) { } @@ -4508,7 +4508,7 @@ function grapheme_strstr($haystack, $needle, $before_needle = false) { } * If TRUE, grapheme_strstr() returns the part of the * haystack before the first occurrence of the needle (excluding needle). *

    - * @return string the portion of $haystack, or FALSE if $needle is not found. + * @return string|false the portion of $haystack, or FALSE if $needle is not found. */ function grapheme_stristr($haystack, $needle, $before_needle = false) { } @@ -4572,7 +4572,7 @@ function grapheme_extract($haystack, $size, $extract_type = null, $start = 0, &$ * either has or would have changed the result and 'errors', * which is an int representing a bitset of the error constants IDNA_ERROR_*. *

    - * @return string The ACE encoded version of the domain name or FALSE on failure. + * @return string|false The ACE encoded version of the domain name or FALSE on failure. */ function idn_to_ascii($domain, $options = 0, $variant = INTL_IDNA_VARIANT_2003, array &$idna_info) { } @@ -4665,7 +4665,7 @@ function intlcal_create_instance($timeZone = NULL, $locale = NULL) { } *

    * Whether to show only the values commonly used for the specified locale. *

    - * @return Iterator An iterator that yields strings with the locale keyword values or FALSE on failure. + * @return Iterator|false An iterator that yields strings with the locale keyword values or FALSE on failure. */ function intlcal_get_keyword_values_for_locale($key, $locale, $commonlyUsed) { } @@ -5258,7 +5258,7 @@ function intlcal_is_equivalent_to(IntlCalendar $calendarObject, IntlCalendar $ca * @param IntlCalendar $calendar

    * The calendar object, on the procedural style interface. *

    - * @param float $date [optional]

    + * @param float|null $date [optional]

    * An optional timestamp representing the number of milliseconds since the * epoch, excluding leap seconds. If NULL, this object's current time is * used instead. @@ -5301,7 +5301,7 @@ function intlcal_set_first_day_of_week($calendar, $dayOfWeek) { } * @param string $isLenient

    * Use TRUE to activate the lenient mode; FALSE otherwise. *

    - * @return boolean Returns TRUE on success. Failure can only happen due to invalid parameters. + * @return bool Returns TRUE on success. Failure can only happen due to invalid parameters. */ function intlcal_set_lenient($calendar, $isLenient) { } @@ -5411,7 +5411,7 @@ function intlcal_from_date_time($dateTime) { } * @param IntlCalendar $calendar

    * The calendar object, on the procedural style interface. *

    - * @return DateTime|bool + * @return DateTime|false * A {@link https://secure.php.net/manual/en/class.datetime.php DateTime} object with the same timezone as this * object (though using PHP's database instead of ICU's) and the same time, * except for the smaller precision (second precision instead of millisecond). @@ -5668,7 +5668,7 @@ function intlgregcal_is_leap_year($year) { } * @param bool $fallback [optional]

    * Whether locale should match exactly or fallback to parent locale is allowed. *

    - * @return ResourceBundle ResourceBundle object or FALSE on error. + * @return ResourceBundle|false ResourceBundle object or FALSE on error. */ function resourcebundle_create($locale, $bundlename, $fallback = null) { } @@ -5800,7 +5800,7 @@ function transliterator_create_inverse(Transliterator $orig_trans) { } * transformed, exclusive. Indexing starts at 0. The text after will be * left as is. *

    - * @return string The transfomed string on success, or FALSE on failure. + * @return string|false The transfomed string on success, or FALSE on failure. */ function transliterator_transliterate($transliterator, $subject, $start = null, $end = null) { } diff --git a/ldap/ldap.php b/ldap/ldap.php index ff12fe3e..8f51ab9c 100644 --- a/ldap/ldap.php +++ b/ldap/ldap.php @@ -14,7 +14,7 @@ * @param int $port [optional]

    * The port to connect to. Not used when using URLs. *

    - * @return resource a positive LDAP link identifier on success, or FALSE on error. + * @return resource|false a positive LDAP link identifier on success, or FALSE on error. * When OpenLDAP 2.x.x is used, ldap_connect will always * return a resource as it does not actually connect but just * initializes the connecting parameters. The actual connect happens with @@ -139,7 +139,7 @@ function ldap_unbind ($link_identifier) {} * one of the following: * LDAP_DEREF_NEVER - (default) aliases are never * dereferenced. - * @return resource a search result identifier or FALSE on error. + * @return resource|false a search result identifier or FALSE on error. * @since 4.0 * @since 5.0 */ @@ -198,7 +198,7 @@ function ldap_read ($link_identifier, $base_dn, $filter, array $attributes = nul * one of the following: * LDAP_DEREF_NEVER - (default) aliases are never * dereferenced. - * @return resource a search result identifier or FALSE on error. + * @return resource|false a search result identifier or FALSE on error. * @since 4.0 * @since 5.0 */ @@ -261,7 +261,7 @@ function ldap_list ($link_identifier, $base_dn, $filter, array $attributes = nul * one of the following: * LDAP_DEREF_NEVER - (default) aliases are never * dereferenced. - * @return resource a search result identifier or FALSE on error. + * @return resource|false a search result identifier or FALSE on error. * @since 4.0 * @since 5.0 */ @@ -286,7 +286,7 @@ function ldap_free_result ($result_identifier) {} * @param resource $result_identifier

    * The internal LDAP result. *

    - * @return int number of entries in the result or FALSE on error. + * @return int|false number of entries in the result or FALSE on error. * @since 4.0 * @since 5.0 */ @@ -313,7 +313,7 @@ function ldap_first_entry ($link_identifier, $result_identifier) {} * An LDAP link identifier, returned by ldap_connect. *

    * @param resource $result_entry_identifier - * @return resource entry identifier for the next entry in the result whose entries + * @return resource|false entry identifier for the next entry in the result whose entries * are being read starting with ldap_first_entry. If * there are no more entries in the result then it returns FALSE. * @since 4.0 @@ -358,7 +358,7 @@ function ldap_get_entries ($link_identifier, $result_identifier) {} * An LDAP link identifier, returned by ldap_connect. *

    * @param resource $result_entry_identifier - * @return string the first attribute in the entry on success and FALSE on + * @return string|false the first attribute in the entry on success and FALSE on * error. * @since 4.0 * @since 5.0 @@ -372,7 +372,7 @@ function ldap_first_attribute ($link_identifier, $result_entry_identifier) {} * An LDAP link identifier, returned by ldap_connect. *

    * @param resource $result_entry_identifier - * @return string the next attribute in an entry on success and FALSE on + * @return string|false the next attribute in an entry on success and FALSE on * error. * @since 4.0 * @since 5.0 @@ -401,7 +401,7 @@ function ldap_get_attributes ($link_identifier, $result_entry_identifier) {} *

    * @param resource $result_entry_identifier * @param string $attribute - * @return array an array of values for the attribute on success and FALSE on + * @return array|false an array of values for the attribute on success and FALSE on * error. The number of values can be found by indexing "count" in the * resultant array. Individual values are accessed by integer index in the * array. The first index is 0. @@ -426,7 +426,7 @@ function ldap_get_values ($link_identifier, $result_entry_identifier, $attribute *

    * @param resource $result_entry_identifier * @param string $attribute - * @return array an array of values for the attribute on success and FALSE on + * @return array|false an array of values for the attribute on success and FALSE on * error. Individual values are accessed by integer index in the array. The * first index is 0. The number of values can be found by indexing "count" * in the resultant array. @@ -442,7 +442,7 @@ function ldap_get_values_len ($link_identifier, $result_entry_identifier, $attri * An LDAP link identifier, returned by ldap_connect. *

    * @param resource $result_entry_identifier - * @return string the DN of the result entry and FALSE on error. + * @return string|false the DN of the result entry and FALSE on error. * @since 4.0 * @since 5.0 */ diff --git a/libevent/libevent.php b/libevent/libevent.php index a4a6449e..b1d49fed 100644 --- a/libevent/libevent.php +++ b/libevent/libevent.php @@ -123,7 +123,7 @@ define('EVBUFFER_TIMEOUT', 64); * * @link https://php.net/event_base_new * - * @return resource|bool returns valid event base resource on success or FALSE on error. + * @return resource|false returns valid event base resource on success or FALSE on error. */ function event_base_new(){} @@ -257,7 +257,7 @@ function event_base_priority_init($event_base, $npriorities) {} * * @link https://php.net/event_new * - * @return resource|bool returns a new event resource on success or FALSE on error. + * @return resource|false returns a new event resource on success or FALSE on error. */ function event_new() {} @@ -398,7 +398,7 @@ function event_del($event) {} * @param callback $errorcb Callback to invoke where there is an error on the descriptor, cannot be NULL. * @param mixed $arg An argument that will be passed to each of the callbacks (optional). * - * @return resource|bool returns new buffered event resource on success or FALSE on error. + * @return resource|false returns new buffered event resource on success or FALSE on error. */ function event_buffer_new($stream, $readcb, $writecb, $errorcb, $arg = null) {} @@ -602,7 +602,7 @@ function event_buffer_fd_set($bevent, $fd) {} * @param resource $bevent Valid buffered event resource. * @param callback|null $readcb Callback to invoke where there is data to read, or NULL if no callback is desired. * @param callback|null $writecb Callback to invoke where the descriptor is ready for writing, or NULL if no callback is desired. - * @param callback|null $errorcb Callback to invoke where there is an error on the descriptor, cannot be NULL. + * @param callback $errorcb Callback to invoke where there is an error on the descriptor, cannot be NULL. * @param mixed $arg An argument that will be passed to each of the callbacks (optional). * * @return bool returns TRUE on success or FALSE on error. @@ -613,7 +613,7 @@ function event_buffer_set_callback($bevent, $readcb, $writecb, $errorcb, $arg = /** *

    Alias of {@link event_new}().

    * - * @return resource|bool returns valid event base resource on success or FALSE on error. + * @return resource|false returns valid event base resource on success or FALSE on error. */ function event_timer_new() {} diff --git a/mailparse/mailparse.php b/mailparse/mailparse.php index 9e09e848..a74b900c 100644 --- a/mailparse/mailparse.php +++ b/mailparse/mailparse.php @@ -133,7 +133,7 @@ function mailparse_msg_get_structure ($mimemail) {} * @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, or on error. + * @return resource|false Returns a MIME resource representing the structure, or on error. */ function mailparse_msg_parse_file ($filename) {} diff --git a/mapscript/mapscript.php b/mapscript/mapscript.php index 5533bdec..c525dc92 100644 --- a/mapscript/mapscript.php +++ b/mapscript/mapscript.php @@ -955,7 +955,7 @@ final class labelcacheObj * Free the label cache. Always returns MS_SUCCESS. * Ex : map->labelcache->freeCache(); * - * @return boolean + * @return bool */ final public function freeCache() {} @@ -1692,7 +1692,7 @@ final class layerObj * Returns the :ref:`expression ` for this layer or NULL * on error. * - * @return string + * @return string|null */ final public function getFilterString() {} @@ -1806,7 +1806,7 @@ final class layerObj * Returns MS_TRUE/MS_FALSE depending on whether the layer is * currently visible in the map (i.e. turned on, in scale, etc.). * - * @return boolean + * @return bool */ final public function isVisible() {} @@ -1955,7 +1955,7 @@ final class layerObj * available. * * @param int $index - * @return classObj + * @return classObj|null */ final public function removeClass($index) {} @@ -2504,7 +2504,7 @@ final class mapObj /** * Render map and return an image object or NULL on error. * - * @return imageObj + * @return imageObj|null */ final public function draw() {} @@ -2526,7 +2526,7 @@ final class mapObj /** * Render a query map and return an image object or NULL on error. * - * @return imageObj + * @return imageObj|null */ final public function drawQuery() {} @@ -2728,7 +2728,7 @@ final class mapObj * MS_SUCCESS/MS_FAILURE. * * @param string $filename - * @param boolean $unique_layer_name + * @param bool $unique_layer_name * @return int */ final public function loadMapContext($filename, $unique_layer_name) {} @@ -2825,7 +2825,7 @@ final class mapObj * .. _processtemplate: * * @param array $params - * @param boolean $generateimages + * @param bool $generateimages * @return string */ final public function processQueryTemplate(array $params, $generateimages) {} @@ -2849,7 +2849,7 @@ final class mapObj * $map->processtemplate($tmparray, MS_FALSE); * * @param array $params - * @param boolean $generateimages + * @param bool $generateimages * @return string */ final public function processTemplate(array $params, $generateimages) {} @@ -3111,7 +3111,7 @@ final class mapObj * set at MS_FALSE. * * @param string $proj_params - * @param boolean $bSetUnitsAndExtents + * @param bool $bSetUnitsAndExtents * @return int */ final public function setProjection($proj_params, $bSetUnitsAndExtents) {} @@ -3156,7 +3156,7 @@ final class mapObj * setWKTProjection requires GDAL support * * @param string $proj_params - * @param boolean $bSetUnitsAndExtents + * @param bool $bSetUnitsAndExtents * @return int */ final public function setWKTProjection($proj_params, $bSetUnitsAndExtents) {} @@ -4215,7 +4215,7 @@ final class shapeObj * Returns MS_TRUE if the point is inside the shape, MS_FALSE otherwise. * * @param pointObj $point - * @return boolean + * @return bool */ final public function contains(pointObj $point) {} @@ -4346,7 +4346,7 @@ final class shapeObj * Returns MS_TRUE if the two shapes intersect, MS_FALSE otherwise. * * @param shapeObj $shape - * @return boolean + * @return bool */ final public function intersects(shapeObj $shape) {} @@ -4402,7 +4402,7 @@ final class shapeObj * (>=3.0). * * @param double $tolerance - * @return shapeObj + * @return shapeObj|null */ final public function simplify($tolerance) {} @@ -4422,7 +4422,7 @@ final class shapeObj * (>=3.0). * * @param double $tolerance - * @return shapeObj + * @return shapeObj|null */ final public function topologyPreservingSimplify($tolerance) {} diff --git a/mcrypt/mcrypt.php b/mcrypt/mcrypt.php index 5f091f93..1e19f00b 100644 --- a/mcrypt/mcrypt.php +++ b/mcrypt/mcrypt.php @@ -96,7 +96,7 @@ function mcrypt_get_block_size ($cipher, $mode) {} * One of the MCRYPT_ciphername constants or the name * of the algorithm as string. *

    - * @return string This function returns the name of the cipher or false, if the cipher does + * @return string|false This function returns the name of the cipher or false, if the cipher does * not exist. * @since 4.0 * @since 5.0 @@ -128,7 +128,7 @@ function mcrypt_get_cipher_name ($cipher) {} * number generator; it is not seeded automatically like * rand is. *

    - * @return string the initialization vector, or false on error. + * @return string|false the initialization vector, or false on error. * @since 4.0 * @since 5.0 * @deprecated 7.1 @@ -179,7 +179,7 @@ function mcrypt_list_modes ($lib_dir = null) {} * have the same IV (think: starting point) both at encryption and * decryption stages, otherwise your encryption will fail. *

    - * @return int the size of the Initialisation Vector (IV) in bytes. On error the + * @return int|false the size of the Initialisation Vector (IV) in bytes. On error the * function returns false. If the IV is ignored in the specified cipher/mode * combination zero is returned. * @since 4.0.2 @@ -288,7 +288,7 @@ function mcrypt_decrypt ($cipher, $key, $data, $mode, $iv = null) {} *

    * @param string $mode_directory

    *

    - * @return resource Normally it returns an encryption descriptor, or false on error. + * @return resource|false Normally it returns an encryption descriptor, or false on error. * @since 4.0.2 * @since 5.0 * @deprecated 7.1 @@ -315,7 +315,7 @@ function mcrypt_module_open ($algorithm, $algorithm_directory, $mode, $mode_dire * encryption/decryption. If you do not want to use it you should set it * to zeros, but this is not recommended. *

    - * @return int The function returns a negative value on error, -3 when the key length + * @return int|false The function returns a negative value on error, -3 when the key length * was incorrect, -4 when there was a memory allocation problem and any * other return value is an unknown error. If an error occurs a warning will * be displayed accordingly. false is returned if incorrect parameters @@ -396,7 +396,7 @@ function mcrypt_generic_deinit ($td) {} * @param resource $td

    * The encryption descriptor. *

    - * @return int If the self test succeeds it returns false. In case of an error, it + * @return int|false If the self test succeeds it returns false. In case of an error, it * returns true. * @since 4.0.2 * @since 5.0 diff --git a/memcache/memcache.php b/memcache/memcache.php index 547d3bdd..080129f4 100644 --- a/memcache/memcache.php +++ b/memcache/memcache.php @@ -25,7 +25,7 @@ class MemcachePool { * explicitly in this method call. *

    * @param int $timeout [optional]

    Value in seconds which will be used for connecting to the daemon. Think twice before changing the default value of 1 second - you can lose all the advantages of caching if your connection is too slow.

    - * @return boolean

    Returns TRUE on success or FALSE on failure.

    + * @return bool

    Returns TRUE on success or FALSE on failure.

    */ public function connect ($host, $port, $timeout = 1) {} @@ -125,7 +125,7 @@ class MemcachePool { * Allows the user to specify a callback function to run upon encountering an error. The callback is run before failover is attempted. * The function takes two parameters, the hostname and port of the failed server. *

    - * @return boolean

    Returns TRUE on success or FALSE on failure.

    + * @return bool

    Returns TRUE on success or FALSE on failure.

    */ public function setServerParams ($host, $port = 11211, $timeout = 1, $retry_interval = 15, $status = true, callable $failure_callback = null) {} @@ -153,7 +153,7 @@ class MemcachePool { * (PECL memcache >= 0.2.0)
    * Return version of the server * @link https://php.net/manual/en/memcache.getversion.php - * @return string|boolean Returns a string of server version number or FALSE on failure. + * @return string|false Returns a string of server version number or FALSE on failure. */ public function getVersion () {} @@ -170,7 +170,7 @@ class MemcachePool { * @param int $expire [optional]

    Expiration time of the item. * If it's equal to zero, the item will never expire. * You can also use Unix timestamp or a number of seconds starting from current time, but in the latter case the number of seconds may not exceed 2592000 (30 days).

    - * @return boolean Returns TRUE on success or FALSE on failure. Returns FALSE if such key already exist. For the rest Memcache::add() behaves similarly to Memcache::set(). + * @return bool Returns TRUE on success or FALSE on failure. Returns FALSE if such key already exist. For the rest Memcache::add() behaves similarly to Memcache::set(). */ public function add ($key , $var, $flag = null, $expire = null) {} @@ -185,7 +185,7 @@ class MemcachePool { * @param mixed $var The variable to store. Strings and integers are stored as is, other types are stored serialized. * @param int $flag [optional] Use MEMCACHE_COMPRESSED to store the item compressed (uses zlib). * @param int $expire [optional] Expiration time of the item. If it's equal to zero, the item will never expire. You can also use Unix timestamp or a number of seconds starting from current time, but in the latter case the number of seconds may not exceed 2592000 (30 days). - * @return boolean Returns TRUE on success or FALSE on failure. + * @return bool Returns TRUE on success or FALSE on failure. */ public function set ($key, $var, $flag = null, $expire = null) {} @@ -197,7 +197,7 @@ class MemcachePool { * @param mixed $var

    The variable to store. Strings and integers are stored as is, other types are stored serialized.

    * @param int $flag [optional]

    Use MEMCACHE_COMPRESSED to store the item compressed (uses zlib).

    * @param int $expire [optional]

    Expiration time of the item. If it's equal to zero, the item will never expire. You can also use Unix timestamp or a number of seconds starting from current time, but in the latter case the number of seconds may not exceed 2592000 (30 days).

    - * @return boolean Returns TRUE on success or FALSE on failure. + * @return bool Returns TRUE on success or FALSE on failure. */ public function replace ($key, $var, $flag = null, $expire = null) {} @@ -223,7 +223,7 @@ class MemcachePool { * The lowest byte of the int is reserved for pecl/memcache internal usage (e.g. to indicate * compression and serialization status). *

    - * @return string|array

    + * @return string|array|false

    * Returns the string associated with the key or * an array of found key-value pairs when key is an {@link https://php.net/manual/en/language.types.array.php array}. * Returns FALSE on failure, key is not found or @@ -238,7 +238,7 @@ class MemcachePool { * https://secure.php.net/manual/ru/memcache.delete.php * @param $key string The key associated with the item to delete. * @param $timeout int [optional] This deprecated parameter is not supported, and defaults to 0 seconds. Do not use this parameter. - * @return boolean Returns TRUE on success or FALSE on failure. + * @return bool Returns TRUE on success or FALSE on failure. */ public function delete ($key, $timeout = 0 ) {} @@ -259,7 +259,7 @@ class MemcachePool { * @param int $limit [optional]

    * Used in conjunction with type set to cachedump to limit the number of entries to dump. *

    - * @return array|bool Returns an associative array of server statistics or FALSE on failure. + * @return array|false Returns an associative array of server statistics or FALSE on failure. */ public function getStats ($type = null, $slabid = null, $limit = 100) {} @@ -275,7 +275,7 @@ class MemcachePool { * debugging purposes. *

    * @param int $limit Used in conjunction with type set to cachedump to limit the number of entries to dump. - * @return array|bool Returns a two-dimensional associative array of server statistics or FALSE + * @return array|false Returns a two-dimensional associative array of server statistics or FALSE * Returns a two-dimensional associative array of server statistics or FALSE * on failure. */ @@ -287,7 +287,7 @@ class MemcachePool { * @link https://php.net/manual/en/memcache.setcompressthreshold.php * @param int $thresold

    Controls the minimum value length before attempting to compress automatically.

    * @param float $min_saving [optional]

    Specifies the minimum amount of savings to actually store the value compressed. The supplied value must be between 0 and 1. Default value is 0.2 giving a minimum 20% compression savings.

    - * @return boolean Returns TRUE on success or FALSE on failure. + * @return bool Returns TRUE on success or FALSE on failure. */ public function setCompressThreshold ($thresold, $min_saving = 0.2) {} /** @@ -296,7 +296,7 @@ class MemcachePool { * @link https://php.net/manual/en/memcache.increment.php * @param $key string Key of the item to increment. * @param $value int [optional] increment the item by value - * @return int|boolean Returns new items value on success or FALSE on failure. + * @return int|false Returns new items value on success or FALSE on failure. */ public function increment ($key, $value = 1) {} @@ -306,7 +306,7 @@ class MemcachePool { * @link https://php.net/manual/en/memcache.decrement.php * @param $key string Key of the item do decrement. * @param $value int Decrement the item by value. - * @return int|boolean Returns item's new value on success or FALSE on failure. + * @return int|false Returns item's new value on success or FALSE on failure. */ public function decrement ($key, $value = 1) {} @@ -314,7 +314,7 @@ class MemcachePool { * (PECL memcache >= 0.4.0)
    * Close memcached server connection * @link https://php.net/manual/en/memcache.close.php - * @return boolean Returns TRUE on success or FALSE on failure. + * @return bool Returns TRUE on success or FALSE on failure. */ public function close () {} @@ -322,7 +322,7 @@ class MemcachePool { * (PECL memcache >= 1.0.0)
    * Flush all existing items at the server * @link https://php.net/manual/en/memcache.flush.php - * @return boolean Returns TRUE on success or FALSE on failure. + * @return bool Returns TRUE on success or FALSE on failure. */ public function flush () {} diff --git a/memcached/memcached.php b/memcached/memcached.php index bd04c294..f734bcbe 100644 --- a/memcached/memcached.php +++ b/memcached/memcached.php @@ -585,7 +585,7 @@ class Memcached { * @param int $flags [optional]

    * The flags for the get operation. *

    - * @return array the array of found items or FALSE on failure. + * @return array|false the array of found items or FALSE on failure. * Use Memcached::getResultCode if necessary. */ public function getMultiByKey ($server_key, array $keys, $flags = 0) {} @@ -633,7 +633,7 @@ class Memcached { * (PECL memcached >= 0.1.0)
    * Fetch the next result * @link https://php.net/manual/en/memcached.fetch.php - * @return array the next result or FALSE otherwise. + * @return array|false the next result or FALSE otherwise. * The Memcached::getResultCode will return * Memcached::RES_END if result set is exhausted. */ @@ -643,7 +643,7 @@ class Memcached { * (PECL memcached >= 0.1.0)
    * Fetch all the remaining results * @link https://php.net/manual/en/memcached.fetchall.php - * @return array the results or FALSE on failure. + * @return array|false the results or FALSE on failure. * Use Memcached::getResultCode if necessary. */ public function fetchAll () {} @@ -1040,7 +1040,7 @@ class Memcached { * @param int $expiry [optional]

    * The expiry time to set on the item. *

    - * @return int new item's value on success or FALSE on failure. + * @return int|false new item's value on success or FALSE on failure. */ public function increment ($key, $offset = 1, $initial_value = 0, $expiry = 0) {} @@ -1060,7 +1060,7 @@ class Memcached { * @param int $expiry [optional]

    * The expiry time to set on the item. *

    - * @return int item's new value on success or FALSE on failure. + * @return int|false item's new value on success or FALSE on failure. */ public function decrement ($key, $offset = 1, $initial_value = 0, $expiry = 0) {} @@ -1083,7 +1083,7 @@ class Memcached { * @param int $expiry [optional]

    * The expiry time to set on the item. *

    - * @return int new item's value on success or FALSE on failure. + * @return int|false new item's value on success or FALSE on failure. */ public function incrementByKey ($server_key, $key, $offset = 1, $initial_value = 0, $expiry = 0) {} @@ -1106,7 +1106,7 @@ class Memcached { * @param int $expiry [optional]

    * The expiry time to set on the item. *

    - * @return int item's new value on success or FALSE on failure. + * @return int|false item's new value on success or FALSE on failure. */ public function decrementByKey ($server_key, $key, $offset = 1, $initial_value = 0, $expiry = 0) {} @@ -1202,7 +1202,7 @@ class Memcached { * (PECL memcached >= 2.0.0)
    * Gets the keys stored on all the servers * @link https://php.net/manual/en/memcached.getallkeys.php - * @return array the keys stored on all the servers on success or FALSE on failure. + * @return array|false the keys stored on all the servers on success or FALSE on failure. */ public function getAllKeys () {} diff --git a/mongo/mongo.php b/mongo/mongo.php index ca390068..802bfdd4 100644 --- a/mongo/mongo.php +++ b/mongo/mongo.php @@ -108,12 +108,12 @@ class MongoClient * This method does not need to be called, except in unusual circumstances. * The driver will cleanly close the database connection when the Mongo object goes out of scope. * @link https://secure.php.net/manual/en/mongoclient.close.php - * @param boolean|string $connection [optional]

    + * @param bool|string $connection [optional]

    * If connection is not given, or FALSE then connection that would be selected for writes would be closed. In a single-node configuration, that is then the whole connection, but if you are connected to a replica set, close() will only close the connection to the primary server. * If connection is TRUE then all connections as known by the connection manager will be closed. This can include connections that are not referenced in the connection string used to create the object that you are calling close on. * If connection is a string argument, then it will only close the connection identified by this hash. Hashes are identifiers for a connection and can be obtained by calling {@see MongoClient::getConnections()}. *

    - * @return boolean If the connection was successfully closed. + * @return bool If the connection was successfully closed. */ public function close($connection) {} /** @@ -122,7 +122,7 @@ class MongoClient * @link https://secure.php.net/manual/en/mongoclient.connect.php * * @throws MongoConnectionException - * @return boolean If the connection was successful. + * @return bool If the connection was successful. */ public function connect() {} @@ -300,7 +300,7 @@ class Mongo extends MongoClient { * @deprecated Pass a string of the form "mongodb://server1,server2" to the constructor instead of using this method. * @link https://secure.php.net/manual/en/mongo.pairconnect.php * @throws MongoConnectionException - * @return boolean + * @return bool */ public function pairConnect() {} @@ -355,7 +355,7 @@ class Mongo extends MongoClient { * @param string $username A username used to identify the connection. * @param string $password A password used to identify the connection. * @throws MongoConnectionException - * @return boolean If the connection was successful. + * @return bool If the connection was successful. */ public function persistConnect($username = "", $password = "") {} @@ -366,7 +366,7 @@ class Mongo extends MongoClient { * @param string $username A username used to identify the connection. * @param string $password A password used to identify the connection. * @throws MongoConnectionException - * @return boolean If the connection was successful. + * @return bool If the connection was successful. */ public function pairPersistConnect($username = "", $password = "") {} @@ -375,7 +375,7 @@ class Mongo extends MongoClient { * * @link https://secure.php.net/manual/en/mongo.connectutil.php * @throws MongoConnectionException - * @return boolean If the connection was successful. + * @return bool If the connection was successful. */ protected function connectUtil() {} @@ -407,7 +407,7 @@ class Mongo extends MongoClient { * Creates a database error on the database. * @deprecated Use MongoDB::forceError() instead. * @link https://secure.php.net/manual/en/mongo.forceerror.php - * @return boolean The database response. + * @return bool The database response. */ public function forceError() {} } @@ -747,7 +747,7 @@ class MongoDB { * (PECL mongo >= 0.9.5)
    * Creates a database error * @link https://secure.php.net/manual/en/mongodb.forceerror.php - * @return boolean Returns the database response. + * @return bool Returns the database response. */ public function forceError() {} @@ -788,7 +788,7 @@ class MongoDB { * @link https://secure.php.net/manual/en/mongodb.setreadpreference.php * @param string $read_preference

    The read preference mode: MongoClient::RP_PRIMARY, MongoClient::RP_PRIMARY_PREFERRED, MongoClient::RP_SECONDARY, MongoClient::RP_SECONDARY_PREFERRED, or MongoClient::RP_NEAREST.

    * @param array $tags [optional]

    An array of zero or more tag sets, where each tag set is itself an array of criteria used to match tags on replica set members.

    - * @return boolean Returns TRUE on success, or FALSE otherwise. + * @return bool Returns TRUE on success, or FALSE otherwise. */ public function setReadPreference ($read_preference, array $tags) {} @@ -798,7 +798,7 @@ class MongoDB { * Set the write concern for this database * @param mixed $w

    The write concern. This may be an integer denoting the number of servers required to acknowledge the write, or a string mode (e.g. "majority").

    * @param int $wtimeout[optional]

    The maximum number of milliseconds to wait for the server to satisfy the write concern.

    - * @return boolean Returns TRUE on success, or FALSE otherwise. + * @return bool Returns TRUE on success, or FALSE otherwise. */ public function setWriteConcern($w, $wtimeout) {} } @@ -1030,7 +1030,7 @@ class MongoCollection { * @param array $a An array of arrays. * @param array $options Options for the inserts. * @throws MongoCursorException - * @return mixed f "safe" is set, returns an associative array with the status of the inserts ("ok") and any error that may have occured ("err"). Otherwise, returns TRUE if the batch insert was successfully sent, FALSE otherwise. + * @return mixed if "safe" is set, returns an associative array with the status of the inserts ("ok") and any error that may have occured ("err"). Otherwise, returns TRUE if the batch insert was successfully sent, FALSE otherwise. */ public function batchInsert(array $a, array $options = array()) {} @@ -1061,7 +1061,7 @@ class MongoCollection { * "timeout" Integer, defaults to MongoCursor::$timeout. If "safe" is set, this sets how long (in milliseconds) for the client to wait for a database response. If the database does * not respond within the timeout period, a MongoCursorTimeoutException will be thrown * @throws MongoCursorException - * @return boolean + * @return bool */ public function update(array $criteria , array $newobj, array $options = array()) {} @@ -1122,7 +1122,7 @@ class MongoCollection { * @link https://secure.php.net/manual/ru/mongocollection.distinct.php * @param string $key The key to use. * @param array $query An optional query parameters - * @return array|bool Returns an array of distinct values, or FALSE on failure + * @return array|false Returns an array of distinct values, or FALSE on failure */ public function distinct ($key, array $query = NULL) {} @@ -1162,7 +1162,7 @@ class MongoCollection { * @link https://secure.php.net/manual/en/mongocollection.ensureindex.php * @param array $keys Field or fields to use as index. * @param array $options [optional] This parameter is an associative array of the form array("optionname" => , ...). - * @return boolean always true + * @return bool always true */ public function ensureIndex(array $keys, array $options = array()) {} @@ -1216,7 +1216,7 @@ class MongoCollection { * @throws MongoException if the inserted document is empty or if it contains zero-length keys. Attempting to insert an object with protected and private properties will cause a zero-length key error. * @throws MongoCursorException if the "w" option is set and the write fails. * @throws MongoCursorTimeoutException if the "w" option is set to a value greater than one and the operation takes longer than MongoCursor::$timeout milliseconds to complete. This does not kill the operation on the server, it is a client-side timeout. The operation in MongoCollection::$wtimeout is milliseconds. - * @return array|boolean If w was set, returns an array containing the status of the save. + * @return array|bool If w was set, returns an array containing the status of the save. * Otherwise, returns a boolean representing if the array was not empty (an empty array will not be inserted). */ public function save($a, array $options = array()) {} @@ -1375,7 +1375,7 @@ class MongoCursor implements Iterator { * Sets whether this query can be done on a slave * This method will override the static class variable slaveOkay. * @link https://secure.php.net/manual/en/mongocursor.slaveOkay.php - * @param boolean $okay If it is okay to query the slave. + * @param bool $okay If it is okay to query the slave. * @throws MongoCursorException * @return MongoCursor Returns this cursor */ @@ -1410,7 +1410,7 @@ class MongoCursor implements Iterator { /** * Checks if there are documents that have not been sent yet from the database for this cursor * @link https://secure.php.net/manual/en/mongocursor.dead.php - * @return boolean Returns if there are more results that have not been sent to the client, yet. + * @return bool Returns if there are more results that have not been sent to the client, yet. */ public function dead() {} @@ -1493,7 +1493,7 @@ class MongoCursor implements Iterator { /** * Checks if the cursor is reading a valid result. * @link https://secure.php.net/manual/en/mongocursor.valid.php - * @return boolean If the current result is not null. + * @return bool If the current result is not null. */ public function valid() {} @@ -1606,7 +1606,7 @@ class MongoCommandCursor implements MongoCursorInterface { /** * Checks if current position is valid * @link https://php.net/manual/en/iterator.valid.php - * @return boolean The return value will be casted to boolean and then evaluated. + * @return bool The return value will be casted to boolean and then evaluated. * Returns true on success or false on failure. * @since 5.0.0 */ @@ -1737,7 +1737,7 @@ class MongoGridFS extends MongoCollection { * @param array $criteria Description of records to remove. * @param array $options Options for remove. Valid options are: "safe"- Check that the remove succeeded. * @throws MongoCursorException - * @return boolean + * @return bool */ public function remove(array $criteria = array(), array $options = array()) {} @@ -1745,7 +1745,7 @@ class MongoGridFS extends MongoCollection { * Delete a file from the database * @link https://php.net/manual/en/mongogridfs.delete.php * @param mixed $id _id of the file to remove - * @return boolean Returns true if the remove was successfully sent to the database. + * @return bool Returns true if the remove was successfully sent to the database. */ public function delete($id) {} @@ -2163,7 +2163,7 @@ class MongoDBRef { * @link https://php.net/manual/en/mongodbref.isref.php * @static * @param mixed $ref Array or object to check - * @return boolean Returns true if $ref is a reference + * @return bool Returns true if $ref is a reference */ public static function isRef($ref) {} @@ -2537,7 +2537,7 @@ class MongoLog { * *

    The log message itself.

    *
      - * @return boolean Returns TRUE on success or FALSE on failure. + * @return bool Returns TRUE on success or FALSE on failure. */ public static function setCallback ( callable $log_function ) {} @@ -2624,7 +2624,7 @@ class MongoPool { * @param int $size The max number of connections future pools will be able to * create. Negative numbers mean that the pool will spawn an infinite number of * connections - * @return boolean Returns the former value of pool size + * @return bool Returns the former value of pool size */ public static function setSize($size) {} diff --git a/mongodb/mongodb.php b/mongodb/mongodb.php index 8d7a3ed6..c1cd9a94 100644 --- a/mongodb/mongodb.php +++ b/mongodb/mongodb.php @@ -407,7 +407,7 @@ namespace MongoDB {} * Checks if this server is an arbiter member of a replica set * @link https://php.net/manual/en/mongodb-driver-server.isarbiter.php * @throws InvalidArgumentException on argument parsing errors. - * @return boolean + * @return bool */ final public function isArbiter() { @@ -417,7 +417,7 @@ namespace MongoDB {} * Checks if this server is a hidden member of a replica set * @link https://php.net/manual/en/mongodb-driver-server.ishidden.php * @throws InvalidArgumentException on argument parsing errors. - * @return boolean + * @return bool */ final public function isHidden() { @@ -427,7 +427,7 @@ namespace MongoDB {} * Checks if this server is a passive member of a replica set * @link https://php.net/manual/en/mongodb-driver-server.ispassive.php * @throws InvalidArgumentException on argument parsing errors. - * @return boolean + * @return bool */ final public function isPassive() { @@ -437,7 +437,7 @@ namespace MongoDB {} * Checks if this server is a primary member of a replica set * @link https://php.net/manual/en/mongodb-driver-server.isprimary.php * @throws InvalidArgumentException on argument parsing errors. - * @return boolean + * @return bool */ final public function isPrimary() { @@ -447,7 +447,7 @@ namespace MongoDB {} * Checks if this server is a secondary member of a replica set * @link https://php.net/manual/en/mongodb-driver-server.issecondary.php * @throws InvalidArgumentException on argument parsing errors. - * @return boolean + * @return bool */ final public function isSecondary() { @@ -589,7 +589,7 @@ namespace MongoDB {} /** * Checks if this is the default read concern * @link https://secure.php.net/manual/en/mongodb-driver-readconcern.isdefault.php - * @return boolean + * @return bool * @since 1.3.0 * @throws \MongoDB\Driver\Exception\InvalidArgumentException On argument parsing errors. */ @@ -636,7 +636,7 @@ namespace MongoDB {} /** * Checks if a cursor is still alive * @link https://php.net/manual/en/mongodb-driver-cursor.isdead.php - * @return boolean + * @return bool * @throws InvalidArgumentException On argument parsing errors */ final public function isDead() @@ -779,7 +779,7 @@ namespace MongoDB {} * @link https://php.net/manual/en/mongodb-driver-writeconcern.construct.php * @param string|integer $w * @param integer $wtimeout How long to wait (in milliseconds) for secondaries before failing. - * @param boolean $journal Wait until mongod has applied the write to the journal. + * @param bool $journal Wait until mongod has applied the write to the journal. * @throws InvalidArgumentException on argument parsing errors. */ final public function __construct($w, $wtimeout = 0, $journal = false) @@ -904,7 +904,7 @@ namespace MongoDB {} /** * Returns whether the write was acknowledged * @link https://php.net/manual/en/mongodb-driver-writeresult.isacknowledged.php - * @return boolean + * @return bool */ final public function isAcknowledged() { @@ -1136,7 +1136,7 @@ namespace MongoDB {} * * @param string $errorLabel * @since 1.6.0 - * @return boolean + * @return bool */ final public function hasErrorLabel($errorLabel) { diff --git a/mssql/mssql.php b/mssql/mssql.php index f5936a6e..e60749d3 100644 --- a/mssql/mssql.php +++ b/mssql/mssql.php @@ -25,7 +25,7 @@ * always open a new link, even if mssql_connect was * called before with the same parameters. *

      - * @return resource a MS SQL link identifier on success, or false on error. + * @return resource|false a MS SQL link identifier on success, or false on error. */ function mssql_connect ($servername = null, $username = null, $password = null, $new_link = false) {} @@ -224,7 +224,7 @@ function mssql_fetch_field ($result, $field_offset = -1) {} * The result resource that is being evaluated. This result comes from a * call to mssql_query. *

      - * @return array an array that corresponds to the fetched row, or false if there + * @return array|false an array that corresponds to the fetched row, or false if there * are no more rows. */ function mssql_fetch_row ($result) {} @@ -243,7 +243,7 @@ function mssql_fetch_row ($result) {} * MSSQL_NUM, and * MSSQL_BOTH. *

      - * @return array an array that corresponds to the fetched row, or false if there + * @return array|false an array that corresponds to the fetched row, or false if there * are no more rows. */ function mssql_fetch_array ($result, $result_type = MSSQL_BOTH) {} @@ -285,7 +285,7 @@ function mssql_fetch_object ($result) {} * @param int $offset [optional]

      * The field offset, starts at 0. If omitted, the current field is used. *

      - * @return int The length of the specified field index on success or false on failure. + * @return int|false The length of the specified field index on success or false on failure. */ function mssql_field_length ($result, $offset = null) {} @@ -300,7 +300,7 @@ function mssql_field_length ($result, $offset = null) {} * @param int $offset [optional]

      * The field offset, starts at 0. If omitted, the current field is used. *

      - * @return string The name of the specified field index on success or false on failure. + * @return string|false The name of the specified field index on success or false on failure. */ function mssql_field_name ($result, $offset = -1) {} @@ -315,7 +315,7 @@ function mssql_field_name ($result, $offset = -1) {} * @param int $offset [optional]

      * The field offset, starts at 0. If omitted, the current field is used. *

      - * @return string The type of the specified field index on success or false on failure. + * @return string|false The type of the specified field index on success or false on failure. */ function mssql_field_type ($result, $offset = -1) {} diff --git a/mysql/mysql.php b/mysql/mysql.php index 0a74eece..7323d122 100644 --- a/mysql/mysql.php +++ b/mysql/mysql.php @@ -48,7 +48,7 @@ * Read the section about for further information. * In &sqlsafemode;, this parameter is ignored. *

      - * @return resource a MySQL link identifier on success or false on failure. + * @return resource|false a MySQL link identifier on success or false on failure. * @since 4.0 * @since 5.0 */ @@ -84,7 +84,7 @@ function mysql_connect ($server = 'ini_get("mysql.default_host")', $username = ' * MYSQL_CLIENT_IGNORE_SPACE or * MYSQL_CLIENT_INTERACTIVE. *

      - * @return resource a MySQL persistent link identifier on success, or false on + * @return resource|false a MySQL persistent link identifier on success, or false on * failure. * @since 4.0 * @since 5.0 @@ -128,7 +128,7 @@ function mysql_select_db ($database_name, $link_identifier = null) {} * Data inside the query should be properly escaped. *

      * @param resource $link_identifier [optional] - * @return resource For SELECT, SHOW, DESCRIBE, EXPLAIN and other statements returning resultset, + * @return resource|false For SELECT, SHOW, DESCRIBE, EXPLAIN and other statements returning resultset, * mysql_query * returns a resource on success, or false on * error. @@ -211,7 +211,7 @@ function mysql_db_query ($database, $query, $link_identifier = null) {} * List databases available on a MySQL server * @link https://php.net/manual/en/function.mysql-list-dbs.php * @param resource $link_identifier [optional] - * @return resource a result pointer resource on success, or false on + * @return resource|false a result pointer resource on success, or false on * failure. Use the mysql_tablename function to traverse * this result pointer, or any function for result tables, such as * mysql_fetch_array. @@ -228,7 +228,7 @@ function mysql_list_dbs ($link_identifier = null) {} * The name of the database *

      * @param resource $link_identifier [optional] - * @return resource A result pointer resource on success or false on failure. + * @return resource|false A result pointer resource on success or false on failure. *

      *

      * Use the mysql_tablename function to @@ -251,7 +251,7 @@ function mysql_list_tables ($database, $link_identifier = null) {} * The name of the table that's being queried. *

      * @param resource $link_identifier [optional] - * @return resource A result pointer resource on success, or false on + * @return resource|false A result pointer resource on success, or false on * failure. *

      *

      @@ -269,7 +269,7 @@ function mysql_list_fields ($database_name, $table_name, $link_identifier = null * List MySQL processes * @link https://php.net/manual/en/function.mysql-list-processes.php * @param resource $link_identifier [optional] - * @return resource A result pointer resource on success or false on failure. + * @return resource|false A result pointer resource on success or false on failure. * @since 4.3.0 * @since 5.0 */ @@ -371,7 +371,7 @@ function mysql_result ($result, $row, $field = 0) {} * Get number of rows in result * @link https://php.net/manual/en/function.mysql-num-rows.php * @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 the result set on success or FALSE on failure.

      + * @return int|false

      The number of rows in the result set on success or FALSE on failure.

      * @since 4.0 * @since 5.0 * @deprecated 5.5 @@ -419,7 +419,7 @@ function mysql_fetch_row ($result) {} * MYSQL_NUM, and * MYSQL_BOTH. *

      - * @return array an array of strings that corresponds to the fetched row, or false + * @return array|false an array of strings that corresponds to the fetched row, or false * if there are no more rows. The type of returned array depends on * how result_type is defined. By using * MYSQL_BOTH (default), you'll get an array with both @@ -505,7 +505,7 @@ function mysql_data_seek ($result, $row_number) {} * Get the length of each output in a result * @link https://php.net/manual/en/function.mysql-fetch-lengths.php * @param resource $result - * @return array An array of lengths on success or false on failure. + * @return array|false An array of lengths on success or false on failure. * @since 4.0 * @since 5.0 */ @@ -578,7 +578,7 @@ function mysql_free_result ($result) {} * @link https://php.net/manual/en/function.mysql-field-name.php * @param resource $result * @param int $field_offset - * @return string The name of the specified field index on success or false on failure. + * @return string|false The name of the specified field index on success or false on failure. * @since 4.0 * @since 5.0 */ @@ -602,7 +602,7 @@ function mysql_field_table ($result, $field_offset) {} * @link https://php.net/manual/en/function.mysql-field-len.php * @param resource $result * @param int $field_offset - * @return int The length of the specified field index on success or false on failure. + * @return int|false The length of the specified field index on success or false on failure. * @since 4.0 * @since 5.0 */ @@ -630,7 +630,7 @@ function mysql_field_type ($result, $field_offset) {} * @link https://php.net/manual/en/function.mysql-field-flags.php * @param resource $result * @param int $field_offset - * @return string a string of flags associated with the result or false on failure. + * @return string|false a string of flags associated with the result or false on failure. *

      *

      * The following flags are reported, if your version of MySQL @@ -666,7 +666,7 @@ function mysql_escape_string ($unescaped_string) {} * The string that is to be escaped. *

      * @param resource $link_identifier [optional] - * @return string the escaped string, or false on error. + * @return string|false the escaped string, or false on error. * @since 4.3.0 * @since 5.0 */ @@ -691,7 +691,7 @@ function mysql_stat ($link_identifier = null) {} * Return the current thread ID * @link https://php.net/manual/en/function.mysql-thread-id.php * @param resource $link_identifier [optional] - * @return int The thread ID on success or false on failure. + * @return int|false The thread ID on success or false on failure. * @since 4.3.0 * @since 5.0 */ @@ -747,7 +747,7 @@ function mysql_get_host_info ($link_identifier = null) {} * Get MySQL protocol info * @link https://php.net/manual/en/function.mysql-get-proto-info.php * @param resource $link_identifier [optional] - * @return int the MySQL protocol on success or false on failure. + * @return int|false the MySQL protocol on success or false on failure. * @since 4.0.5 * @since 5.0 */ @@ -758,7 +758,7 @@ function mysql_get_proto_info ($link_identifier = null) {} * Get MySQL server info * @link https://php.net/manual/en/function.mysql-get-server-info.php * @param resource $link_identifier [optional] - * @return string the MySQL server version on success or false on failure. + * @return string|false the MySQL server version on success or false on failure. * @since 4.0.5 * @since 5.0 */ @@ -769,7 +769,7 @@ function mysql_get_server_info ($link_identifier = null) {} * Get information about the most recent query * @link https://php.net/manual/en/function.mysql-info.php * @param resource $link_identifier [optional] - * @return string information about the statement on success, or false on + * @return string|false information about the statement on success, or false on * failure. 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. @@ -858,7 +858,7 @@ function mysql_numfields ($result) {} * Alias of mysql_num_rows() * @link https://php.net/manual/en/function.mysql-num-rows.php * @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 the result set on success or FALSE on failure.

      + * @return int|false

      The number of rows in the result set on success or FALSE on failure.

      * @deprecated 5.5 Use mysql_num_rows instead. */ function mysql_numrows ($result) {} @@ -897,7 +897,7 @@ function mysql_listfields ($database_name, $table_name, $link_identifier) {} * @param mixed $field [optional]

      * The field name. *

      - * @return string the database name on success, and false on failure. If false + * @return string|false the database name on success, and false on failure. If false * is returned, use mysql_error to determine the nature * of the error. * @since 4.0 @@ -924,7 +924,7 @@ function mysql_dbname ($result, $row, $field) {} * @param int $i

      * The integer index (row/table number) *

      - * @return string The name of the table on success or false on failure. + * @return string|false The name of the table on success or false on failure. *

      *

      * Use the mysql_tablename function to diff --git a/mysqli/mysqli.php b/mysqli/mysqli.php index 0d858b54..d118d506 100644 --- a/mysqli/mysqli.php +++ b/mysqli/mysqli.php @@ -456,7 +456,7 @@ class mysqli { * only in Data Manipulation Language (DML) statements, and not in Data * Definition Language (DDL) statements. *

      - * @return mysqli_stmt mysqli_prepare returns a statement object or false if an error occurred. + * @return mysqli_stmt|false mysqli_prepare returns a statement object or false if an error occurred. * @since 5.0 */ public function prepare ($query) {} @@ -486,9 +486,9 @@ class mysqli { * mysqli_poll is then used to get results from such * queries. *

      - * @return mysqli_result|boolean For successful SELECT, SHOW, DESCRIBE or + * @return mysqli_result|bool For successful SELECT, SHOW, DESCRIBE or * EXPLAIN queries mysqli_query will return - * a mysqli_result object.For other successful queries mysqli_query will + * a mysqli_result object. For other successful queries mysqli_query will * return true and false on failure. * @since 5.0 */ @@ -723,7 +723,7 @@ class mysqli { /** * Gets the current system status * @link https://php.net/manual/en/mysqli.stat.php - * @return string A string describing the server status. false if an error occurred. + * @return string|false A string describing the server status. false if an error occurred. * @since 5.0 */ public function stat () {} @@ -739,7 +739,7 @@ class mysqli { /** * Transfers a result set from the last query * @link https://php.net/manual/en/mysqli.store-result.php - * @return mysqli_result a buffered result object or false if an error occurred. + * @return mysqli_result|false a buffered result object or false if an error occurred. *

      *

      * mysqli_store_result returns false in case the query @@ -769,7 +769,7 @@ class mysqli { /** * Initiate a result set retrieval * @link https://php.net/manual/en/mysqli.use-result.php - * @return mysqli_result an unbuffered result object or false if an error occurred. + * @return mysqli_result|false an unbuffered result object or false if an error occurred. * @since 5.0 */ public function use_result () {} @@ -878,7 +878,7 @@ class mysqli_result implements Traversable { /** * Returns the next field in the result set * @link https://php.net/manual/en/mysqli-result.fetch-field.php - * @return object an object which contains field definition information or false + * @return object|false an object which contains field definition information or false * if no field information is available. *

      *

      @@ -1014,7 +1014,7 @@ class mysqli_result implements Traversable { * The field number. This value must be in the range from * 0 to number of fields - 1. *

      - * @return object an object which contains field definition information or false + * @return object|false an object which contains field definition information or false * if no field information for specified fieldnr is * available. *

      @@ -1234,7 +1234,7 @@ class mysqli_stmt { * @param int $attr

      * The attribute that you want to get. *

      - * @return int false if the attribute is not found, otherwise returns the value of the attribute. + * @return int|false false if the attribute is not found, otherwise returns the value of the attribute. * @since 5.0 */ public function attr_get ($attr) {} @@ -1392,7 +1392,7 @@ class mysqli_stmt { /** * Returns result set metadata from a prepared statement * @link https://php.net/manual/en/mysqli-stmt.result-metadata.php - * @return mysqli_result a result object or false if an error occurred. + * @return mysqli_result|false a result object or false if an error occurred. * @since 5.0 */ public function result_metadata () {} @@ -1685,7 +1685,7 @@ function mysqli_execute ($stmt) {} * @link https://secure.php.net/manual/en/mysqli-result.fetch-field.php * @param mysqli_result $result A result set identifier returned by mysqli_query(), * mysqli_store_result() or mysqli_use_result(). - * @return object|bool Returns an object which contains field definition information or FALSE if no field information is available. + * @return object|false Returns an object which contains field definition information or FALSE if no field information is available. */ function mysqli_fetch_field ($result) {} @@ -1694,7 +1694,7 @@ function mysqli_fetch_field ($result) {} * @link https://secure.php.net/manual/en/mysqli-result.fetch-fields.php * @param mysqli_result $result A result set identifier returned by mysqli_query(), * mysqli_store_result() or mysqli_use_result(). - * @return array|bool Returns an array of objects which contains field definition information or FALSE if no field information is available. + * @return array|false Returns an array of objects which contains field definition information or FALSE if no field information is available. */ function mysqli_fetch_fields ($result) {} @@ -1704,7 +1704,7 @@ function mysqli_fetch_fields ($result) {} * @param mysqli_result $result A result set identifier returned by mysqli_query(), * mysqli_store_result() or mysqli_use_result(). * @param int $fieldnr The field number. This value must be in the range from 0 to number of fields - 1. - * @return object|bool Returns an object which contains field definition information or FALSE if no field information for specified fieldnr is available. + * @return object|false Returns an object which contains field definition information or FALSE if no field information for specified fieldnr is available. */ function mysqli_fetch_field_direct ($result, $fieldnr) {} @@ -1713,7 +1713,7 @@ function mysqli_fetch_field_direct ($result, $fieldnr) {} * @link https://php.net/manual/en/mysqli-result.lengths.php * @param mysqli_result $result A result set identifier returned by mysqli_query(), * mysqli_store_result() or mysqli_use_result(). - * @return array|bool An array of integers representing the size of each column (not including any terminating null characters). FALSE if an error occurred. + * @return array|false An array of integers representing the size of each column (not including any terminating null characters). FALSE if an error occurred. */ function mysqli_fetch_lengths ($result) {} @@ -2075,7 +2075,7 @@ function mysqli_poll (array &$read = null, array &$error = null, &$reject = null * @link https://php.net/manual/en/mysqli.prepare.php * @param mysqli $link A link identifier returned by mysqli_connect() or mysqli_init() * @param string $query - * @return mysqli_stmt|bool A statement object or FALSE if an error occurred. + * @return mysqli_stmt|false A statement object or FALSE if an error occurred. */ function mysqli_prepare ($link, $query) {} @@ -2236,7 +2236,7 @@ function mysqli_stmt_affected_rows ($stmt) {} * @link https://php.net/manual/en/mysqli-stmt.attr-get.php * @param mysqli_stmt $stmt * @param int $attr - * @return int|bool Returns FALSE if the attribute is not found, otherwise returns the value of the attribute. + * @return int|false Returns FALSE if the attribute is not found, otherwise returns the value of the attribute. */ function mysqli_stmt_attr_get ($stmt, $attr) {} @@ -2279,7 +2279,7 @@ function mysqli_stmt_prepare ($stmt, $query) {} * Returns result set metadata from a prepared statement * @link https://php.net/manual/en/mysqli-stmt.result-metadata.php * @param mysqli_stmt $stmt - * @return mysqli_result|bool Returns a result object or FALSE if an error occurred + * @return mysqli_result|false Returns a result object or FALSE if an error occurred */ function mysqli_stmt_result_metadata ($stmt) {} @@ -2411,7 +2411,7 @@ function mysqli_sqlstate ($link) {} * Gets the current system status * @link https://php.net/manual/en/mysqli.stat.php * @param mysqli $link A link identifier returned by mysqli_connect() or mysqli_init() - * @return string|bool A string describing the server status. FALSE if an error occurred. + * @return string|false A string describing the server status. FALSE if an error occurred. */ function mysqli_stat ($link) {} @@ -2615,7 +2615,7 @@ function mysqli_param_count ($stmt) {} * Alias for mysqli_stmt_result_metadata * @link https://php.net/manual/en/function.mysqli-get-metadata.php * @param mysqli_stmt $stmt - * @return mysqli_result|bool Returns a result object or FALSE if an error occurred + * @return mysqli_result|false Returns a result object or FALSE if an error occurred * @deprecated 5.3 This function has been DEPRECATED as of PHP 5.3.0 and REMOVED as of PHP 5.4.0. * @since 5.0 */ diff --git a/newrelic/newrelic.php b/newrelic/newrelic.php index 4e5033f7..85d2f953 100644 --- a/newrelic/newrelic.php +++ b/newrelic/newrelic.php @@ -17,9 +17,9 @@ * @link https://docs.newrelic.com/docs/agents/php-agent/configuration/php-agent-api#api-custom-param * * @param string $key - * @param boolean|float|integer|string $value + * @param bool|float|integer|string $value * - * @return boolean + * @return bool */ function newrelic_add_custom_parameter($key, $value) {} @@ -37,7 +37,7 @@ function newrelic_add_custom_parameter($key, $value) {} * * @param string $functionName * - * @return boolean + * @return bool */ function newrelic_add_custom_tracer($functionName) {} @@ -49,7 +49,7 @@ function newrelic_add_custom_tracer($functionName) {} * * @link https://docs.newrelic.com/docs/agents/php-agent/configuration/php-agent-api#api-bg * - * @param boolean $flag [optional] + * @param bool $flag [optional] * * @return void */ @@ -64,7 +64,7 @@ function newrelic_background_job($flag = true) {} * * @link https://docs.newrelic.com/docs/agents/php-agent/configuration/php-agent-api#api-capture-params * - * @param boolean $enable [optional] + * @param bool $enable [optional] * * @return void */ @@ -90,7 +90,7 @@ function newrelic_capture_params($enable = true) {} * @param string $metricName * @param float $value * - * @return boolean + * @return bool */ function newrelic_custom_metric($metricName, $value) {} @@ -145,9 +145,9 @@ function newrelic_end_of_transaction() {} * * @link https://docs.newrelic.com/docs/agents/php-agent/configuration/php-agent-api#api-end-txn * - * @param boolean $ignore [optional] + * @param bool $ignore [optional] * - * @return boolean + * @return bool */ function newrelic_end_transaction($ignore = false) {} @@ -229,7 +229,7 @@ function newrelic_ignore_transaction() {} * * @param string $name * - * @return boolean + * @return bool */ function newrelic_name_transaction($name) {} @@ -313,9 +313,9 @@ function newrelic_record_custom_event($name, array $attributes) {} * * @param string $name * @param string $license [optional] defaults to ini_get('newrelic.license') - * @param boolean $xmit [optional] + * @param bool $xmit [optional] * - * @return boolean + * @return bool */ function newrelic_set_appname($name, $license = null, $xmit = false) {} @@ -333,7 +333,7 @@ function newrelic_set_appname($name, $license = null, $xmit = false) {} * @param string $account * @param string $product * - * @return boolean + * @return bool */ function newrelic_set_user_attributes($user, $account, $product) {} @@ -353,7 +353,7 @@ function newrelic_set_user_attributes($user, $account, $product) {} * @param string $appName * @param string $license [optional] defaults to ini_get('newrelic.license') * - * @return boolean + * @return bool */ function newrelic_start_transaction($appName, $license = null) {} diff --git a/oauth/oauth.php b/oauth/oauth.php index 3a6b1740..6e4e834d 100644 --- a/oauth/oauth.php +++ b/oauth/oauth.php @@ -330,7 +330,7 @@ class OAuthProvider { public function isRequestTokenEndpoint($will_issue_request_token) { } /** - * @param string + * @param string $req_params * @return bool * @final */ diff --git a/oci8/oci8.php b/oci8/oci8.php index 879738cb..6595fc95 100644 --- a/oci8/oci8.php +++ b/oci8/oci8.php @@ -1707,7 +1707,7 @@ function ocicolumnisnull ($statement, $column_number_or_name) {} * @link https://php.net/manual/en/function.ocicolumnname.php * @param resource $statement * @param mixed $column_number - * @return string|bool Returns the name as a string, or FALSE on errors. + * @return string|false Returns the name as a string, or FALSE on errors. */ function ocicolumnname ($statement, $column_number) {} @@ -1717,7 +1717,7 @@ function ocicolumnname ($statement, $column_number) {} * @link https://php.net/manual/en/function.ocicolumnsize.php * @param resource $statement * @param mixed $column_number_or_name - * @return int|bool Returns the size of a field in bytes, or FALSE on errors. + * @return int|false Returns the size of a field in bytes, or FALSE on errors. */ function ocicolumnsize ($statement, $column_number_or_name) {} @@ -1727,7 +1727,7 @@ function ocicolumnsize ($statement, $column_number_or_name) {} * @link https://php.net/manual/en/function.ocicolumnscale.php * @param resource $statement_resource * @param $column_number - * @return int|bool Returns the scale as an integer, or FALSE on errors. + * @return int|false Returns the scale as an integer, or FALSE on errors. */ function ocicolumnscale ($statement_resource, $column_number) {} @@ -1737,7 +1737,7 @@ function ocicolumnscale ($statement_resource, $column_number) {} * @link https://php.net/manual/en/function.ocicolumnprecision.php * @param resource $statement_resource * @param string|int $column_number - * @return int|bool Returns the precision as an integer, or FALSE on errors. + * @return int|false Returns the precision as an integer, or FALSE on errors. */ function ocicolumnprecision ($statement_resource, $column_number) {} @@ -1747,7 +1747,7 @@ function ocicolumnprecision ($statement_resource, $column_number) {} * @link https://php.net/manual/en/function.ocicolumntype.php * @param resource $statement_resource * @param string|int $column_number - * @return mixed|bool Returns the field data type as a string, or FALSE on errors. + * @return mixed|false Returns the field data type as a string, or FALSE on errors. */ function ocicolumntype ($statement_resource, $column_number) {} @@ -1757,7 +1757,7 @@ function ocicolumntype ($statement_resource, $column_number) {} * @link https://php.net/manual/en/function.ocicolumntyperaw.php * @param resource $statement_resource * @param string|int $column_number - * @return int|bool Returns Oracle's raw data type as a number, or FALSE on errors. + * @return int|false Returns Oracle's raw data type as a number, or FALSE on errors. */ function ocicolumntyperaw ($statement_resource, $column_number) {} @@ -1793,12 +1793,12 @@ function ocifetch ($statement_resource) {} * (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)
      * Alias of {@see oci_fetch_all} * @link https://php.net/manual/en/function.ocifetchstatement.php - * @param statement_resource - * @param output + * @param $statement_resource + * @param $output * @param $skip [optional] * @param $maximum_rows [optional] * @param $flags [optional] - * @return int|bool Returns the number of rows in output, which may be 0 or more, or FALSE on failure. + * @return int|false Returns the number of rows in output, which may be 0 or more, or FALSE on failure. */ function ocifetchstatement ($statement_resource, &$output, $skip, $maximum_rows, $flags) {} @@ -1824,7 +1824,7 @@ function ociinternaldebug ($mode) {} * Alias of {@see oci_num_fields} * @link https://php.net/manual/en/function.ocinumcols.php * @param resource $statement_resource - * @return int|bool Returns the number of columns as an integer, or FALSE on errors. + * @return int|false Returns the number of columns as an integer, or FALSE on errors. */ function ocinumcols ($statement_resource) {} @@ -1834,7 +1834,7 @@ function ocinumcols ($statement_resource) {} * @link https://php.net/manual/en/function.ociparse.php * @param resource $connection_resource * @param string $sql_text - * @return resource|bool Returns a statement handle on success, or FALSE on error. + * @return resource|false Returns a statement handle on success, or FALSE on error. */ function ociparse ($connection_resource, $sql_text) {} @@ -1843,7 +1843,7 @@ function ociparse ($connection_resource, $sql_text) {} * Alias of {@see oci_new_cursor} * @link https://php.net/manual/en/function.ocinewcursor.php * @param resource $connection_resource - * @return resource|bool Returns a new statement handle, or FALSE on error. + * @return resource|false Returns a new statement handle, or FALSE on error. */ function ocinewcursor ($connection_resource) {} @@ -1853,7 +1853,7 @@ function ocinewcursor ($connection_resource) {} * @link https://php.net/manual/en/function.ociresult.php * @param resource $statement_resource * @param $column_number_or_name - * @return bool|mixed Returns everything as strings except for abstract types (ROWIDs, LOBs and FILEs). Returns FALSE on error. + * @return false|mixed Returns everything as strings except for abstract types (ROWIDs, LOBs and FILEs). Returns FALSE on error. */ function ociresult ($statement_resource, $column_number_or_name) {} @@ -1862,7 +1862,7 @@ function ociresult ($statement_resource, $column_number_or_name) {} * Alias of {@see oci_server_version} * @link https://php.net/manual/en/function.ociserverversion.php * @param $connection_resource - * @return string|bool Returns the version information as a string or FALSE on error. + * @return string|false Returns the version information as a string or FALSE on error. */ function ociserverversion ($connection_resource) {} @@ -1880,7 +1880,7 @@ function ocistatementtype ($statement_resource) {} * Alias of {@see oci_num_rows} * @link https://php.net/manual/en/function.ocirowcount.php * @param resource $statement_resource - * @return int|bool Returns the number of rows affected as an integer, or FALSE on errors. + * @return int|false Returns the number of rows affected as an integer, or FALSE on errors. */ function ocirowcount ($statement_resource) {} @@ -1902,7 +1902,7 @@ function ocilogoff ($connection_resource) {} * @param string $connection_string[optional] * @param string $character_set[optional] * @param int $session_mode[optional] - * @return resource|bool Returns a connection identifier or FALSE on error. + * @return resource|false Returns a connection identifier or FALSE on error. */ function ocilogon ($username, $password, $connection_string, $character_set, $session_mode) {} @@ -1951,7 +1951,7 @@ function ocierror ($connection_or_statement_resource) {} * {@see OCI-Lob::free} * @link https://php.net/manual/en/function.ocifreedesc.php * @param $lob_descriptor - * @return boolean

      Returns TRUE on success or FALSE on failure.

      + * @return bool

      Returns TRUE on success or FALSE on failure.

      */ function ocifreedesc ($lob_descriptor) {} @@ -1997,7 +1997,7 @@ function ociwritelobtofile ($lob_descriptor, $filename, $start, $length) {} * {@see OCI_Lob::load} * @link https://php.net/manual/en/function.ociloadlob.php * @param OCI_Lob $lob_descriptor - * @return string|bool

      Returns the contents of the object, or FALSE on errors.

      + * @return string|false

      Returns the contents of the object, or FALSE on errors.

      */ function ociloadlob ($lob_descriptor) {} @@ -2035,7 +2035,7 @@ function ocirollback ($connection_resource) {} * {@see oci_connect()} or {@see oci_pconnect()}. *

      * @param $type [optional]

      Valid values for type are: OCI_DTYPE_FILE, OCI_DTYPE_LOB and OCI_DTYPE_ROWID.

      - * @return OCI_LOB|bool Returns a new LOB or FILE descriptor on success, FALSE on error. + * @return OCI_LOB|false Returns a new LOB or FILE descriptor on success, FALSE on error. */ function ocinewdescriptor ($connection_resource, $type = OCI_DTYPE_LOB) {} @@ -2062,7 +2062,7 @@ function ocisetprefetch ($statement_resource, $number_of_rows) {} * @param string $username

      The Oracle user name.

      * @param string $old_password

      The new password to be set.

      * @param string $new_password

      The new password to be set.

      - * @return bool|resource

      Returns TRUE on success or FALSE on failure.

      + * @return resource|bool

      Returns TRUE on success or FALSE on failure or resource, depending on the function parameters.

      */ function ocipasswordchange ($connection_resource_or_connection_string_or_dbname, $username, $old_password, $new_password) {} @@ -2087,7 +2087,7 @@ function ocifreecollection ($collection) {} * @param $tdo

      Should be a valid named type (uppercase).

      * @param $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|bool

      Returns a new OCI_Collection object or FALSE on error.

      + * @return OCI_Collection|false

      Returns a new OCI_Collection object or FALSE on error.

      */ function ocinewcollection ($connection_resource, $tdo, $schema = null) {} @@ -2151,7 +2151,7 @@ function ocicollmax ($collection) {} * {@see OCI_Collection::trim} * @link https://php.net/manual/en/function.ocicolltrim.php * @param OCI_Collection $collection - * @param int|float + * @param int|float $number * @return bool Returns TRUE or FALSE on failure. */ function ocicolltrim ($collection, $number) {} diff --git a/odbc/odbc.php b/odbc/odbc.php index 85904b5f..56f68fff 100644 --- a/odbc/odbc.php +++ b/odbc/odbc.php @@ -84,7 +84,7 @@ function odbc_close_all () {} * @param string $column_name [optional]

      * The column name. *

      - * @return resource an ODBC result identifier or FALSE on failure. + * @return resource|false an ODBC result identifier or FALSE on failure. *

      *

      * The result set has the following columns: @@ -141,7 +141,7 @@ function odbc_commit ($connection_id) {} * The following constants are defined for cursortype: *

      * SQL_CUR_USE_IF_NEEDED - * @return resource an ODBC connection or (FALSE) on error. + * @return resource|false an ODBC connection or (FALSE) on error. * @since 4.0 * @since 5.0 */ @@ -170,7 +170,7 @@ function odbc_cursor ($result_id) {} * Use SQL_FETCH_FIRST the first time this function is * called, thereafter use the SQL_FETCH_NEXT. *

      - * @return array FALSE on error, and an array upon success. + * @return array|false FALSE on error, and an array upon success. * @since 4.3.0 * @since 5.0 */ @@ -267,7 +267,7 @@ function odbc_exec ($connection_id, $query_string, $flags = null) {} * @param int $rownumber [optional]

      * Optionally choose which row number to retrieve. *

      - * @return array an array that corresponds to the fetched row, or FALSE if there + * @return array|false an array that corresponds to the fetched row, or FALSE if there * are no more rows. * @since 4.0.2 * @since 5.0 @@ -283,7 +283,7 @@ function odbc_fetch_array ($result, $rownumber = null) {} * @param int $rownumber [optional]

      * Optionally choose which row number to retrieve. *

      - * @return object an object that corresponds to the fetched row, or FALSE if there + * @return object|false an object that corresponds to the fetched row, or FALSE if there * are no more rows. * @since 4.0.2 * @since 5.0 @@ -348,7 +348,7 @@ function odbc_fetch_into ($result_id, array &$result_array, $rownumber = null) { * @param int $field_number

      * The field number. Field numbering starts at 1. *

      - * @return int the field name as a string, or FALSE on error. + * @return int|false the field name as a string, or FALSE on error. * @since 4.0 * @since 5.0 */ @@ -363,7 +363,7 @@ function odbc_field_len ($result_id, $field_number) {} * @param int $field_number

      * The field number. Field numbering starts at 1. *

      - * @return int the field scale as a integer, or FALSE on error. + * @return int|false the field scale as a integer, or FALSE on error. * @since 4.0 * @since 5.0 */ @@ -378,7 +378,7 @@ function odbc_field_scale ($result_id, $field_number) {} * @param int $field_number

      * The field number. Field numbering starts at 1. *

      - * @return string the field name as a string, or FALSE on error. + * @return string|false the field name as a string, or FALSE on error. * @since 4.0 * @since 5.0 */ @@ -393,7 +393,7 @@ function odbc_field_name ($result_id, $field_number) {} * @param int $field_number

      * The field number. Field numbering starts at 1. *

      - * @return string the field type as a string, or FALSE on error. + * @return string|false the field type as a string, or FALSE on error. * @since 4.0 * @since 5.0 */ @@ -408,7 +408,7 @@ function odbc_field_type ($result_id, $field_number) {} * @param string $field_name

      * The field name. *

      - * @return int the field number as a integer, or FALSE on error. + * @return int|false the field number as a integer, or FALSE on error. * Field numbering starts at 1. * @since 4.0 * @since 5.0 @@ -525,7 +525,7 @@ function odbc_num_rows ($result_id) {} * @param string $user * @param string $password * @param int $cursor_type [optional] - * @return resource an ODBC connection id or 0 (FALSE) on + * @return resource|false an ODBC connection id or 0 (FALSE) on * error. * @since 4.0 * @since 5.0 @@ -540,7 +540,7 @@ function odbc_pconnect ($dsn, $user, $password, $cursor_type = null) {} * @param string $query_string

      * The query string statement being prepared. *

      - * @return resource an ODBC result identifier if the SQL command was prepared + * @return resource|false an ODBC result identifier if the SQL command was prepared * successfully. Returns FALSE on error. * @since 4.0 * @since 5.0 @@ -574,7 +574,7 @@ function odbc_result ($result_id, $field) {} * @param string $format [optional]

      * Additional overall table formatting. *

      - * @return int the number of rows in the result or FALSE on error. + * @return int|false the number of rows in the result or FALSE on error. * @since 4.0 * @since 5.0 */ @@ -643,7 +643,7 @@ function odbc_setoption ($id, $function, $option, $param) {} * @param int $nullable

      * The nullable option. *

      - * @return resource an ODBC result identifier or FALSE on + * @return resource|false an ODBC result identifier or FALSE on * failure. *

      *

      @@ -681,7 +681,7 @@ function odbc_specialcolumns ($connection_id, $type, $qualifier, $owner, $table, * @param int $accuracy

      * The accuracy. *

      - * @return resource an ODBC result identifier or FALSE on failure. + * @return resource|false an ODBC result identifier or FALSE on failure. *

      *

      * The result set has the following columns: @@ -751,7 +751,7 @@ function odbc_tables ($connection_id, $qualifier = null, $owner = null, $name = * @param string $qualifier * @param string $owner * @param string $table - * @return resource an ODBC result identifier or FALSE on failure. + * @return resource|false an ODBC result identifier or FALSE on failure. *

      *

      * The result set has the following columns: @@ -785,7 +785,7 @@ function odbc_primarykeys ($connection_id, $qualifier, $owner, $table) {} * patterns ('%' to match zero or more characters and '_' to match a * single character). *

      - * @return resource an ODBC result identifier or FALSE on failure. + * @return resource|false an ODBC result identifier or FALSE on failure. * This result identifier can be used to fetch a list of columns and * associated privileges. *

      @@ -823,7 +823,7 @@ function odbc_columnprivileges ($connection_id, $qualifier, $owner, $table_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 or FALSE on failure. + * @return resource|false An ODBC result identifier or FALSE on failure. *

      *

      * The result set has the following columns: @@ -862,7 +862,7 @@ function odbc_tableprivileges ($connection_id, $qualifier, $owner, $name) {} * @param string $fk_table

      * The foreign key table. *

      - * @return resource an ODBC result identifier or FALSE on failure. + * @return resource|false an ODBC result identifier or FALSE on failure. *

      *

      * The result set has the following columns: @@ -927,7 +927,7 @@ function odbc_procedures ($connection_id) {} * @link https://php.net/manual/en/function.odbc-procedurecolumns.php * @param resource $connection_id The ODBC connection identifier, * see odbc_connect for details.

      - * @return resource the list of input and output parameters, as well as the + * @return resource|false the list of input and output parameters, as well as the * columns that make up the result set for the specified procedures. * Returns an ODBC result identifier or FALSE on failure. *

      diff --git a/openssl/openssl.php b/openssl/openssl.php index d9d5235a..b6ef8f79 100644 --- a/openssl/openssl.php +++ b/openssl/openssl.php @@ -23,7 +23,7 @@ function openssl_pkey_free($key) { } * openssl_csr_new for more information about * configargs. *

      - * @return resource a resource identifier for the pkey on success, or false on + * @return resource|false a resource identifier for the pkey on success, or false on * error. * @since 4.2.0 * @since 5.0 @@ -90,7 +90,7 @@ function openssl_pkey_export_to_file($key, $outfilename, $passphrase = null, arr * The optional parameter passphrase must be used * if the specified key is encrypted (protected by a passphrase). *

      - * @return resource|bool Returns a positive key resource identifier on success, or FALSE on error. + * @return resource|false Returns a positive key resource identifier on success, or FALSE on error. * @since 4.2.0 * @since 5.0 */ @@ -109,7 +109,7 @@ function openssl_pkey_get_private($key, $passphrase = "") { } * *
    • A PEM formatted public key.
      • *

      - * @return resource a positive key resource identifier on success, or false on error. + * @return resource|false a positive key resource identifier on success, or false on error. * @since 4.2.0 * @since 5.0 */ @@ -121,7 +121,7 @@ function openssl_pkey_get_public($certificate) { } * @param resource $key

      * Resource holding the key. *

      - * @return array an array with the key details in success or false in failure. + * @return array|false an array with the key details in success or false in failure. * Returned array has indexes bits (number of bits), * key (string representation of the public key) and * type (type of the key which is one of @@ -164,7 +164,7 @@ function openssl_free_key($key_identifier) { } * The optional parameter passphrase must be used * if the specified key is encrypted (protected by a passphrase). *

      - * @return resource|bool Returns a positive key resource identifier on success, or FALSE on error. + * @return resource|false Returns a positive key resource identifier on success, or FALSE on error. * @since 4.0.4 * @since 5.0 */ @@ -184,7 +184,7 @@ function openssl_get_privatekey($key, $passphrase) { } * *
    • A PEM formatted public key.
      • *

      - * @return resource a positive key resource identifier on success, or FALSE on error. + * @return resource|false a positive key resource identifier on success, or FALSE on error. * @since 4.0.4 * @since 5.0 */ @@ -202,7 +202,7 @@ function openssl_get_publickey($certificate) { } *

      * @param string $challenge

      The challenge associated to associate with the SPKAC

      * @param int $algorithm

      The digest algorithm. See openssl_get_md_method().

      - * @return string Returns a signed public key and challenge string or NULL on failure. + * @return string|null Returns a signed public key and challenge string or NULL on failure. * @since 5.6.0 */ function openssl_spki_new(&$privkey, &$challenge, $algorithm = 0) {} @@ -212,7 +212,7 @@ function openssl_spki_new(&$privkey, &$challenge, $algorithm = 0) {} * Verifies a signed public key and challenge * @link https://php.net/manual/en/function.openssl-spki-verify.php * @param string $spkac

      Expects a valid signed public key and challenge

      - * @return boolean Returns a boolean on success or failure. + * @return bool Returns a boolean on success or failure. * @since 5.6.0 */ function openssl_spki_verify(&$spkac) {} @@ -221,7 +221,7 @@ function openssl_spki_verify(&$spkac) {} * Exports the challenge assoicated with a signed public key and challenge * @link https://php.net/manual/en/function.openssl-spki-export-challenge.php * @param string $spkac

      Expects a valid signed public key and challenge

      - * @return string|NULL Returns the associated challenge string or NULL on failure. + * @return string|null Returns the associated challenge string or NULL on failure. * @since 5.6.0 */ function openssl_spki_export_challenge (&$spkac ) {} @@ -230,7 +230,7 @@ function openssl_spki_export_challenge (&$spkac ) {} * Exports a valid PEM formatted public key signed public key and challenge * @link https://php.net/manual/en/function.openssl-spki-export.php * @param string $spkac

      Expects a valid signed public key and challenge

      - * @return string|NULL Returns the associated PEM formatted public key or NULL on failure. + * @return string|null Returns the associated PEM formatted public key or NULL on failure. * @since 5.6.0 */ function openssl_spki_export (&$spkac ) {} @@ -241,7 +241,7 @@ function openssl_spki_export (&$spkac ) {} it * @link https://php.net/manual/en/function.openssl-x509-read.php * @param mixed $x509certdata - * @return resource a resource identifier on success or false on failure. + * @return resource|false a resource identifier on success or false on failure. */ function openssl_x509_read($x509certdata) { } @@ -249,7 +249,7 @@ function openssl_x509_read($x509certdata) { } * @param string $x509 * @param string $type [optional] hash method * @param bool $binary [optional] - * @return string|boolean FALSE on failure + * @return string|false FALSE on failure * @since 5.6.0 */ function openssl_x509_fingerprint($x509, $type, $binary) {} @@ -595,7 +595,7 @@ function openssl_csr_export_to_file($csr, $outfilename, $notext = true) { } * An optional the serial number of issued certificate. If not specified * it will default to 0. *

      - * @return resource an x509 certificate resource on success, false on failure. + * @return resource|false an x509 certificate resource on success, false on failure. * @since 4.2.0 * @since 5.0 */ @@ -634,7 +634,7 @@ function openssl_csr_get_public_key($csr, $use_shortnames = true) { } * Setting to true will return as raw output data, otherwise the return * value is binhex encoded. *

      - * @return string the digested hash value on success or false on failure. + * @return string|false the digested hash value on success or false on failure. * @since 5.3.0 */ function openssl_digest($data, $method, $raw_output = false) { } @@ -662,7 +662,7 @@ function openssl_digest($data, $method, $raw_output = false) { } * @param int $tag_length [optional]

      * The length of the authentication tag. Its value can be between 4 and 16 for GCM mode. *

      - * @return string the encrypted string on success or false on failure. + * @return string|false the encrypted string on success or false on failure. * @since 5.3.0 */ function openssl_encrypt($data, $method, $key, $options = 0, $iv = "", &$tag = NULL, $aad = "", $tag_length = 16) { } @@ -691,7 +691,7 @@ function openssl_encrypt($data, $method, $key, $options = 0, $iv = "", &$tag = N * The authentication tag in AEAD cipher mode. If it is incorrect, the authentication fails and the function returns FALSE. *

      * @param string $aad [optional]

      Additional authentication data.

      - * @return string The decrypted string on success or false on failure. + * @return string|false The decrypted string on success or false on failure. * @since 5.3.0 */ function openssl_decrypt($data, $method, $password, $options = 1, $iv = "", $tag = "", $aad = "") { } @@ -703,7 +703,7 @@ function openssl_decrypt($data, $method, $password, $options = 1, $iv = "", $tag * @param string $method

      * The method. *

      - * @return int the cipher length on success, or false on failure. + * @return int|false the cipher length on success, or false on failure. */ function openssl_cipher_iv_length($method) { } @@ -750,7 +750,7 @@ function openssl_verify($data, $signature, $pub_key_id, $signature_alg = OPENSSL * @param array $pub_key_ids * @param string $method [optional] * @param string $iv [optional] - * @return int the length of the sealed data on success, or false on error. + * @return int|false the length of the sealed data on success, or false on error. * If successful the sealed data is returned in * sealed_data, and the envelope keys in * env_keys. @@ -785,7 +785,7 @@ function openssl_open($sealed_data, &$open_data, $env_key, $priv_key_id, $method * @param int $key_length * @param int $iterations * @param string $digest_algorithm [optional] - * @return string|bool Returns string or FALSE on failure. + * @return string|false Returns string or FALSE on failure. * @since 5.5.0 */ function openssl_pbkdf2($password, $salt, $key_length, $iterations, $digest_algorithm) { } @@ -820,7 +820,7 @@ function openssl_pbkdf2($password, $salt, $key_length, $iterations, $digest_algo * You can specify a filename with content that will * be filled with the verified data, but with the signature information * stripped. - * @param string|null + * @param string|null $pk7 [optional] *

      * @return mixed true if the signature is verified, false if it is not correct * (the message has been tampered with, or the signing certificate is invalid), @@ -1020,7 +1020,7 @@ function openssl_get_cipher_methods($aliases = false) { } * @param resource $dh_key

      * DH key *

      - * @return string computed key on success or false on failure. + * @return string|false computed key on success or false on failure. */ function openssl_dh_compute_key($pub_key, $dh_key) { } @@ -1046,7 +1046,7 @@ function openssl_pkey_derive($peer_pub_key, $priv_key, $keylen) {} * if the algorithm used was "cryptographically strong", e.g., safe for usage with GPG, * passwords, etc. true if it did, otherwise false *

      - * @return string the generated &string; of bytes on success, or false on failure. + * @return string|false the generated &string; of bytes on success, or false on failure. * @since 5.3.0 */ function openssl_random_pseudo_bytes($length, &$crypto_strong = null) { } @@ -1054,7 +1054,7 @@ function openssl_random_pseudo_bytes($length, &$crypto_strong = null) { } /** * Return openSSL error message * @link https://php.net/manual/en/function.openssl-error-string.php - * @return string an error message string, or false if there are no more error + * @return string|false an error message string, or false if there are no more error * messages to return. * @since 4.0.6 */ diff --git a/pcntl/pcntl.php b/pcntl/pcntl.php index 8245c935..57316d85 100644 --- a/pcntl/pcntl.php +++ b/pcntl/pcntl.php @@ -322,7 +322,7 @@ function pcntl_errno () {} * @link https://php.net/manual/en/function.pcntl-strerror.php * @param int $errno

      *

      - * @return string error description on success or FALSE on failure. + * @return string|false error description on success or FALSE on failure. * @since 5.3.4 */ function pcntl_strerror ($errno) {} diff --git a/pgsql/pgsql.php b/pgsql/pgsql.php index 68a59179..0c1541a2 100644 --- a/pgsql/pgsql.php +++ b/pgsql/pgsql.php @@ -34,7 +34,7 @@ * is created, even if the connection_string is identical to * an existing connection. *

      - * @return resource PostgreSQL connection resource on success, FALSE on failure. + * @return resource|false PostgreSQL connection resource on success, FALSE on failure. * @since 4.0 * @since 5.0 */ @@ -67,7 +67,7 @@ function pg_connect ($connection_string, $connect_type = null) {} * is created, even if the connection_string is identical to * an existing connection. *

      - * @return resource PostgreSQL connection resource on success, FALSE on failure. + * @return resource|false PostgreSQL connection resource on success, FALSE on failure. * @since 4.0 * @since 5.0 */ @@ -143,7 +143,7 @@ function pg_connection_reset ($connection) {} * @param resource $connection

      * PostgreSQL database connection resource. *

      - * @return resource A socket resource on success or FALSE on failure. + * @return resource|false A socket resource on success or FALSE on failure. * @since 5.6.0 */ function pg_socket ($connection) {} @@ -157,7 +157,7 @@ function pg_socket ($connection) {} * 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 + * @return string|false A string containing the name of the host the * connection is to, or FALSE on error. * @since 4.0 * @since 5.0 @@ -173,7 +173,7 @@ function pg_host ($connection = null) {} * 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 + * @return string|false A string containing the name of the database the * connection is to, or FALSE on error. * @since 4.0 * @since 5.0 @@ -276,7 +276,7 @@ function pg_ping ($connection = null) {} * DateStyle, TimeZone, and * integer_datetimes. *

      - * @return string A string containing the value of the parameter, FALSE on failure or invalid + * @return string|false A string containing the value of the parameter, FALSE on failure or invalid * param_name. * @since 5.0 */ @@ -325,7 +325,7 @@ function pg_transaction_status ($connection) {} * Any user-supplied data substituted directly into a query string should * be properly escaped. *

      - * @return resource A query result resource on success or FALSE on failure. + * @return resource|false A query result resource on success or FALSE on failure. * @since 4.2.0 * @since 5.0 */ @@ -363,7 +363,7 @@ function pg_query ($connection = null, $query) {} * parameters. Use pg_escape_bytea instead, or use the * large object functions. *

      - * @return resource A query result resource on success or FALSE on failure. + * @return resource|false A query result resource on success or FALSE on failure. * @since 5.1.0 */ function pg_query_params ($connection = null, $query, array $params) {} @@ -389,7 +389,7 @@ given parameters, and waits for completion. * (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 or FALSE on failure. + * @return resource|false A query result resource on success or FALSE on failure. */ function pg_prepare ($connection = null, $stmtname, $query) {} @@ -417,7 +417,7 @@ function pg_prepare ($connection = null, $stmtname, $query) {} *

      * Elements are converted to strings by calling this function. *

      - * @return resource A query result resource on success or FALSE on failure. + * @return resource|false A query result resource on success or FALSE on failure. * @since 5.1.0 */ function pg_execute ($connection = null, $stmtname, array $params) {} @@ -748,7 +748,7 @@ function pg_affected_rows ($result) {} * @param resource $connection [optional]

      * PostgreSQL database connection resource. *

      - * @return resource The result resource, or FALSE if no more results are available. + * @return resource|false The result resource, or FALSE if no more results are available. * @since 4.2.0 * @since 5.0 */ @@ -865,7 +865,7 @@ function pg_num_fields ($result) {} * @param int $field_number

      * Field number, starting from 0. *

      - * @return string The field name, or FALSE on error. + * @return string|false The field name, or FALSE on error. * @since 4.2.0 * @since 5.0 */ @@ -917,7 +917,7 @@ function pg_field_size ($result, $field_number) {} * @param int $field_number

      * Field number, starting from 0. *

      - * @return string A string containing the base name of the field's type, or FALSE + * @return string|false A string containing the base name of the field's type, or FALSE * on error. * @since 4.2.0 * @since 5.0 @@ -935,7 +935,7 @@ function pg_field_type ($result, $field_number) {} * @param int $field_number

      * Field number, starting from 0. *

      - * @return int The OID of the field's base type. FALSE is returned on error. + * @return int|false The OID of the field's base type. FALSE is returned on error. * @since 5.1.0 */ function pg_field_type_oid ($result, $field_number) {} @@ -950,7 +950,7 @@ function pg_field_type_oid ($result, $field_number) {} *

      * @param int $row_number * @param mixed $field_name_or_number - * @return int The field printed length, or FALSE on error. + * @return int|false The field printed length, or FALSE on error. * @since 4.2.0 * @since 5.0 */ @@ -1018,7 +1018,7 @@ function pg_field_table ($result, $field_number, $oid_only = false) {} * while PGSQL_BOTH, the default, will return both * numerical and associative indices. *

      - * @return array An array containing the NOTIFY message name and backend PID. + * @return array|false An array containing the NOTIFY message name and backend PID. * Otherwise if no NOTIFY is waiting, then FALSE is returned. * @since 4.3.0 * @since 5.0 @@ -1070,7 +1070,7 @@ function pg_result_error ($result) {} * PGSQL_DIAG_SOURCE_LINE or * PGSQL_DIAG_SOURCE_FUNCTION. *

      - * @return string A string containing the contents of the error field, NULL if the field does not exist or FALSE + * @return string|null|false A string containing the contents of the error field, NULL if the field does not exist or FALSE * on failure. * @since 5.1.0 */ @@ -1157,7 +1157,7 @@ function pg_end_copy ($connection = null) {} * How SQL NULL values are represented in the * rows. Default is \N ("\\N"). *

      - * @return array An array with one element for each line of COPY data. + * @return array|false An array with one element for each line of COPY data. * It returns FALSE on failure. * @since 4.2.0 * @since 5.0 @@ -1247,7 +1247,7 @@ function pg_untrace ($connection = null) {} * was added in PHP 5.3 and relies on functionality that first * appeared in PostgreSQL 8.1. *

      - * @return int A large object OID or FALSE on error. + * @return int|false A large object OID or FALSE on error. * @since 4.2.0 * @since 5.0 */ @@ -1287,7 +1287,7 @@ function pg_lo_unlink ($connection, $oid) {} * Can be either "r" for read-only, "w" for write only or "rw" for read and * write. *

      - * @return resource A large object resource or FALSE on error. + * @return resource|false A large object resource or FALSE on error. * @since 4.2.0 * @since 5.0 */ @@ -1335,7 +1335,7 @@ function pg_lo_read ($large_object, $len = 8192) {} * 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, or FALSE on error. + * @return int|false The number of bytes written to the large object, or FALSE on error. * @since 4.2.0 * @since 5.0 */ @@ -1347,7 +1347,7 @@ function pg_lo_write ($large_object, $data, $len = null) {} * @param resource $large_object

      * PostgreSQL large object (LOB) resource, returned by pg_lo_open. *

      - * @return int Number of bytes read or FALSE on error. + * @return int|false Number of bytes read or FALSE on error. * @since 4.2.0 * @since 5.0 */ @@ -1550,7 +1550,7 @@ function pg_set_error_verbosity ($connection = null, $verbosity) {} * is used. The default connection is the last connection made by * pg_connect or pg_pconnect. *

      - * @return string The client encoding, or FALSE on error. + * @return string|false The client encoding, or FALSE on error. * @since 4.0.3 * @since 5.0 */ diff --git a/posix/posix.php b/posix/posix.php index f25c58d8..1c7a0dbe 100644 --- a/posix/posix.php +++ b/posix/posix.php @@ -253,7 +253,7 @@ function posix_times () {} /** * Get path name of controlling terminal * @link https://php.net/manual/en/function.posix-ctermid.php - * @return string Upon successful completion, returns string of the pathname to + * @return string|false Upon successful completion, returns string of the pathname to * the current controlling terminal. Otherwise FALSE is returned and errno * is set, which can be checked with posix_get_last_error. * @since 4.0 @@ -267,7 +267,7 @@ function posix_ctermid () {} * @param int $fd

      * The file descriptor. *

      - * @return string On success, returns a string of the absolute path of the + * @return string|false On success, returns a string of the absolute path of the * fd. On failure, returns FALSE * @since 4.0 * @since 5.0 diff --git a/pspell/pspell.php b/pspell/pspell.php index c36d0b54..70862ccd 100644 --- a/pspell/pspell.php +++ b/pspell/pspell.php @@ -32,7 +32,7 @@ * There are several modes available: * PSPELL_FAST - Fast mode (least number of * suggestions) - * @return int the dictionary link identifier on success or FALSE on failure. + * @return int|false the dictionary link identifier on success or FALSE on failure. * @since 4.0.2 * @since 5.0 */ @@ -209,7 +209,7 @@ function pspell_save_wordlist ($dictionary_link) {} * 32'. This parameter is largely untested, so be careful when * using. *

      - * @return int Retuns a pspell config identifier, or FALSE on error. + * @return int|false Retuns a pspell config identifier, or FALSE on error. * @since 4.0.2 * @since 5.0 */ diff --git a/radius/radius.php b/radius/radius.php index b90afe84..a1b4337e 100644 --- a/radius/radius.php +++ b/radius/radius.php @@ -320,7 +320,7 @@ define('RADIUS_OPTION_TAGGED', RADIUS_OPTION_TAGGED); /** * Creates a Radius handle for accounting * @link https://secure.php.net/manual/en/function.radius-acct-open.php - * @return resource|bool Returns a handle on success, FALSE on error. This function only fails if insufficient memory is available. + * @return resource|false Returns a handle on success, FALSE on error. This function only fails if insufficient memory is available. * @since 1.1.0 */ function radius_acct_open() { } @@ -345,7 +345,7 @@ function radius_add_server($radius_handle , $hostname, $port , $secret, $timeout /** * Creates a Radius handle for authentication * @link https://secure.php.net/manual/en/function.radius-auth-open.php - * @return resource|bool Returns a handle on success, FALSE on error. This function only fails if insufficient memory is available. + * @return resource|false Returns a handle on success, FALSE on error. This function only fails if insufficient memory is available. * @since 1.1.0 */ function radius_auth_open() { } diff --git a/rar/rar.php b/rar/rar.php index cd918f76..abf09a1d 100644 --- a/rar/rar.php +++ b/rar/rar.php @@ -26,7 +26,7 @@ final class RarArchive implements Traversable * * @link https://php.net/manual/en/rararchive.open.php * - * @return RarArchive the requested RarArchive instance or FALSE on failure. + * @return RarArchive|false the requested RarArchive instance or FALSE on failure. */ public static function open($filename, $password = null, callable $volume_callback = null) { @@ -46,7 +46,7 @@ final class RarArchive implements Traversable * * @link https://php.net/manual/en/rararchive.getcomment.php * - * @return string the comment or NULL if there is none + * @return string|null the comment or NULL if there is none */ public function getComment() { @@ -54,7 +54,7 @@ final class RarArchive implements Traversable /** * Get full list of entries from the RAR archive * - * @return RarEntry[] array of {@see RarEntry} objects or FALSE on failure + * @return RarEntry[]|false array of {@see RarEntry} objects or FALSE on failure */ public function getEntries() { @@ -68,7 +68,7 @@ final class RarArchive implements Traversable * * @param string $entryname Path to the entry within the RAR archive * - * @return RarEntry the matching RarEntry object or FALSE on failure + * @return RarEntry|false the matching RarEntry object or FALSE on failure */ public function getEntry($entryname) { @@ -395,7 +395,7 @@ final class RarEntry * * @link https://php.net/manual/en/rarentry.getattr.php * - * @return int the attributes or FALSE on error + * @return int|false the attributes or FALSE on error */ public function getAttr() { @@ -407,7 +407,7 @@ final class RarEntry * * @link https://php.net/manual/en/rarentry.getcrc.php * - * @return string the CRC of the archive entry or FALSE on error + * @return string|false the CRC of the archive entry or FALSE on error */ public function getCrc() { @@ -417,7 +417,7 @@ final class RarEntry * * @link https://php.net/manual/en/rarentry.getfiletime.php * - * @return string entry last modification time as string in format YYYY-MM-DD HH:II:SS, or FALSE on errors + * @return string|false entry last modification time as string in format YYYY-MM-DD HH:II:SS, or FALSE on errors */ public function getFileTime() { @@ -429,7 +429,7 @@ final class RarEntry * * @link https://php.net/manual/en/rarentry.gethostos.php * - * @return int the code of the host OS, or FALSE on error + * @return int|false the code of the host OS, or FALSE on error */ public function getHostOs() { @@ -441,7 +441,7 @@ final class RarEntry * * @link https://php.net/manual/en/rarentry.getmethod.php * - * @return int the method number or FALSE on error + * @return int|false the method number or FALSE on error */ public function getMethod() { @@ -453,7 +453,7 @@ final class RarEntry * * @link https://php.net/manual/en/rarentry.getname.php * - * @return string the entry name as a string, or FALSE on error. + * @return string|false the entry name as a string, or FALSE on error. */ public function getName() { @@ -463,7 +463,7 @@ final class RarEntry * * @link https://php.net/manual/en/rarentry.getpackedsize.php * - * @return int the packed size, or FALSE on error + * @return int|false the packed size, or FALSE on error */ public function getPackedSize() { @@ -483,7 +483,7 @@ final class RarEntry * If no password is given and one is required, this method will fail and return FALSE. You can check * whether an entry is encrypted with {@see RarEntry::isEncrypted()}. * - * @return resource file handler or FALSE on failure + * @return resource|false file handler or FALSE on failure */ public function getStream($password = '') { @@ -491,7 +491,7 @@ final class RarEntry /** * Get unpacked size of the entry * @link https://php.net/manual/en/rarentry.getunpackedsize.php - * @return int the unpacked size, or FALSE on error + * @return int|false the unpacked size, or FALSE on error */ public function getUnpackedSize() { @@ -504,7 +504,7 @@ final class RarEntry * * @link https://php.net/manual/en/rarentry.getversion.php * - * @return int the version or FALSE on error + * @return int|false the version or FALSE on error */ public function getVersion() { diff --git a/rdkafka/RdKafka/Metadata/Collection.php b/rdkafka/RdKafka/Metadata/Collection.php index 6e387a35..40091e7c 100755 --- a/rdkafka/RdKafka/Metadata/Collection.php +++ b/rdkafka/RdKafka/Metadata/Collection.php @@ -26,7 +26,7 @@ class Collection implements \Iterator, \Countable } /** - * @return boolean + * @return bool */ public function valid() { diff --git a/recode/recode.php b/recode/recode.php index 62dc02f9..938415a3 100644 --- a/recode/recode.php +++ b/recode/recode.php @@ -11,7 +11,7 @@ * @param string $string

      * The string to be recoded *

      - * @return string the recoded string or FALSE, if unable to + * @return string|false the recoded string or FALSE, if unable to * perform the recode request. * @since 4.0 * @since 5.0 diff --git a/redis/Redis.php b/redis/Redis.php index 0a86f1cd..8c396765 100644 --- a/redis/Redis.php +++ b/redis/Redis.php @@ -117,7 +117,7 @@ class Redis * @param int $iterator * @param string $pattern * @param int $count - * @return array|bool + * @return array|false */ public function sScan($key, $iterator, $pattern = '', $count = 0) {} @@ -126,7 +126,7 @@ class Redis * @param int $iterator Iterator, initialized to NULL. * @param string $pattern Pattern to match. * @param int $count Count of keys per iteration (only a suggestion to Redis). - * @return array|bool This function will return an array of keys or FALSE if there are no more keys. + * @return array|false This function will return an array of keys or FALSE if there are no more keys. * @link https://redis.io/commands/scan * @example * 
      @@ -148,7 +148,7 @@ class Redis
      * @param   int $iterator
      * @param   string  $pattern
      * @param   int $count
-     * @return  array|bool
+     * @return  array|false
      */
     public function zScan($key, $iterator, $pattern = '', $count = 0) {}
 
@@ -322,7 +322,7 @@ class Redis
      * Get the value related to the specified key
      *
      * @param   string  $key
-     * @return  string|bool  If key didn't exist, FALSE is returned. Otherwise, the value related to this key is returned.
+     * @return  string|false  If key didn't exist, FALSE is returned. Otherwise, the value related to this key is returned.
      * @link    https://redis.io/commands/get
      * @example $redis->get('key');
      */
@@ -406,7 +406,7 @@ class Redis
     /**
      * Enter and exit transactional mode.
      *
-     * @param int Redis::MULTI|Redis::PIPELINE
+     * @param int $mode Redis::MULTI|Redis::PIPELINE
      * Defaults to Redis::MULTI.
      * A Redis::MULTI block of commands runs as a single transaction;
      * a Redis::PIPELINE block is simply transmitted faster to the server, but without any guarantee of atomicity.
@@ -448,7 +448,7 @@ class Redis
     /**
      * Watches a key for modifications by another client. If the key is modified between WATCH and EXEC,
      * the MULTI/EXEC transaction will fail (return FALSE). unwatch cancels all the watching of all keys by this client.
-     * @param string | array $key: a list of keys
+     * @param string|array $key: a list of keys
      * @return void
      * @link    https://redis.io/commands/watch
      * @example
@@ -473,7 +473,7 @@ class Redis
      * Subscribe to channels. Warning: this function will probably change in the future.
      *
      * @param array             $channels an array of channels to subscribe to
-     * @param string | array    $callback either a string or an array($instance, 'method_name').
+     * @param string|array      $callback either a string or an array($instance, 'method_name').
      * The callback function receives 3 parameters: the redis instance, the channel name, and the message.
      * @link    https://redis.io/commands/subscribe
      * @example
@@ -685,7 +685,7 @@ class Redis
      * @param   string $value1  String, value to push in key
      * @param   string $value2  Optional
      * @param   string $valueN  Optional
-     * @return  int|bool    The new length of the list in case of success, FALSE in case of Failure.
+     * @return  int|false    The new length of the list in case of success, FALSE in case of Failure.
      * @link    https://redis.io/commands/lpush
      * @example
      * 
      @@ -710,7 +710,7 @@ class Redis
      * @param   string  $value1 String, value to push in key
      * @param   string  $value2 Optional
      * @param   string  $valueN Optional
-     * @return  int|bool     The new length of the list in case of success, FALSE in case of Failure.
+     * @return  int|false     The new length of the list in case of success, FALSE in case of Failure.
      * @link    https://redis.io/commands/rpush
      * @example
      * 
      @@ -732,7 +732,7 @@ class Redis
      *
      * @param   string  $key
      * @param   string  $value String, value to push in key
-     * @return  int     The new length of the list in case of success, FALSE in case of Failure.
+     * @return  int|false     The new length of the list in case of success, FALSE in case of Failure.
      * @link    https://redis.io/commands/lpushx
      * @example
      * 
      @@ -751,7 +751,7 @@ class Redis
      *
      * @param   string  $key
      * @param   string  $value String, value to push in key
-     * @return  int     The new length of the list in case of success, FALSE in case of Failure.
+     * @return  int|false     The new length of the list in case of success, FALSE in case of Failure.
      * @link    https://redis.io/commands/rpushx
      * @example
      * 
      @@ -769,7 +769,7 @@ class Redis
      * Returns and removes the first element of the list.
      *
      * @param   string $key
-     * @return  string if command executed successfully BOOL FALSE in case of failure (empty list)
+     * @return  string|false if command executed successfully BOOL FALSE in case of failure (empty list)
      * @link    https://redis.io/commands/lpop
      * @example
      * 
      @@ -785,7 +785,7 @@ class Redis
      * Returns and removes the last element of the list.
      *
      * @param   string $key
-     * @return  string if command executed successfully BOOL FALSE in case of failure (empty list)
+     * @return  string|false if command executed successfully BOOL FALSE in case of failure (empty list)
      * @link    https://redis.io/commands/rpop
      * @example
      * 
      @@ -885,7 +885,7 @@ class Redis
      * the command returns 0. If the data type identified by Key is not a list, the command return FALSE.
      *
      * @param   string  $key
-     * @return  int     The size of the list identified by Key exists.
+     * @return  int|false     The size of the list identified by Key exists.
      * bool FALSE if the data type identified by Key is not list
      * @link    https://redis.io/commands/llen
      * @example
@@ -915,7 +915,7 @@ class Redis
      * Return FALSE in case of a bad index or a key that doesn't point to a list.
      * @param string    $key
      * @param int       $index
-     * @return String the element at this index
+     * @return string|false the element at this index
      * Bool FALSE if the key identifies a non-string data type, or no value corresponds to this index in the list Key.
      * @link    https://redis.io/commands/lindex
      * @example
@@ -945,7 +945,7 @@ class Redis
      * @param string    $key
      * @param int       $index
      * @param string    $value
-     * @return BOOL TRUE if the new value is setted. FALSE if the index is out of range, or data type identified by key
+     * @return bool TRUE if the new value is setted. FALSE if the index is out of range, or data type identified by key
      * is not a list.
      * @link    https://redis.io/commands/lset
      * @example
@@ -996,7 +996,7 @@ class Redis
      * @param string    $key
      * @param int       $start
      * @param int       $stop
-     * @return array    Bool return FALSE if the key identify a non-list value.
+     * @return array|false    Bool return FALSE if the key identify a non-list value.
      * @link        https://redis.io/commands/ltrim
      * @example
      * 
      @@ -1096,7 +1096,7 @@ class Redis
      * @param   string  $value1     Required value
      * @param   string  $value2     Optional value
      * @param   string  $valueN     Optional value
-     * @return  int     The number of elements added to the set
+     * @return  int|false     The number of elements added to the set
      * @link    https://redis.io/commands/sadd
      * @example
      * 
      @@ -1111,7 +1111,7 @@ class Redis
      *
      * @param   string  $key        Required key
      * @param   array   $values      Required values
-     * @return  boolean The number of elements added to the set
+     * @return  bool
      * @link    https://redis.io/commands/sadd
      * @link    https://github.com/phpredis/phpredis/commit/3491b188e0022f75b938738f7542603c7aae9077
      * @since   phpredis 2.2.8
@@ -1279,7 +1279,7 @@ class Redis
      * @param   string  $key1  keys identifying the different sets on which we will apply the intersection.
      * @param   string  $key2  ...
      * @param   string  $keyN  ...
-     * @return  array  contain the result of the intersection between those keys.
+     * @return  array|false  contain the result of the intersection between those keys.
      * If the intersection between the different sets is empty, the return value will be empty array.
      * @link    https://redis.io/commands/sinterstore
      * @example
@@ -1314,7 +1314,7 @@ class Redis
      * @param   string  $key1 are intersected as in sInter.
      * @param   string  $key2 ...
      * @param   string  $keyN ...
-     * @return  int     The cardinality of the resulting set, or FALSE in case of a missing key.
+     * @return  int|false     The cardinality of the resulting set, or FALSE in case of a missing key.
      * @link    https://redis.io/commands/sinterstore
      * @example
      * 
      @@ -1456,7 +1456,7 @@ class Redis
      * @param   string  $key1      Any number of keys corresponding to sets in redis
      * @param   string  $key2      ...
      * @param   string  $keyN      ...
-     * @return  int     The cardinality of the resulting set, or FALSE in case of a missing key.
+     * @return  int|false     The cardinality of the resulting set, or FALSE in case of a missing key.
      * @link    https://redis.io/commands/sdiffstore
      * @example
      * 
      @@ -1787,7 +1787,7 @@ class Redis
      *
      * @param   string  $string
      * @param   string  $key
-     * @return  string  for "encoding", int for "refcount" and "idletime", FALSE if the key doesn't exist.
+     * @return  string|false  for "encoding", int for "refcount" and "idletime", FALSE if the key doesn't exist.
      * @link    https://redis.io/commands/object
      * @example
      * 
      @@ -2168,7 +2168,7 @@ class Redis
      * Returns the time to live left for a given key, in seconds. If the key doesn't exist, FALSE is returned.
      *
      * @param   string  $key
-     * @return  int     the time left to live in seconds.
+     * @return  int|false     the time left to live in seconds.
      * @link    https://redis.io/commands/ttl
      * @example $redis->ttl('key');
      */
@@ -2180,7 +2180,7 @@ class Redis
      * If the key doesn't exist, FALSE is returned.
      *
      * @param   string  $key
-     * @return  int     the time left to live in milliseconds.
+     * @return  int|false     the time left to live in milliseconds.
      * @link    https://redis.io/commands/pttl
      * @example $redis->pttl('key');
      */
@@ -2261,7 +2261,7 @@ class Redis
      * @since   redis >= 1.1
      * @param   string  $srcKey
      * @param   string  $dstKey
-     * @return  string  The element that was moved in case of success, FALSE in case of failure.
+     * @return  string|false  The element that was moved in case of success, FALSE in case of failure.
      * @link    https://redis.io/commands/rpoplpush
      * @example
      * 
      @@ -2302,7 +2302,7 @@ class Redis
      * @param   string  $srcKey
      * @param   string  $dstKey
      * @param   int     $timeout
-     * @return  string  The element that was moved in case of success, FALSE in case of timeout.
+     * @return  string|false  The element that was moved in case of success, FALSE in case of timeout.
      * @link    https://redis.io/commands/brpoplpush
      */
     public function brpoplpush( $srcKey, $dstKey, $timeout ) {}
@@ -2486,7 +2486,7 @@ class Redis
      * @param   int     $max    The maximum alphanumeric value you wish to get.
      * @param   int     $offset Optional argument if you wish to start somewhere other than the first element.
      * @param   int     $limit  Optional argument if you wish to limit the number of elements returned.
-     * @return  array   Array containing the values in the specified range.
+     * @return  array|false   Array containing the values in the specified range.
      * @link    https://redis.io/commands/zrangebylex
      * @example
      * 
      @@ -2760,7 +2760,7 @@ class Redis
      * @param string $key
      * @param string $hashKey
      * @param string $value
-     * @return int|bool
+     * @return int|false
      * 1 if value didn't exist and was added successfully,
      * 0 if the value was already present and was replaced,
      * FALSE if there was an error.
@@ -2801,7 +2801,7 @@ class Redis
      *
      * @param   string  $key
      * @param   string  $hashKey
-     * @return  string  The value, if the command executed successfully BOOL FALSE in case of failure
+     * @return  string|false  The value, if the command executed successfully BOOL FALSE in case of failure
      * @link    https://redis.io/commands/hget
      */
     public function hGet($key, $hashKey) {}
@@ -2810,7 +2810,7 @@ class Redis
      * Returns the length of a hash, in number of items
      *
      * @param   string  $key
-     * @return  int     the number of items in a hash, FALSE if the key doesn't exist or isn't a hash.
+     * @return  int|false     the number of items in a hash, FALSE if the key doesn't exist or isn't a hash.
      * @link    https://redis.io/commands/hlen
      * @example
      * 
      @@ -2830,7 +2830,7 @@ class Redis
      * @param   string  $hashKey1
      * @param   string  $hashKey2
      * @param   string  $hashKeyN
-     * @return  int|bool     Number of deleted fields, FALSE if table or key doesn't exist
+     * @return  int|false     Number of deleted fields, FALSE if table or key doesn't exist
      * @link    https://redis.io/commands/hdel
      * @example
      * 
      @@ -3200,7 +3200,7 @@ class Redis
      * Dump a key out of a redis database, the value of which can later be passed into redis using the RESTORE command.
      * The data that comes out of DUMP is a binary representation of the key as Redis stores it.
      * @param   string  $key
-     * @return  string  The Redis encoded value of the key, or FALSE if the key doesn't exist
+     * @return  string|false  The Redis encoded value of the key, or FALSE if the key doesn't exist
      * @link    https://redis.io/commands/dump
      * @example
      * 
      diff --git a/redis/RedisCluster.php b/redis/RedisCluster.php
index 07ccb477..d1ef25fc 100644
--- a/redis/RedisCluster.php
+++ b/redis/RedisCluster.php
@@ -64,7 +64,7 @@ class RedisCluster {
     /**
      * Creates a Redis Cluster client
      *
-     * @param string | null mixed $name
+     * @param string|null   $name
      * @param array         $seeds
      * @param float         $timeout
      * @param float         $readTimeout
@@ -103,7 +103,7 @@ class RedisCluster {
      *
      * @param   string $key
      *
-     * @return  string|bool If key didn't exist, FALSE is returned. Otherwise, the value related to this key is
+     * @return  string|false If key didn't exist, FALSE is returned. Otherwise, the value related to this key is
      *                       returned.
      *
      * @link    https://redis.io/commands/get
@@ -349,7 +349,7 @@ class RedisCluster {
      *
      * @param   string $key
      *
-     * @return  string if command executed successfully BOOL FALSE in case of failure (empty list)
+     * @return  string|false if command executed successfully BOOL FALSE in case of failure (empty list)
      * @link    https://redis.io/commands/lpop
      * @example
      * 
      @@ -379,7 +379,7 @@ class RedisCluster {
      *
      * @param   string $key
      *
-     * @return  string if command executed successfully BOOL FALSE in case of failure (empty list)
+     * @return  string|false if command executed successfully BOOL FALSE in case of failure (empty list)
      * @link    https://redis.io/commands/rpop
      * @example
      * 
      @@ -411,7 +411,7 @@ class RedisCluster {
      * @param int    $index
      * @param string $value
      *
-     * @return BOOL TRUE if the new value is setted. FALSE if the index is out of range, or data type identified by key
+     * @return bool TRUE if the new value is setted. FALSE if the index is out of range, or data type identified by key
      * is not a list.
      * @link    https://redis.io/commands/lset
      * @example
@@ -457,7 +457,7 @@ class RedisCluster {
      * @param   string $value2 Optional
      * @param   string $valueN Optional
      *
-     * @return  int    The new length of the list in case of success, FALSE in case of Failure.
+     * @return  int|false    The new length of the list in case of success, FALSE in case of Failure.
      * @link    https://redis.io/commands/lpush
      * @example
      * 
      @@ -483,7 +483,7 @@ class RedisCluster {
      * @param   string $value2 Optional
      * @param   string $valueN Optional
      *
-     * @return  int     The new length of the list in case of success, FALSE in case of Failure.
+     * @return  int|false     The new length of the list in case of success, FALSE in case of Failure.
      * @link    https://redis.io/commands/rpush
      * @example
      * 
      @@ -595,7 +595,7 @@ class RedisCluster {
      * @param   string $key
      * @param   string $value String, value to push in key
      *
-     * @return  int     The new length of the list in case of success, FALSE in case of Failure.
+     * @return  int|false     The new length of the list in case of success, FALSE in case of Failure.
      * @link    https://redis.io/commands/rpushx
      * @example
      * 
      @@ -615,7 +615,7 @@ class RedisCluster {
      * @param   string $key
      * @param   string $value String, value to push in key
      *
-     * @return  int     The new length of the list in case of success, FALSE in case of Failure.
+     * @return  int|false     The new length of the list in case of success, FALSE in case of Failure.
      * @link    https://redis.io/commands/lpushx
      * @example
      * 
      @@ -669,7 +669,7 @@ class RedisCluster {
      * @param string $key
      * @param int    $index
      *
-     * @return String the element at this index
+     * @return string|false the element at this index
      * Bool FALSE if the key identifies a non-string data type, or no value corresponds to this index in the list Key.
      * @link    https://redis.io/commands/lindex
      * @example
@@ -718,7 +718,7 @@ class RedisCluster {
      * @param   string $dstKey
      * @param   int    $timeout
      *
-     * @return  string  The element that was moved in case of success, FALSE in case of timeout.
+     * @return  string|false  The element that was moved in case of success, FALSE in case of timeout.
      * @link    https://redis.io/commands/brpoplpush
      */
     public function brpoplpush($srcKey, $dstKey, $timeout) { }
@@ -732,7 +732,7 @@ class RedisCluster {
      * @param   string $srcKey
      * @param   string $dstKey
      *
-     * @return  string  The element that was moved in case of success, FALSE in case of failure.
+     * @return  string|false  The element that was moved in case of success, FALSE in case of failure.
      * @link    https://redis.io/commands/rpoplpush
      * @example
      * 
      @@ -867,7 +867,7 @@ class RedisCluster {
      * @param   string $value2 Optional value
      * @param   string $valueN Optional value
      *
-     * @return  int     The number of elements added to the set
+     * @return  int|false     The number of elements added to the set
      * @link    https://redis.io/commands/sadd
      * @example
      * 
      @@ -884,7 +884,7 @@ class RedisCluster {
      * @param   string $key Required key
      * @param   array  $valueArray
      *
-     * @return  int     The number of elements added to the set
+     * @return  int|false     The number of elements added to the set
      * @example
      * 
            * $redisCluster->sAddArray('k', ['v1', 'v2', 'v3']);
@@ -1042,7 +1042,7 @@ class RedisCluster {
      * @param   string $key2   ...
      * @param   string $keyN   ...
      *
-     * @return  int    The cardinality of the resulting set, or FALSE in case of a missing key.
+     * @return  int|false    The cardinality of the resulting set, or FALSE in case of a missing key.
      * @link    https://redis.io/commands/sinterstore
      * @example
      * 
      @@ -1116,7 +1116,7 @@ class RedisCluster {
      * @param   string $key2   ...
      * @param   string $keyN   ...
      *
-     * @return  int    The cardinality of the resulting set, or FALSE in case of a missing key.
+     * @return  int|false    The cardinality of the resulting set, or FALSE in case of a missing key.
      * @link    https://redis.io/commands/sdiffstore
      * @example
      * 
      @@ -1355,7 +1355,7 @@ class RedisCluster {
      *
      * @param   string $key
      *
-     * @return  int     the number of items in a hash, FALSE if the key doesn't exist or isn't a hash.
+     * @return  int|false     the number of items in a hash, FALSE if the key doesn't exist or isn't a hash.
      * @link    https://redis.io/commands/hlen
      * @example
      * 
      @@ -1440,7 +1440,7 @@ class RedisCluster {
      * @param   string $key
      * @param   string $hashKey
      *
-     * @return  string  The value, if the command executed successfully BOOL FALSE in case of failure
+     * @return  string|false  The value, if the command executed successfully BOOL FALSE in case of failure
      * @link    https://redis.io/commands/hget
      * @example
      * 
      @@ -1669,7 +1669,7 @@ class RedisCluster {
      *
      * @param   string $key
      *
-     * @return  string  The Redis encoded value of the key, or FALSE if the key doesn't exist
+     * @return  string|false  The Redis encoded value of the key, or FALSE if the key doesn't exist
      * @link    https://redis.io/commands/dump
      * @example
      * 
      @@ -2039,7 +2039,7 @@ class RedisCluster {
      * @param int    $start
      * @param int    $stop
      *
-     * @return array    Bool return FALSE if the key identify a non-list value.
+     * @return array|false    Bool return FALSE if the key identify a non-list value.
      * @link        https://redis.io/commands/ltrim
      * @example
      * 
      @@ -2149,7 +2149,7 @@ class RedisCluster {
      * When called with a single key, returns the approximated cardinality computed by the HyperLogLog data
      * structure stored at the specified variable, which is 0 if the variable does not exist.
      *
-     * @param   string | array $key
+     * @param   string|array $key
      *
      * @return  int
      * @link    https://redis.io/commands/pfcount
@@ -2572,7 +2572,7 @@ class RedisCluster {
      * @param   string $string
      * @param   string $key
      *
-     * @return  string  for "encoding", int for "refcount" and "idletime", FALSE if the key doesn't exist.
+     * @return  string|false  for "encoding", int for "refcount" and "idletime", FALSE if the key doesn't exist.
      * @link    https://redis.io/commands/object
      * @example
      * 
      @@ -2586,8 +2586,8 @@ class RedisCluster {
     /**
      * Subscribe to channels. Warning: this function will probably change in the future.
      *
-     * @param array          $channels an array of channels to subscribe to
-     * @param string | array $callback either a string or an array($instance, 'method_name').
+     * @param array        $channels an array of channels to subscribe to
+     * @param string|array $callback either a string or an array($instance, 'method_name').
      *                                 The callback function receives 3 parameters: the redis instance, the channel
      *                                 name, and the message.
      *
@@ -2619,8 +2619,8 @@ class RedisCluster {
     /**
      * Subscribe to channels by pattern
      *
-     * @param   array          $patterns     The number of elements removed from the set.
-     * @param   string | array $callback     Either a string or an array with an object and method.
+     * @param   array        $patterns     The number of elements removed from the set.
+     * @param   string|array $callback     Either a string or an array with an object and method.
      *                                       The callback will get four arguments ($redis, $pattern, $channel, $message)
      *
      * @return  mixed           Any non-null return value in the callback will be returned to the caller.
@@ -2704,7 +2704,7 @@ class RedisCluster {
      * @param   null   $pattern  String, optional pattern to match against.
      * @param   int    $count    How many members to return at a time (Redis might return a different amount).
      *
-     * @return  array   PHPRedis will return an array of keys or FALSE when we're done iterating.
+     * @return  array|false   PHPRedis will return an array of keys or FALSE when we're done iterating.
      * @link    https://redis.io/commands/sscan
      * @example
      * 
      @@ -2726,7 +2726,7 @@ class RedisCluster {
      * @param   string $pattern  String (optional), the pattern to match.
      * @param   int    $count    How many keys to return per iteration (Redis might return a different number).
      *
-     * @return  array   PHPRedis will return matching keys from Redis, or FALSE when iteration is complete.
+     * @return  array|false   PHPRedis will return matching keys from Redis, or FALSE when iteration is complete.
      * @link    https://redis.io/commands/zscan
      * @example
      * 
      @@ -2773,7 +2773,7 @@ class RedisCluster {
     /**
      * The last error message (if any)
      *
-     * @return  string  A string with the last returned script based error message, or NULL if there is no error
+     * @return  string|null  A string with the last returned script based error message, or NULL if there is no error
      * @example
      * 
            * $redisCluster->eval('this-is-not-lua');
@@ -2896,7 +2896,7 @@ class RedisCluster {
     /**
      * Enter and exit transactional mode.
      *
-     * @param int RedisCluster::MULTI|RedisCluster::PIPELINE
+     * @param int $mode RedisCluster::MULTI|RedisCluster::PIPELINE
      *            Defaults to RedisCluster::MULTI.
      *            A RedisCluster::MULTI block of commands runs as a single transaction;
      *            a RedisCluster::PIPELINE block is simply transmitted faster to the server, but without any guarantee
@@ -2940,7 +2940,7 @@ class RedisCluster {
      * Watches a key for modifications by another client. If the key is modified between WATCH and EXEC,
      * the MULTI/EXEC transaction will fail (return FALSE). unwatch cancels all the watching of all keys by this client.
      *
-     * @param string | array $key : a list of keys
+     * @param string|array $key : a list of keys
      *
      * @return void
      * @link    https://redis.io/commands/watch
@@ -2965,7 +2965,7 @@ class RedisCluster {
     /**
      * Performs a synchronous save at a specific node.
      *
-     * @param String | array $nodeParams key or [host,port]
+     * @param string|array $nodeParams key or [host,port]
      *
      * @return  bool   TRUE in case of success, FALSE in case of failure.
      * If a save is already running, this command will fail and return FALSE.
@@ -2979,7 +2979,7 @@ class RedisCluster {
     /**
      * Performs a background save at a specific node.
      *
-     * @param String | array $nodeParams key or [host,port]
+     * @param string|array $nodeParams key or [host,port]
      *
      * @return  bool    TRUE in case of success, FALSE in case of failure.
      * If a save is already running, this command will fail and return FALSE.
@@ -2990,7 +2990,7 @@ class RedisCluster {
     /**
      * Removes all entries from the current database at a specific node.
      *
-     * @param String | array $nodeParams key or [host,port]
+     * @param string|array $nodeParams key or [host,port]
      *
      * @return  bool Always TRUE.
      * @link    https://redis.io/commands/flushdb
@@ -3000,7 +3000,7 @@ class RedisCluster {
     /**
      * Removes all entries from all databases at a specific node.
      *
-     * @param String | array $nodeParams key or [host,port]
+     * @param string|array $nodeParams key or [host,port]
      *
      * @return  bool Always TRUE.
      * @link    https://redis.io/commands/flushall
@@ -3010,7 +3010,7 @@ class RedisCluster {
     /**
      * Returns the current database's size at a specific node.
      *
-     * @param String | array $nodeParams key or [host,port]
+     * @param string|array $nodeParams key or [host,port]
      *
      * @return int     DB size, in number of keys.
      * @link    https://redis.io/commands/dbsize
@@ -3025,7 +3025,7 @@ class RedisCluster {
     /**
      * Starts the background rewrite of AOF (Append-Only File) at a specific node.
      *
-     * @param String | array $nodeParams key or [host,port]
+     * @param string|array $nodeParams key or [host,port]
      *
      * @return  bool   TRUE in case of success, FALSE in case of failure.
      * @link    https://redis.io/commands/bgrewriteaof
@@ -3036,7 +3036,7 @@ class RedisCluster {
     /**
      * Returns the timestamp of the last disk save at a specific node.
      *
-     * @param String | array $nodeParams key or [host,port]
+     * @param string|array $nodeParams key or [host,port]
      *
      * @return  int    timestamp.
      * @link    https://redis.io/commands/lastsave
@@ -3113,7 +3113,7 @@ class RedisCluster {
      * @since  redis >= 2.8.12.
      *  Returns the role of the instance in the context of replication
      *
-     * @param String | array $nodeParams key or [host,port]
+     * @param string|array $nodeParams key or [host,port]
      *
      * @return array
      * @link   https://redis.io/commands/role
@@ -3128,7 +3128,7 @@ class RedisCluster {
     /**
      * Returns a random key at the specified node
      *
-     * @param String | array $nodeParams key or [host,port]
+     * @param string|array $nodeParams key or [host,port]
      *
      * @return string an existing key in redis.
      * @link    https://redis.io/commands/randomkey
@@ -3143,7 +3143,7 @@ class RedisCluster {
     /**
      * Return the specified node server time.
      *
-     * @param String | array $nodeParams key or [host,port]
+     * @param string|array $nodeParams key or [host,port]
      *
      * @return  array If successfully, the time will come back as an associative array with element zero being the
      * unix timestamp, and element one being microseconds.
@@ -3164,7 +3164,7 @@ class RedisCluster {
     /**
      * Check the specified node status
      *
-     * @param String | array $nodeParams key or [host,port]
+     * @param string|array $nodeParams key or [host,port]
      *
      * @return  string STRING: +PONG on success. Throws a RedisException object on connectivity error, as described
      *                 above.
@@ -3175,10 +3175,10 @@ class RedisCluster {
     /**
      * Returns message.
      *
-     * @param String | array $nodeParams key or [host,port]
-     * @param  String        $msg
+     * @param string|array $nodeParams key or [host,port]
+     * @param string        $msg
      *
-     * @return mixed array | bool
+     * @return mixed
      */
     public function echo ($nodeParams, $msg) { }
 
@@ -3192,9 +3192,9 @@ class RedisCluster {
     /**
      * Send arbitrary things to the redis server at the specified node
      *
-     * @param String | array $nodeParams key or [host,port]
-     * @param String         $command    Required command to send to the server.
-     * @param mixed          $arguments  Optional variable amount of arguments to send to the server.
+     * @param string|array $nodeParams key or [host,port]
+     * @param string       $command    Required command to send to the server.
+     * @param mixed        $arguments  Optional variable amount of arguments to send to the server.
      *
      * @return  mixed
      */
@@ -3204,9 +3204,9 @@ class RedisCluster {
      * @since redis >= 3.0
      * Executes cluster command
      *
-     * @param String | array $nodeParams key or [host,port]
-     * @param string         $command    Required command to send to the server.
-     * @param mixed          $arguments  Optional variable amount of arguments to send to the server.
+     * @param string|array $nodeParams key or [host,port]
+     * @param string       $command    Required command to send to the server.
+     * @param mixed        $arguments  Optional variable amount of arguments to send to the server.
      *
      * @return  mixed
      * @link  https://redis.io/commands#cluster
@@ -3220,19 +3220,19 @@ class RedisCluster {
     /**
      * Allows you to get information of the cluster client
      *
-     * @param String | array $nodeParams key or [host,port]
-     * @param                $subCmd     String  which can be: 'LIST', 'KILL', 'GETNAME', or 'SETNAME'
-     * @param                $args       String optional arguments
+     * @param string|array $nodeParams key or [host,port]
+     * @param string       $subCmd     can be: 'LIST', 'KILL', 'GETNAME', or 'SETNAME'
+     * @param string       $args       optional arguments
      */
     public function client($nodeParams, $subCmd, $args) { }
 
     /**
      * Get or Set the redis config keys.
      *
-     * @param String | array $nodeParams key or [host,port]
-     * @param string         $operation  either `GET` or `SET`
-     * @param string         $key        for `SET`, glob-pattern for `GET`. See https://redis.io/commands/config-get for examples.
-     * @param string         $value      optional string (only for `SET`)
+     * @param string|array $nodeParams key or [host,port]
+     * @param string       $operation  either `GET` or `SET`
+     * @param string       $key        for `SET`, glob-pattern for `GET`. See https://redis.io/commands/config-get for examples.
+     * @param string       $value      optional string (only for `SET`)
      *
      * @return  array   Associative array for `GET`, key -> value
      * @link    https://redis.io/commands/config-get
@@ -3248,14 +3248,14 @@ class RedisCluster {
     /**
      * A command allowing you to get information on the Redis pub/sub system.
      *
-     * @param    string | array $nodeParams key or [host,port]
+     * @param    string|array $nodeParams key or [host,port]
      *
-     * @param    string         $keyword    String, which can be: "channels", "numsub", or "numpat"
-     * @param    string | array $argument   Optional, variant.
-     *                                      For the "channels" subcommand, you can pass a string pattern.
-     *                                      For "numsub" an array of channel names
+     * @param    string       $keyword    String, which can be: "channels", "numsub", or "numpat"
+     * @param    string|array $argument   Optional, variant.
+     *                                    For the "channels" subcommand, you can pass a string pattern.
+     *                                    For "numsub" an array of channel names
      *
-     * @return    array | int                   Either an integer or an array.
+     * @return    array|int               Either an integer or an array.
      *                          - channels  Returns an array where the members are the matching channels.
      *                          - numsub    Returns a key/value array where the keys are channel names and
      *                                      values are their counts.
@@ -3275,9 +3275,9 @@ class RedisCluster {
     /**
      * Execute the Redis SCRIPT command to perform various operations on the scripting subsystem.
      *
-     * @param   string | array $nodeParams key or [host,port]
-     * @param   string         $command    load | flush | kill | exists
-     * @param   string         $script
+     * @param   string|array $nodeParams key or [host,port]
+     * @param   string       $command    load | flush | kill | exists
+     * @param   string       $script
      *
      * @return  mixed
      * @link    https://redis.io/commands/script-load
@@ -3302,9 +3302,9 @@ class RedisCluster {
     /**
      * This function is used in order to read and reset the Redis slow queries log.
      *
-     * @param   string | array $nodeParams key or [host,port]
-     * @param   string         $command
-     * @param   mixed          $argument
+     * @param   string|array $nodeParams key or [host,port]
+     * @param   string       $command
+     * @param   mixed        $argument
      *
      * @link  https://redis.io/commands/slowlog
      * @example
diff --git a/rrd/rrd.php b/rrd/rrd.php
index 569c2826..57c8c9e4 100644
--- a/rrd/rrd.php
+++ b/rrd/rrd.php
@@ -53,7 +53,7 @@ function rrd_fetch($filename, $options) {}
  * @param int $raaindex 
      
  * The index number of the RRA that is to be examined. Default value is 0.
  * 
      
- * @return int Integer as unix timestamp, FALSE if some error occurs.
+ * @return int|false Integer as unix timestamp, FALSE if some error occurs.
  * @since PECL rrd >= 0.9.0
  */
 function rrd_first($file, $raaindex = 0) {}
@@ -67,7 +67,7 @@ function rrd_first($file, $raaindex = 0) {}
  * @param array $options 
      
  * Options for generating image. See man page of rrd graph for all possible options. All options (data definitions, variable defintions, etc.) are allowed.
  * 
      
- * @return array If image is created successfully an array with information about generated image is returned, FALSE when error occurs.
+ * @return array|false If image is created successfully an array with information about generated image is returned, FALSE when error occurs.
  * @since PECL rrd >= 0.9.0
  */
 function rrd_graph($filename, $options) {}
@@ -78,7 +78,7 @@ function rrd_graph($filename, $options) {}
  * @param string $filename 
      
  * RRD database file name.
  * 
      
- * @return array Array with information about requsted RRD file, FALSE when error occurs.
+ * @return array|false Array with information about requsted RRD file, FALSE when error occurs.
  * @since PECL rrd >= 0.9.0
  */
 function rrd_info($filename) {}
@@ -100,7 +100,7 @@ function rrd_last($filename) {}
  * @param string $filename 
      
  * RRD database file name.
  * 
      
- * @return array Array of information about last update, FALSE when error occurs.
+ * @return array|false Array of information about last update, FALSE when error occurs.
  * @since PECL rrd >= 0.9.0
  */
 function rrd_lastupdate($filename) {}
@@ -164,7 +164,7 @@ function rrd_version() {}
  * @param array $options 
      
  * Array of options for the export, see rrd xport man page.
  * 
      
- * @return array Array with information about RRD database file, FALSE when error occurs.
+ * @return array|false Array with information about RRD database file, FALSE when error occurs.
  * @since PECL rrd >= 0.9.0
  */
 function rrd_xport($options) {}
@@ -260,7 +260,7 @@ class RRDGraph {
     /**
      * Saves the result of RRD database query into image defined by RRDGraph::__construct().
      * @link https://php.net/manual/en/rrdgraph.save.php
-     * @return array Array with information about generated image is returned, FALSE if error occurs.
+     * @return array|false Array with information about generated image is returned, FALSE if error occurs.
      * @since PECL rrd >= 0.9.0
      */
     public function save() {}
@@ -270,7 +270,7 @@ class RRDGraph {
      * If "-" is used as image filename, image data are also returned in result array.
      * 
      
      * @link https://php.net/manual/en/rrdgraph.saveverbose.php
-     * @return array Array with detailed information about generated image is returned, optionally with image data, FALSE if error occurs.
+     * @return array|false Array with detailed information about generated image is returned, optionally with image data, FALSE if error occurs.
      * @since PECL rrd >= 0.9.0
      */
     public function saveVerbose() {}
diff --git a/shmop/shmop.php b/shmop/shmop.php
index ee065c15..48c3708e 100644
--- a/shmop/shmop.php
+++ b/shmop/shmop.php
@@ -43,7 +43,7 @@ function shmop_open ($key, $flags, $mode, $size) {}
  * @param int $count 
      
  * The number of bytes to read
  * 
      
- * @return string the data or FALSE on failure.
+ * @return string|false the data or FALSE on failure.
  * @since 4.0.4
  * @since 5.0
  */
@@ -90,7 +90,7 @@ function shmop_size ($shmid) {}
  * Specifies where to start writing data inside the shared memory
  * segment.
  * 
      
- * @return int The size of the written data, or FALSE on
+ * @return int|false The size of the written data, or FALSE on
  * failure.
  * @since 4.0.4
  * @since 5.0
diff --git a/snmp/snmp.php b/snmp/snmp.php
index 921b3ffe..9b8990fe 100644
--- a/snmp/snmp.php
+++ b/snmp/snmp.php
@@ -131,7 +131,7 @@ class SNMP  {
 	/**
 	 * Close SNMP session
 	 * @link https://php.net/manual/en/snmp.close.php
-	 * @return mixed TRUE on success or FALSE on failure.
+	 * @return bool TRUE on success or FALSE on failure.
 	 * @since 5.4.0
 	 */
 	public function close () {}
@@ -182,7 +182,7 @@ class SNMP  {
      * @param $suffix_as_keys bool [optional] 
      By default full OID notation is used for keys in output array. If set to TRUE subtree prefix will be removed from keys leaving only suffix of object_id.
      
      * @param $max_repetitions int [optional] 
      This specifies the maximum number of iterations over the repeating variables. The default is to use this value from SNMP object.
      
      * @param $non_repeaters int [optional] 
      This specifies the number of supplied variables that should not be iterated over. The default is to use this value from SNMP object.
      
-     * @return array associative array of the SNMP object ids and their values on success or FALSE on error.
+     * @return array|false associative array of the SNMP object ids and their values on success or FALSE on error.
 	 * When a SNMP error occures SNMP::getErrno and
 	 * SNMP::getError can be used for retrieving error
 	 * number (specific to SNMP extension, see class constants) and error message
@@ -318,7 +318,7 @@ class SNMPException extends RuntimeException  {
  * @param int $retries [optional] 
      
  * The number of times to retry if timeouts occur.
  * 
      
- * @return string SNMP object value on success or FALSE on error.
+ * @return string|false SNMP object value on success or FALSE on error.
  * @since 4.0
  * @since 5.0
  */
@@ -332,7 +332,7 @@ function snmpget ($hostname, $community, $object_id, $timeout = 1000000, $retrie
  * @param string $object_id 
      The SNMP object id which precedes the wanted one.
      
  * @param int $timeout [optional] 
      The number of microseconds until the first timeout.
      
  * @param int $retries [optional] 
      The number of times to retry if timeouts occur.
      
- * @return string SNMP object value on success or FALSE on error.
+ * @return string|false SNMP object value on success or FALSE on error.
  * In case of an error, an E_WARNING message is shown.
  * @since 5.0
  */
@@ -375,7 +375,7 @@ function snmpwalk ($hostname, $community, $object_id, $timeout = 1000000, $retri
  * @param string $object_id 
      The SNMP object id which precedes the wanted one.
      
  * @param int $timeout [optional] 
      The number of microseconds until the first timeout.
      
  * @param int $retries [optional] 
      The number of times to retry if timeouts occur.
      
- * @return array an associative array of the SNMP object ids and their values on success or FALSE on error.
+ * @return array|false an associative array of the SNMP object ids and their values on success or FALSE on error.
  * In case of an error, an E_WARNING message is shown.
  * @since 4.0
  * @since 5.0
@@ -561,7 +561,7 @@ function snmp_set_oid_numeric_print ($oid_format) {}
  * @param int $retries [optional] 
      
  * The number of times to retry if timeouts occur.
  * 
      
- * @return string SNMP object value on success or FALSE on error.
+ * @return string|false SNMP object value on success or FALSE on error.
  * @since 5.2.0
  */
 function snmp2_get ($host, $community, $object_id, $timeout = 1000000, $retries = 5) {}
@@ -584,7 +584,7 @@ function snmp2_get ($host, $community, $object_id, $timeout = 1000000, $retries
  * @param int $retries [optional] 
      
  * The number of times to retry if timeouts occur.
  * 
      
- * @return string SNMP object value on success or FALSE on error.
+ * @return string|false SNMP object value on success or FALSE on error.
  * In case of an error, an E_WARNING message is shown.
  * @since 5.2.0
  */
@@ -638,7 +638,7 @@ function snmp2_walk ($host, $community, $object_id, $timeout = 1000000, $retries
  * @param int $retries [optional] 
      
  * The number of times to retry if timeouts occur.
  * 
      
- * @return array an associative array of the SNMP object ids and their values on success or FALSE on error.
+ * @return array|false an associative array of the SNMP object ids and their values on success or FALSE on error.
  * In case of an error, an E_WARNING message is shown.
  * @since 5.2.0
  */
@@ -743,7 +743,7 @@ function snmp2_set ($host, $community, $object_id, $type, $value, $timeout = 100
  * @param int $retries [optional] 
      
  * The number of times to retry if timeouts occur.
  * 
      
- * @return string SNMP object value on success or FALSE on error.
+ * @return string|false SNMP object value on success or FALSE on error.
  * @since 4.0
  * @since 5.0
  */
@@ -783,7 +783,7 @@ function snmp3_get ($host, $sec_name, $sec_level, $auth_protocol, $auth_passphra
  * @param int $retries [optional] 
      
  * The number of times to retry if timeouts occur.
  * 
      
- * @return string SNMP object value on success or FALSE on error.
+ * @return string|false SNMP object value on success or FALSE on error.
  * In case of an error, an E_WARNING message is shown.
  * @since 5.0
  */
diff --git a/sockets/sockets.php b/sockets/sockets.php
index 1b20c867..b6f4c33b 100644
--- a/sockets/sockets.php
+++ b/sockets/sockets.php
@@ -263,7 +263,7 @@ function socket_create_pair ($domain, $type, $protocol, array &$fd) {}
  * @param resource $socket 
      
  * A valid socket resource created with socket_create.
  * 
      
- * @return resource a new socket resource on success, or FALSE on error. The actual
+ * @return resource|false a new socket resource on success, or FALSE on error. 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
@@ -356,7 +356,7 @@ function socket_close ($socket) {}
  * greater then the buffer length, it is silently truncated to the length
  * of the buffer.
  * 
      
- * @return int the number of bytes successfully written to the socket or FALSE on failure.
+ * @return int|false the number of bytes successfully written to the socket or FALSE on failure.
  * 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
@@ -665,7 +665,7 @@ function socket_recv ($socket, &$buf, $len, $flags) {}
  *
    *
    *

    - * @return int socket_send returns the number of bytes sent, or FALSE on error. + * @return int|false socket_send returns the number of bytes sent, or FALSE on error. * @since 4.1.0 * @since 5.0 */ @@ -1293,7 +1293,7 @@ function socket_clear_error ($socket = null) {} * @param resource $stream

    * The stream resource to import. *

    - * @return resource FALSE or NULL on failure. + * @return resource|false|null FALSE or NULL on failure. * @since 5.4.0 */ function socket_import_stream ($stream) {} diff --git a/sodium/sodium.php b/sodium/sodium.php index 9c2736b1..7e659326 100644 --- a/sodium/sodium.php +++ b/sodium/sodium.php @@ -12,6 +12,23 @@ const SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES = 32; const SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_NSECBYTES = 0; const SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES = 12; const SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_ABYTES = 16; +const SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES = 32; +const SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NSECBYTES = 0; +const SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES = 24; +const SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES = 16; +const SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_ABYTES = 17; +const SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_HEADERBYTES = 24; +const SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_KEYBYTES = 32; +const SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_MESSAGEBYTES_MAX = 274877906816; +const SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE = 0; +const SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_PUSH = 1; +const SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_REKEY = 2; +const SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL = 3; +const SODIUM_CRYPTO_PWHASH_ALG_ARGON2ID13 = 2; +const SODIUM_BASE64_VARIANT_ORIGINAL = 1; +const SODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDING = 3; +const SODIUM_BASE64_VARIANT_URLSAFE = 5; +const SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING = 7; const SODIUM_CRYPTO_AUTH_BYTES = 32; const SODIUM_CRYPTO_AUTH_KEYBYTES = 32; const SODIUM_CRYPTO_BOX_SEALBYTES = 16; @@ -90,7 +107,7 @@ function sodium_crypto_aead_aes256gcm_is_available(): bool * @param string $ad additional data * @param string $nonce * @param string $key - * @return string + * @return string|false */ function sodium_crypto_aead_aes256gcm_decrypt( string $ciphertext, @@ -262,7 +279,7 @@ function sodium_crypto_kx_seed_keypair (string $string): string {} * @since 7.2 * @param string $server_keypair * @param string $client_key - * @return array + * @return string[] */ function sodium_crypto_kx_server_session_keys (string $server_keypair , string $client_key): array {} @@ -280,7 +297,7 @@ function sodium_crypto_generichash_keygen(): string {} * @link https://php.net/manual/en/function.sodium-crypto-kx-client-session-keys.php * @param string $client_keypair * @param string $server_key - * @return array + * @return string[] */ function sodium_crypto_kx_client_session_keys (string $client_keypair, string $server_key): array {} @@ -323,8 +340,8 @@ function sodium_crypto_stream_keygen(): string {} * Add padding data * @link https://php.net/manual/en/function.sodium-pad.php * @since 7.2 - * @param $string - * @param $length + * @param string $string + * @param int $length * @return string */ function sodium_pad ($string, $length): string {} @@ -333,8 +350,8 @@ function sodium_pad ($string, $length): string {} * Remove padding data * @link https://php.net/manual/en/function.sodium-unpad.php * @since 7.2 - * @param $string - * @param $length + * @param string $string + * @param int $length */ function sodium_unpad ($string, $length): string {} @@ -420,7 +437,7 @@ function sodium_crypto_box_keypair_from_secretkey_and_publickey( * @param string $msg * @param string $nonce * @param string $keypair - * @return string + * @return string|false */ function sodium_crypto_box_open( string $msg, @@ -479,7 +496,7 @@ function sodium_crypto_box_seal( * * @param string $encrypted * @param string $keypair - * @return string + * @return string|false */ function sodium_crypto_box_seal_open( string $encrypted, @@ -743,7 +760,7 @@ function sodium_crypto_secretbox( * @param string $ciphertext * @param string $nonce * @param string $key - * @return string|bool + * @return string|false */ function sodium_crypto_secretbox_open( string $ciphertext, @@ -859,7 +876,7 @@ function sodium_crypto_sign_keypair_from_secretkey_and_publickey( * * @param string $signed_message * @param string $publickey - * @return string + * @return string|false */ function sodium_crypto_sign_open( string $signed_message, @@ -992,7 +1009,7 @@ function sodium_randombytes_buf( * Generate a 16-bit integer * /dev/urandom * - * @return int + * @return int|string */ function sodium_randombytes_random16(): string { return ''; diff --git a/solr/Documents/SolrDocument.php b/solr/Documents/SolrDocument.php index adf3a64f..615e44e5 100644 --- a/solr/Documents/SolrDocument.php +++ b/solr/Documents/SolrDocument.php @@ -151,7 +151,7 @@ final class SolrDocument implements ArrayAccess, Iterator, Serializable { * @param string $fieldName

    * The name of the field. *

    - * @return SolrDocumentField Returns a SolrDocumentField object on success and FALSE on failure + * @return SolrDocumentField|false Returns a SolrDocumentField object on success and FALSE on failure */ public function getField($fieldName) {} @@ -159,7 +159,7 @@ final class SolrDocument implements ArrayAccess, Iterator, Serializable { * (PECL solr >= 0.9.2)
    * Returns the number of fields in this document * @link https://php.net/manual/en/solrdocument.getfieldcount.php - * @return int

    + * @return int|false

    * Returns an integer on success and FALSE on failure. *

    */ @@ -169,7 +169,7 @@ final class SolrDocument implements ArrayAccess, Iterator, Serializable { * (PECL solr >= 0.9.2)
    * Returns an array containing all the fields in the document * @link https://php.net/manual/en/solrdocument.getfieldnames.php - * @return array

    + * @return array|false

    * Returns an array on success and FALSE on failure. *

    */ diff --git a/solr/Documents/SolrInputDocument.php b/solr/Documents/SolrInputDocument.php index aa49667e..1a5fd0d7 100644 --- a/solr/Documents/SolrInputDocument.php +++ b/solr/Documents/SolrInputDocument.php @@ -137,7 +137,7 @@ final class SolrInputDocument { * (PECL solr >= 0.9.2)
    * Retrieves the current boost value for the document * @link https://php.net/manual/en/solrinputdocument.getboost.php - * @return float

    + * @return float|false

    * Returns the boost value on success and FALSE on failure. *

    */ @@ -166,7 +166,7 @@ final class SolrInputDocument { * @param string $fieldName

    * The name of the field. *

    - * @return SolrDocumentField Returns a SolrDocumentField object on success and FALSE on failure. + * @return SolrDocumentField|false Returns a SolrDocumentField object on success and FALSE on failure. */ public function getField($fieldName) {} @@ -177,7 +177,7 @@ final class SolrInputDocument { * @param string $fieldName

    * The name of the field. *

    - * @return float

    + * @return float|false

    * Returns the boost value for the field or FALSE if there was an error. *

    */ @@ -187,7 +187,7 @@ final class SolrInputDocument { * (PECL solr >= 0.9.2)
    * Returns the number of fields in the document * @link https://php.net/manual/en/solrinputdocument.getfieldcount.php - * @return int

    + * @return int|false

    * Returns an integer on success or FALSE on failure. *

    */ @@ -197,7 +197,7 @@ final class SolrInputDocument { * (PECL solr >= 0.9.2)
    * Returns an array containing all the fields in the document * @link https://php.net/manual/en/solrinputdocument.getfieldnames.php - * @return array

    + * @return array|false

    * Returns an array on success and FALSE on failure. *

    */ @@ -296,7 +296,7 @@ final class SolrInputDocument { * (PECL solr >= 0.9.2)
    * Returns an array representation of the input document * @link https://php.net/manual/en/solrinputdocument.toarray.php - * @return array

    + * @return array|false

    * Returns an array containing the fields. It returns FALSE on failure. *

    */ diff --git a/solr/Queries/SolrParams.php b/solr/Queries/SolrParams.php index 633c2cef..03272b80 100644 --- a/solr/Queries/SolrParams.php +++ b/solr/Queries/SolrParams.php @@ -24,7 +24,7 @@ abstract class SolrParams implements Serializable { * @param string $value

    * The value of the parameter *

    - * @return SolrParams

    + * @return SolrParams|false

    * Returns a SolrParams instance on success and FALSE on failure. *

    */ @@ -40,7 +40,7 @@ abstract class SolrParams implements Serializable { * @param string $value

    * The value of the parameter *

    - * @return SolrParams

    + * @return SolrParams|false

    * Returns a SolrParams instance on success and FALSE on failure. *

    */ @@ -112,7 +112,7 @@ abstract class SolrParams implements Serializable { * @param $value

    * The parameter value *

    - * @return SolrParams

    + * @return SolrParams|false

    * Returns a SolrParams instance on success and FALSE on failure. *

    */ @@ -128,7 +128,7 @@ abstract class SolrParams implements Serializable { * @param $value

    * The parameter value *

    - * @return SolrParams

    + * @return SolrParams|false

    * Returns a SolrParams instance on success and FALSE on failure. *

    */ @@ -141,7 +141,7 @@ abstract class SolrParams implements Serializable { * @param bool $url_encode

    * Whether to return URL-encoded values *

    - * @return string

    + * @return string|false

    * Returns a string on success and FALSE on failure. *

    */ diff --git a/solr/Utils/SolrUtils.php b/solr/Utils/SolrUtils.php index b7f61bc0..bf3257eb 100644 --- a/solr/Utils/SolrUtils.php +++ b/solr/Utils/SolrUtils.php @@ -45,7 +45,7 @@ abstract class SolrUtils { * @param string $str

    * This is the query string to be escaped. *

    - * @return string

    + * @return string|false

    * Returns the escaped string or FALSE on failure. *

    */ diff --git a/solr/functions.php b/solr/functions.php index cf1ce37c..b215400a 100644 --- a/solr/functions.php +++ b/solr/functions.php @@ -10,7 +10,7 @@ * (PECL solr >= 0.9.1)
    * Returns the current version of the Apache Solr extension * @link https://php.net/manual/en/function.solr-get-version.php - * @return string

    + * @return string|false

    * It returns a string on success and FALSE on failure. *

    */ diff --git a/sqlite3/sqlite3.php b/sqlite3/sqlite3.php index c570d7e8..e6ed4f87 100644 --- a/sqlite3/sqlite3.php +++ b/sqlite3/sqlite3.php @@ -137,7 +137,7 @@ class SQLite3 { * @param string $query

    * The SQL query to prepare. *

    - * @return SQLite3Stmt an SQLite3Stmt object on success or FALSE on failure. + * @return SQLite3Stmt|false an SQLite3Stmt object on success or FALSE on failure. * @since 5.3.0 */ public function prepare ($query) {} @@ -256,7 +256,7 @@ class SQLite3 { * @param $dbname [optional]

    The symbolic name of the DB

    * @param int $flags [optional] *

    Either SQLITE3_OPEN_READONLY or SQLITE3_OPEN_READWRITE to open the stream for reading only, or for reading and writing, respectively. - * @return array a result row as an associatively or numerically indexed array or + * @return array|false a result row as an associatively or numerically indexed array or * both. Alternately will return FALSE if there are no more rows. * @since 5.3.0 */ diff --git a/sqlsrv/sqlsrv.php b/sqlsrv/sqlsrv.php index a47129f2..1f5dda15 100644 --- a/sqlsrv/sqlsrv.php +++ b/sqlsrv/sqlsrv.php @@ -1213,7 +1213,7 @@ function sqlsrv_execute($stmt){} *

  • SQLSRV_CURSOR_DYNAMIC
    • *
  • SQLSRV_CURSOR_KEYSET
    • *
  • SQLSRV_CURSOR_CLIENT_BUFFERED
    • - * @return resource|bool A statement resource. If the statement cannot be created and/or executed, false is returned. + * @return resource|false A statement resource. If the statement cannot be created and/or executed, false is returned. */ function sqlsrv_query($conn, $tsql, $params=array(), $options=array()){} @@ -1383,7 +1383,7 @@ function sqlsrv_has_rows($stmt){} * * @link https://docs.microsoft.com/en-us/sql/connect/php/sqlsrv-num-fields * @param resource $stmt The statement on which the targeted result set is active. - * @return int|bool An integer value that represents the number of fields in the active result set. If an error occurs, + * @return int|false An integer value that represents the number of fields in the active result set. If an error occurs, * the Boolean value false is returned. */ function sqlsrv_num_fields($stmt){} @@ -1419,7 +1419,7 @@ function sqlsrv_next_result($stmt){} * * @link https://docs.microsoft.com/en-us/sql/connect/php/sqlsrv-num-rows * @param resource $stmt The result set for which to count the rows. - * @return int|bool False if there was an error calculating the number of rows. Otherwise, returns the number of rows in the result set. + * @return int|false False if there was an error calculating the number of rows. Otherwise, returns the number of rows in the result set. */ function sqlsrv_num_rows($stmt){} @@ -1433,7 +1433,7 @@ function sqlsrv_num_rows($stmt){} * * @link https://docs.microsoft.com/en-us/sql/connect/php/sqlsrv-rows-affected * @param resource $stmt A statement resource corresponding to an executed statement. - * @return int|bool An integer indicating the number of rows modified by the last executed statement. If no rows were + * @return int|false An integer indicating the number of rows modified by the last executed statement. If no rows were * modified, zero (0) is returned. If no information about the number of modified rows is available, negative one (-1) * is returned. If an error occurred in retrieving the number of modified rows, false is returned. */ @@ -1527,7 +1527,7 @@ function sqlsrv_free_stmt($stmt){} * * @link https://docs.microsoft.com/en-us/sql/connect/php/sqlsrv-field-metadata * @param resource $stmt A statement resource for which field metadata is sought. - * @return array|bool An array of arrays or false. The array consists of one array for each field in the result set. + * @return array|false An array of arrays or false. The array consists of one array for each field in the result set. * Each sub-array has keys as described in the table below. If there is an error in retrieving field metadata, false is * returned. *