opensourcemirror
/
phpstorm-stubs
mirror of https://github.com/JetBrains/phpstorm-stubs.git
1
0
Fork 0
Code Issues Releases Wiki Activity

correct return value for PHP internal functions on failure

This commit is contained in:
Peter Gribanov 2020-06-24 19:23:50 +03:00 committed by Ivan Fedorov
parent 8841ebf3e0
commit 16a0de7429
15 changed files with 52 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
cubrid/cubrid.php
View File

@ -33,7 +33,7 @@
* a new connection, even if cubrid_connect() was called
* before with the same parameters.
* </p>
* @return resource <p>
* @return resource|false <p>
* a CUBRID connection identifier on success or false on failure.
* </p>
*/
@ -65,7 +65,7 @@ function cubrid_connect ($host, $port, $dbname, $userid = 'PUBLIC', $passwd = ''
* a new connection, even if cubrid_connect() was called
* before with the same parameters.
* </p>
* @return resource <p>
* @return resource|false <p>
* a CUBRID connection identifier on success or false on failure.
* </p>
*/
@ -92,7 +92,7 @@ function cubrid_connect_with_url ($conn_url, $userid = 'PUBLIC', $passwd = '', $
* User password. Default value is empty string, i.e. no
* password is defined.
* </p>
* @return resource <p>
* @return resource|false <p>
* Connection identifier, when process is successful.
* FALSE, when process is unsuccessful.
* </p>
@ -115,7 +115,7 @@ function cubrid_pconnect ($host, $port, $dbname, $userid = 'PUBLIC', $passwd = '
* User password. Default value is empty string, i.e. no
* password is defined.
* </p>
* @return resource <p>
* @return resource|false <p>
* Connection identifier, when process is successful.
* FALSE, when process is unsuccessful.
* </p>
@ -161,7 +161,7 @@ function cubrid_disconnect ($conn_identifier = null) {}
* is not specified, the last connection opened by
* cubrid_connect() is assumed.
* </p>
* @return resource <ul><li>
* @return resource|bool <ul><li>
* For SELECT, SHOW, DESCRIBE, EXPLAIN and other statements
* returning resultset, cubrid_query() returns a resource
* on success, or false on error.
@ -207,7 +207,7 @@ function cubrid_query ($query, $conn_identifier = null) {}
* Query execution option CUBRID_INCLUDE_OID, CUBRID_ASYNC,
* CUBRID_EXEC_QUERY_ALL.
* </p>
* @return resource <p>
* @return resource|bool <p>
* Request identifier, when process is successful,
* or FALSE, when process is unsuccessful.
* </p>
@ -341,7 +341,7 @@ function cubrid_col_size ($conn_identifier, $oid, $attr_name) {}
* The CUBRID connection. If the connection identifier is not
* specified, the last connection opened by cubrid_connect() is assumed.
* </p>
* @return resource <p>
* @return resource|bool <p>
* For SELECT, SHOW, DESCRIBE or EXPLAIN statements,
* cubrid_unbuffered_query() returns a resource on success, or false on
* error.
@ -1427,7 +1427,7 @@ function cubrid_lob2_import ($lob_identifier, $file_name) {}
* It may be "BLOB" or "CLOB", it won't be case-sensitive.
* The default value is "BLOB".
* </p>
* @return resource <p>
* @return resource|false <p>
* Lob identifier when it is successful. FALSE on failure.
* </p>
*/
@ -1649,7 +1649,7 @@ function cubrid_next_result ($result) {}
* @param int $option [optional] <p>
* OID return option CUBRID_INCLUDE_OID.
* </p>
* @return resource <p>
* @return resource|false <p>
* Request identifier, if process is successful;
* FALSE, if process is unsuccessful.
* </p>

6
enchant/enchant.php
View File

@ -6,7 +6,7 @@
* (PHP 5 &gt;= 5.3.0, PECL enchant &gt;= 0.1.0 )<br/>
* create a new broker object capable of requesting
* @link https://php.net/manual/en/function.enchant-broker-init.php
* @return resource a broker resource on success or <b>FALSE</b>.
* @return resource|false a broker resource on success or <b>FALSE</b>.
*/
function enchant_broker_init () {}
@ -66,7 +66,7 @@ function enchant_broker_list_dicts ($broker) {}
* @param string $tag <p>
* A tag describing the locale, for example en_US, de_DE
* </p>
* @return resource a dictionary resource on success or <b>FALSE</b> on failure.
* @return resource|false a dictionary resource on success or <b>FALSE</b> on failure.
*/
function enchant_broker_request_dict ($broker, $tag) {}
@ -80,7 +80,7 @@ function enchant_broker_request_dict ($broker, $tag) {}
* @param string $filename <p>
* Path to the PWL file.
* </p>
* @return resource a dictionary resource on success or <b>FALSE</b> on failure.
* @return resource|false a dictionary resource on success or <b>FALSE</b> on failure.
*/
function enchant_broker_request_pwl_dict ($broker, $filename) {}

12
fann/fann.php
View File

@ -123,7 +123,7 @@ function fann_copy($ann)
*
* @param string $configuration_file
*
* @return resource
* @return resource|false
*/
function fann_create_from_file($configuration_file)
{
@ -223,7 +223,7 @@ function fann_create_standard($num_layers, $num_neurons1, $num_neurons2, $_ = nu
* @param int $num_output
* @param callable $user_function
*
* @return resource
* @return resource|false
*/
function fann_create_train_from_callback($num_data, $num_input, $num_output, $user_function)
{
@ -237,7 +237,7 @@ function fann_create_train_from_callback($num_data, $num_input, $num_output, $us
* @param int $num_input
* @param int $num_output
*
* @return resource
* @return resource|false
*/
function fann_create_train($num_data, $num_input, $num_output)
{
@ -312,7 +312,7 @@ function fann_destroy_train($train_data)
*
* @param resource $data
*
* @return resource
* @return resource|false
*/
function fann_duplicate_train_data($data)
{
@ -1004,7 +1004,7 @@ function fann_randomize_weights($ann, $min_weight, $max_weight)
*
* @param string $filename
*
* @return resource
* @return resource|false
*/
function fann_read_train_from_file($filename)
{
@ -1787,7 +1787,7 @@ function fann_shuffle_train_data($train_data)
* @param int $pos
* @param int $length
*
* @return resource
* @return resource|false
*/
function fann_subset_train_data($data, $pos, $length)
{

12
interbase/interbase.php
View File

@ -437,7 +437,7 @@ function ibase_blob_info ($link_identifier, $blob_id) {}
* An InterBase link identifier. If omitted, the last opened link is
* assumed.
* </p>
* @return resource a BLOB handle for later use with
* @return resource|false a BLOB handle for later use with
* ibase_blob_add or false on failure.
*/
function ibase_blob_create ($link_identifier = null) {}
@ -489,7 +489,7 @@ function ibase_blob_close ($blob_handle) {}
* @param string $blob_id <p>
* A BLOB id.
* </p>
* @return resource a BLOB handle for later use with
* @return resource|false a BLOB handle for later use with
* ibase_blob_get or false on failure.
*/
function ibase_blob_open ($link_identifier, $blob_id) {}
@ -586,7 +586,7 @@ function ibase_delete_user ($service_handle, $user_name) {}
* @param string $host
* @param string $dba_username
* @param string $dba_password
* @return resource
* @return resource|false
*/
function ibase_service_attach ($host, $dba_username, $dba_password) {}
@ -1163,7 +1163,7 @@ function fbird_blob_info ($link_identifier, $blob_id) {}
* An InterBase link identifier. If omitted, the last opened link is
* assumed.
* </p>
* @return resource a BLOB handle for later use with
* @return resource|false a BLOB handle for later use with
* fbird_blob_add or false on failure.
*/
function fbird_blob_create ($link_identifier = null) {}
@ -1219,7 +1219,7 @@ function fbird_blob_close ($blob_handle) {}
* @param string $blob_id <p>
* A BLOB id.
* </p>
* @return resource a BLOB handle for later use with
* @return resource|false a BLOB handle for later use with
* fbird_blob_get or false on failure.
*/
function fbird_blob_open ($link_identifier, $blob_id) {}
@ -1325,7 +1325,7 @@ function fbird_delete_user ($service_handle, $user_name) {}
* @param string $host
* @param string $dba_username
* @param string $dba_password
* @return resource
* @return resource|false
*/
function fbird_service_attach ($host, $dba_username, $dba_password) {}

16
ldap/ldap.php
View File

@ -131,7 +131,7 @@ function ldap_bind ($link_identifier, $bind_rdn = null, $bind_password = null) {
* @param string $bind_rdn [optional]
* @param string $bind_password [optional]
* @param array $serverctrls [optional] Array of LDAP Controls to send with the request.
* @return resource
* @return resource|false
* @since 7.3
*/
function ldap_bind_ext ($link_identifier, $bind_rdn = null, $bind_password = null, $serverctrls = []) {}
@ -374,7 +374,7 @@ function ldap_count_entries ($link_identifier, $result_identifier) {}
* An LDAP link identifier, returned by <b>ldap_connect</b>.
* </p>
* @param resource $result_identifier
* @return resource the result entry identifier for the first entry on success and
* @return resource|false the result entry identifier for the first entry on success and
* <b>FALSE</b> on error.
*/
function ldap_first_entry ($link_identifier, $result_identifier) {}
@ -581,7 +581,7 @@ function ldap_add ($link_identifier, $dn, array $entry, $serverctrls = []) {}
* </code>
* </p>
* @param array $serverctrls [optional] Array of LDAP Controls to send with the request.
* @return resource
* @return resource|false
* @since 7.4
*/
function ldap_add_ext ($link_identifier, $dn, array $entry, $serverctrls = []) {}
@ -611,7 +611,7 @@ function ldap_delete ($link_identifier, $dn, $serverctrls = []) {}
* The distinguished name of an LDAP entity.
* </p>
* @param array $serverctrls [optional] Array of LDAP Controls to send with the request.
* @return resource
* @return resource|false
* @since 7.3
*/
function ldap_delete_ext ($link_identifier, $dn, $serverctrls = []) {}
@ -660,7 +660,7 @@ function ldap_mod_add ($link_identifier, $dn, array $entry, $serverctrls = []) {
* </p>
* @param array $entry
* @param array $serverctrls [optional] Array of LDAP Controls to send with the request.
* @return resource
* @return resource|false
*/
function ldap_mod_add_ext ($link_identifier, $dn, array $entry, $serverctrls = []) {}
@ -691,7 +691,7 @@ function ldap_mod_replace ($link_identifier, $dn, array $entry, $serverctrls = [
* </p>
* @param array $entry
* @param array $serverctrls [optional] Array of LDAP Controls to send with the request.
* @return resource
* @return resource|false
* @since 7.3
*/
function ldap_mod_replace_ext ($link_identifier, $dn, array $entry, $serverctrls = []) {}
@ -723,7 +723,7 @@ function ldap_mod_del ($link_identifier, $dn, array $entry, $serverctrls = []) {
* </p>
* @param array $entry
* @param array $serverctrls [optional] Array of LDAP Controls to send with the request.
* @return resource
* @return resource|false
* @since 7.3
*/
function ldap_mod_del_ext ($link_identifier, $dn, array $entry, $serverctrls = []) {}
@ -843,7 +843,7 @@ function ldap_rename ($link_identifier, $dn, $newrdn, $newparent, $deleteoldrdn,
* is retained as non-distinguished values of the entry.
* </p>
* @param array $serverctrls [optional] Array of LDAP Controls to send with the request.
* @return resource
* @return resource|false
* @since 7.3
*/
function ldap_rename_ext ($link_identifier, $dn, $newrdn, $newparent, $deleteoldrdn, $serverctrls = []) {}

4
mssql/mssql.php
View File

@ -53,7 +53,7 @@ function mssql_connect ($servername = null, $username = null, $password = null,
* mssql_pconnect was called before with the same
* parameters.
* </p>
* @return resource a positive MS SQL persistent link identifier on success, or
* @return resource|false a positive MS SQL persistent link identifier on success, or
* false on error.
* @removed 7.0
*/
@ -447,7 +447,7 @@ function mssql_min_message_severity ($severity) {}
* A MS SQL link identifier, returned by
* mssql_connect.
* </p>
* @return resource a resource identifier "statement", used in subsequent calls to
* @return resource|false a resource identifier "statement", used in subsequent calls to
* mssql_bind and mssql_execute,
* or false on errors.
* @removed 7.0

4
mysql/mysql.php
View File

@ -165,7 +165,7 @@ function mysql_query ($query, $link_identifier = null) {}
* Data inside the query should be properly escaped.
* </p>
* @param resource $link_identifier [optional]
* @return resource For SELECT, SHOW, DESCRIBE or EXPLAIN statements,
* @return resource|bool For SELECT, SHOW, DESCRIBE or EXPLAIN statements,
* <b>mysql_unbuffered_query</b>
* returns a resource on success, or false on
* error.
@ -192,7 +192,7 @@ function mysql_unbuffered_query ($query, $link_identifier = null) {}
* Data inside the query should be properly escaped.
* </p>
* @param resource $link_identifier [optional]
* @return resource a positive MySQL result resource to the query result,
* @return resource|bool a positive MySQL result resource to the query result,
* or false on error. The function also returns true/false for
* INSERT/UPDATE/DELETE
* queries to indicate success/failure.

8
odbc/odbc.php
View File

@ -227,7 +227,7 @@ function odbc_errormsg ($connection_id = null) {}
* @param int $flags [optional] <p>
* This parameter is currently not used.
* </p>
* @return resource an ODBC result identifier if the SQL command was executed
* @return resource|false an ODBC result identifier if the SQL command was executed
* successfully, or <b>FALSE</b> on error.
*/
function odbc_exec ($connection_id, $query_string, $flags = null) {}
@ -390,7 +390,7 @@ function odbc_free_result ($result_id) {}
* The data type, which can be used to restrict the information to a
* single data type.
* </p>
* @return resource an ODBC result identifier or
* @return resource|false an ODBC result identifier or
* <b>FALSE</b> on failure.
* </p>
* <p>
@ -656,7 +656,7 @@ function odbc_statistics ($connection_id, $qualifier, $owner, $table_name, $uniq
* <b>odbc_tables</b> does not return any results for
* that type.
* </p>
* @return resource an ODBC result identifier containing the information
* @return resource|false an ODBC result identifier containing the information
* or <b>FALSE</b> on failure.
* </p>
* <p>
@ -822,7 +822,7 @@ function odbc_foreignkeys ($connection_id, $pk_qualifier, $pk_owner, $pk_table,
* @link https://php.net/manual/en/function.odbc-procedures.php
* @param resource $connection_id The ODBC connection identifier,
* see <b>odbc_connect</b> for details.</p>
* @return resource an ODBC
* @return resource|false an ODBC
* result identifier containing the information or <b>FALSE</b> on failure.
* </p>
* <p>

4
sockets/sockets.php
View File

@ -28,7 +28,7 @@ function socket_addrinfo_lookup($host, $service, $hints) {}
* @param resource $addr <p>
* Resource created from {@see socket_addrinfo_lookup()}
* </p>
* @return resource Socket resource on success or NULL on failure.
* @return resource|null Socket resource on success or NULL on failure.
* @since 7.2
*/
function socket_addrinfo_connect($addr) {}
@ -41,7 +41,7 @@ function socket_addrinfo_connect($addr) {}
* @param resource $addr <p>
* Resource created from {@see socket_addrinfo_lookup()}
* </p>
* @return resource Socket resource on success or NULL on failure.
* @return resource|null Socket resource on success or NULL on failure.
* @since 7.2
*/
function socket_addrinfo_bind($addr) {}

4
ssh2/ssh2.php
View File

@ -452,7 +452,7 @@ function ssh2_poll (&$var1) {}
* An SSH connection link identifier, obtained from a call to
* ssh2_connect.
* </p>
* @return resource This method returns an SSH2 SFTP resource for use with
* @return resource|false This method returns an SSH2 SFTP resource for use with
* all other ssh2_sftp_*() methods and the
* ssh2.sftp:// fopen wrapper.
*/
@ -599,7 +599,7 @@ function ssh2_sftp_realpath ($sftp, $filename) {}
* @link https://php.net/manual/en/function.ssh2-publickey-init.php
* @param resource $session <p>
* </p>
* @return resource an SSH2 Publickey Subsystem resource for use
* @return resource|false an SSH2 Publickey Subsystem resource for use
* with all other ssh2_publickey_*() methods or false on failure.
*/
function ssh2_publickey_init ($session) {}

4
standard/standard_6.php
View File

@ -214,7 +214,7 @@ function stream_context_set_default (array $options) {}
* called first during stream operations. To add a filter to the end of the
* list, use stream_filter_append.
* </p>
* @return resource a resource which can be used to refer to this filter
* @return resource|false a resource which can be used to refer to this filter
* instance during a call to stream_filter_remove.
*/
function stream_filter_prepend ($stream, $filtername, $read_write = null, $params = null) {}
@ -248,7 +248,7 @@ function stream_filter_prepend ($stream, $filtername, $read_write = null, $param
* To add a filter to the beginning of the list, use
* stream_filter_prepend.
* </p>
* @return resource a resource which can be used to refer to this filter
* @return resource|false a resource which can be used to refer to this filter
* instance during a call to stream_filter_remove.
*/
function stream_filter_append ($stream, $filtername, $read_write = null, $params = null) {}

2
sybase/sybase_ct.php
View File

@ -20,7 +20,7 @@ function sybase_connect ($servername = null, $username = null, $password = null,
* @param $password string[optional]
* @param $charset string[optional]
* @param $appname string[optional]
* @return resource a positive Sybase persistent link identifier on success
* @return resource|false a positive Sybase persistent link identifier on success
* @removed 7.0
*/
function sybase_pconnect ($servername = null, $username = null, $password = null, $charset = null, $appname = null) {}

4
xml/xml.php
View File

@ -18,7 +18,7 @@
* encodings are ISO-8859-1, UTF-8 and
* US-ASCII.
* </p>
* @return resource a resource handle for the new XML parser.
* @return resource|false a resource handle for the new XML parser.
*/
function xml_parser_create ($encoding = null) {}
@ -41,7 +41,7 @@ function xml_parser_create ($encoding = null) {}
* handler functions will consist of namespace and tag name separated by
* the string specified in <i>separator</i>.
* </p>
* @return resource a resource handle for the new XML parser.
* @return resource|false a resource handle for the new XML parser.
*/
function xml_parser_create_ns ($encoding = null, $separator = ':') {}

2
zip/zip.php
View File

@ -1034,7 +1034,7 @@ function zip_close ($zip) {}
* @param resource $zip <p>
* A ZIP file previously opened with <b>zip_open</b>.
* </p>
* @return resource a directory entry resource for later use with the
* @return resource|false a directory entry resource for later use with the
* zip_entry_... functions, or <b>FALSE</b> if
* there are no more entries to read, or an error code if an error
* occurred.

4
zlib/zlib.php
View File

@ -410,7 +410,7 @@ function ob_gzhandler ($buffer, $mode) {}
* <b>ZLIB_RLE</b>, <b>ZLIB_FIXED</b> or <b>ZLIB_DEFAULT_STRATEGY</b> (the
* default). <b>dictionary</b>A string or an array of strings of the preset
* dictionary (default: no preset dictionary).</p>
* @return resource <p>
* @return resource|false <p>
* Returns a deflate context resource (zlib.deflate) on success, or
* <b>FALSE</b> on failure.
* </p>
@ -456,7 +456,7 @@ function deflate_add ($context, $data, $flush_mode = ZLIB_SYNC_FLUSH) {}
* <b>ZLIB_RLE</b>, <b>ZLIB_FIXED</b> or <b>ZLIB_DEFAULT_STRATEGY</b> (the
* default). <b>dictionary</b>A string or an array of strings of the preset
* dictionary (default: no preset dictionary).</p>
* @return resource <p>
* @return resource|false <p>
* Returns an inflate context resource (zlib.inflate) on success, or
* <b>FALSE</b> on failure.
* </p>