From 64505ff958f5b40095b03419450e1d079c4f9605 Mon Sep 17 00:00:00 2001 From: Anthony Bedford Date: Tue, 28 Oct 2008 16:52:04 +0000 Subject: [PATCH] Initial version of mysqli function jump table. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@267935 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/mysqli/summary.xml | 700 +++++++++++++++++++++++++++++++++++ 1 file changed, 700 insertions(+) create mode 100755 reference/mysqli/summary.xml diff --git a/reference/mysqli/summary.xml b/reference/mysqli/summary.xml new file mode 100755 index 0000000000..706091eb2b --- /dev/null +++ b/reference/mysqli/summary.xml @@ -0,0 +1,700 @@ + + + + + The MySQLi Extension Function Summary + + + + + + MySQLi Class + + + OOP Interface + Procedural Interface + Alias (Do not use) + Description + + + + + Properties + + + $mysqli->affected_rows + mysqli_affected_rows + N/A + Gets the number of affected rows in a previous MySQL operation + + + $mysqli->connect_errno + mysqli_connect_errno + N/A + Returns the error code from last connect call + + + $mysqli->connect_error + mysqli_connect_error + N/A + Returns a string description of the last connect error + + + $mysqli->errno + mysqli_errno + N/A + Returns the error code for the most recent function call + + + $mysqli->error + mysqli_error + N/A + Returns a string description of the last error + + + $mysqli->field_count + mysqli_field_count + N/A + Returns the number of columns for the most recent query + + + $mysqli->host_info + mysqli_get_host_info + N/A + Returns a string representing the type of connection used + + + $mysqli->protocol_version + mysqli_get_proto_info + N/A + Returns the version of the MySQL protocol used + + + $mysqli->server_info + mysqli_get_server_info + N/A + Returns the version of the MySQL server + + + $mysqli->server_version + mysqli_get_server_version + N/A + Returns the version of the MySQL server as an integer + + + $mysqli->info + mysqli_info + N/A + Retrieves information about the most recently executed query + + + $mysqli->insert_id + mysqli_insert_id + N/A + Returns the auto generated id used in the last query + + + $mysqli->sqlstate + mysqli_sqlstate + N/A + Returns the SQLSTATE error from previous MySQL operation + + + $mysqli->warning_count + mysqli_warning_count + N/A + Returns the number of warnings from the last query for the given link + + + Methods + + + $mysqli->autocommit + mysqli_autocommit + N/A + Turns on or off auto-commiting database modifications + + + $mysqli->change_user + mysqli_change_user + N/A + Changes the user of the specified database connection + + + $mysqli->character_set_name, + $mysqli->client_encoding + mysqli_character_set_name + mysqli_client_encoding + Returns the default character set for the database connection + + + $mysqli->close + mysqli_close + N/A + Closes a previously opened database connection + + + $mysqli->commit + mysqli_commit + N/A + Commits the current transaction + + + mysqli::__construct + mysqli_connect + N/A + Open a new connection to the MySQL server [Note: static (i.e. class) + method] + + + $mysqli->debug + mysqli_debug + N/A + Performs debugging operations + + + $mysqli->dump_debug_info + mysqli_dump_debug_info + N/A + Dump debugging information into the log + + + $mysqli->get_charset + mysqli_get_charset + N/A + Returns a character set object + + + $mysqli->get_client_info + mysqli_get_client_info + N/A + Returns the MySQL client version as a string + + + $mysqli->get_client_version + mysqli_get_client_version + N/A + Get MySQL client info + + + $mysqli->get_connection_stats + mysqli_get_connection_stats + N/A + NOT DOCUMENTED [mysqlnd only] + + + $mysqli->get_server_info + mysqli_get_server_info + N/A + NOT DOCUMENTED + + + $mysqli->get_warnings + mysqli_get_warnings + N/A + NOT DOCUMENTED + + + mysqli_init + mysqli_init + N/A + Initializes MySQLi and returns a resource for use with + mysqli_real_connect. [Not called on an object, as it returns a + $mysqli object.] + + + $mysqli->kill + mysqli_kill + N/A + Asks the server to kill a MySQL thread + + + $mysqli->more_results + mysqli_more_results + N/A + Check if there are any more query results from a multi query + + + $mysqli->multi_query + mysqli_multi_query + N/A + Performs a query on the database + + + $mysqli->next_result + mysqli_next_result + N/A + Prepare next result from multi_query + + + $mysqli->options + mysqli_options + mysqli_set_opt + Set options + + + $mysqli->ping + mysqli_ping + N/A + Pings a server connection, or tries to reconnect if the connection has + gone down + + + $mysqli->prepare + mysqli_prepare + N/A + Prepare a SQL statement for execution + + + $mysqli->query + mysqli_query + N/A + Performs a query on the database + + + $mysqli->real_connect + mysqli_real_connect + N/A + Opens a connection to a mysql server + + + $mysqli->real_escape_string, + $mysqli->escape_string + mysqli_real_escape_string + mysqli_escape_string + Escapes special characters in a string for use in a SQL statement, + taking into account the current charset of the connection + + + $mysqli->real_query + mysqli_real_query + N/A + Execute an SQL query + + + $mysqli->rollback + mysqli_rollback + N/A + Rolls back current transaction + + + $mysqli->select_db + mysqli_select_db + N/A + Selects the default database for database queries + + + $mysqli->set_charset + mysqli_set_charset + N/A + Sets the default client character set + + + $mysqli->set_local_infile_default + mysqli_set_local_infile_default + N/A + Unsets user defined handler for load local infile command + + + $mysqli->set_local_infile_handler + mysqli_set_local_infile_handler + N/A + Set callback function for LOAD DATA LOCAL INFILE command + + + $mysqli->ssl_set + mysqli_ssl_set + N/A + Used for establishing secure connections using SSL + + + $mysqli->stat + mysqli_stat + N/A + Gets the current system status + + + $mysqli->stmt_init + mysqli_stmt_init + N/A + Initializes a statement and returns an object for use with + mysqli_stmt_prepare + + + $mysqli->store_result + mysqli_store_result + N/A + Transfers a result set from the last query + + + $mysqli->thread_id + mysqli_thread_id + N/A + Returns the thread ID for the current connection + + + $mysqli->thread_safe + mysqli_thread_safe + N/A + Returns whether thread safety is given or not + + + $mysqli->use_result + mysqli_use_result + N/A + Initiate a result set retrieval + + + + + + + + + + MySQL_STMT + + + OOP Interface + Procedural Interface + Alias (Do not use) + Description + + + + + Properties + + + $mysqli_stmt->affected_rows + mysqli_stmt_affected_rows + N/A + Returns the total number of rows changed, deleted, or inserted by the + last executed statement + + + $mysqli_stmt->errno + mysqli_stmt_errno + N/A + Returns the error code for the most recent statement call + + + $mysqli_stmt->error + mysqli_stmt_error + N/A + Returns a string description for last statement error + + + $mysqli_stmt->field_count + mysqli_stmt_field_count + N/A + Returns the number of field in the given statement - not documented + + + $mysqli_stmt->insert_id + mysqli_stmt_insert_id + N/A + Get the ID generated from the previous INSERT operation + + + $mysqli_stmt->num_rows + mysqli_stmt_num_rows + N/A + Return the number of rows in statements result set + + + $mysqli_stmt->param_count + mysqli_stmt_param_count + mysqli_param_count + Returns the number of parameter for the given statement + + + $mysqli_stmt->sqlstate + mysqli_stmt_sqlstate + N/A + Returns SQLSTATE error from previous statement operation + + + Methods + + + $mysqli_stmt->attr_get + mysqli_stmt_attr_get + N/A + NOT DOCUMENTED + + + $mysqli_stmt->attr_set + mysqli_stmt_attr_set + N/A + NOT DOCUMENTED + + + $mysqli_stmt->bind_param + mysqli_stmt_bind_param + mysqli_bind_param + Binds variables to a prepared statement as parameters + + + $mysqli_stmt->bind_result + mysqli_stmt_bind_result + mysqli_bind_result + Binds variables to a prepared statement for result storage + + + $mysqli_stmt->close + mysqli_stmt_close + N/A + Closes a prepared statement + + + $mysqli_stmt->data_seek + mysqli_stmt_data_seek + N/A + Seeks to an arbitrary row in statement result set + + + $mysqli_stmt->execute + mysqli_stmt_execute + mysqli_execute + Executes a prepared Query + + + $mysqli_stmt->fetch + mysqli_stmt_fetch + mysqli_fetch + Fetch results from a prepared statement into the bound variables + + + $mysqli_stmt->free_result + mysqli_stmt_free_result + N/A + Frees stored result memory for the given statement handle + + + $mysqli_stmt->get_result + mysqli_stmt_get_result + N/A + NOT DOCUMENTED [mysqlnd only] + + + $mysqli_stmt->get_warnings + mysqli_stmt_get_warnings + N/A + NOT DOCUMENTED + + + $mysqli_stmt->more_results + mysqli_stmt_more_results + N/A + NOT DOCUMENTED [mysqlnd only] + + + $mysqli_stmt->next_result + mysqli_stmt_next_result + N/A + NOT DOCUMENTED [mysqlnd only] + + + $mysqli_stmt->num_rows + mysqli_stmt_num_rows + N/A + NOT DOCUMENTED [see also num_rows property] + + + $mysqli_stmt->prepare + mysqli_stmt_prepare + N/A + Prepare a SQL statement for execution + + + $mysqli_stmt->reset + mysqli_stmt_reset + N/A + Resets a prepared statement + + + $mysqli_stmt->result_metadata + mysqli_stmt_result_metadata + mysqli_get_metadata + Returns result set metadata from a prepared statement + + + $mysqli_stmt->send_long_data + mysqli_stmt_send_long_data + mysqli_send_long_data + Send data in blocks + + + $mysqli_stmt->store_result + mysqli_stmt_store_result + N/A + Transfers a result set from a prepared statement + + + + + + + + + + MySQLi_RESULT + + + OOP Interface + Procedural Interface + Alias (Do not use) + Description + + + + + Properties + + + $mysqli_result->current_field + mysqli_field_tell + N/A + Get current field offset of a result pointer + + + $mysqli_result->field_count + mysqli_num_fields + N/A + Get the number of fields in a result + + + $mysqli_result->lengths + mysqli_fetch_lengths + N/A + Returns the lengths of the columns of the current row in the result set + + + $mysqli_result->num_rows + mysqli_num_rows + N/A + Gets the number of rows in a result + + + Methods + + + $mysqli_result->data_seek + mysqli_data_seek + N/A + Adjusts the result pointer to an arbitary row in the result + + + $mysqli_result->fetch_all + mysqli_fetch_all + N/A + NOT DOCUMENTED [mysqlnd only] + + + $mysqli_result->fetch_array + mysqli_fetch_array + N/A + Fetch a result row as an associative, a numeric array, or both + + + $mysqli_result->fetch_assoc + mysqli_fetch_assoc + N/A + Fetch a result row as an associative array + + + $mysqli_result->fetch_field_direct + mysqli_fetch_field_direct + N/A + Fetch meta-data for a single field + + + $mysqli_result->fetch_field + mysqli_fetch_field + N/A + Returns the next field in the result set + + + $mysqli_result->fetch_fields + mysqli_fetch_fields + N/A + Returns an array of objects representing the fields in a result set + + + $mysqli_result->fetch_object + mysqli_fetch_object + N/A + Returns the current row of a result set as an object + + + $mysqli_result->fetch_row + mysqli_fetch_row + N/A + Get a result row as an enumerated array + + + $mysqli_result->field_seek + mysqli_field_seek + N/A + Set result pointer to a specified field offset + + + $mysqli_result->free, + $mysqli_result->close, + $mysqli_result->free_result + mysqli_free_result + N/A + Frees the memory associated with a result + + + + + + + + + + MySQL_Driver + + + OOP Interface + Procedural Interface + Alias (Do not use) + Description + + + + + Properties + + + N/A + + + Methods + + + $mysqli_driver->embedded_server_end + mysqli_embedded_server_end + N/A + NOT DOCUMENTED + + + $mysqli_driver->embedded_server_start + mysqli_embedded_server_start + N/A + NOT DOCUMENTED + + + + + + + + Alias functions are provided for backward compatibility purposes + only. Do not use them in new projects. + + + +