cvs: phpdoc /en/reference/mysqli summary.xml
| From: | Anthony Bedford | Date: | Wed, 29 Oct 2008 14:18:15 +0000 |
| Subject: | cvs: phpdoc /en/reference/mysqli summary.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-2334@lists.php.net to get a copy of this message | ||
abedford Wed Oct 29 14:18:15 2008 UTC
Modified files:
/phpdoc/en/reference/mysqli summary.xml
Log:
Replaced link tag with methodname tag for methods
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mysqli/summary.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/mysqli/summary.xml diff -u phpdoc/en/reference/mysqli/summary.xml:1.1 phpdoc/en/reference/mysqli/summary.xml:1.2 --- phpdoc/en/reference/mysqli/summary.xml:1.1 Tue Oct 28 16:52:04 2008 +++ phpdoc/en/reference/mysqli/summary.xml Wed Oct 29 14:18:15 2008 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <chapter xml:id="mysqli.summary" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <title>The MySQLi Extension Function Summary</title> @@ -109,93 +109,93 @@ <entry><emphasis role="bold">Methods</emphasis></entry> </row> <row> - <entry><link linkend="mysqli.autocommit">$mysqli->autocommit</link></entry> + <entry><methodname>mysqli->autocommit</methodname></entry> <entry><function>mysqli_autocommit</function></entry> <entry>N/A</entry> <entry>Turns on or off auto-commiting database modifications</entry> </row> <row> - <entry><link linkend="mysqli.change-user">$mysqli->change_user</link></entry> + <entry><methodname>mysqli->change_user</methodname></entry> <entry><function>mysqli_change_user</function></entry> <entry>N/A</entry> <entry>Changes the user of the specified database connection</entry> </row> <row> - <entry><link linkend="mysqli.character-set-name">$mysqli->character_set_name, - $mysqli->client_encoding</link></entry> + <entry><methodname>mysqli->character_set_name</methodname>,<link linkend="mysqli.character-set-name"> + mysqli->client_encoding</link></entry> <entry><function>mysqli_character_set_name</function></entry> <entry><function>mysqli_client_encoding</function></entry> <entry>Returns the default character set for the database connection</entry> </row> <row> - <entry><link linkend="mysqli.close">$mysqli->close</link></entry> + <entry><methodname>mysqli->close</methodname></entry> <entry><function>mysqli_close</function></entry> <entry>N/A</entry> <entry>Closes a previously opened database connection</entry> </row> <row> - <entry><link linkend="mysqli.commit">$mysqli->commit</link></entry> + <entry><methodname>mysqli->commit</methodname></entry> <entry><function>mysqli_commit</function></entry> <entry>N/A</entry> <entry>Commits the current transaction</entry> </row> <row> - <entry><link linkend="mysqli.connect">mysqli::__construct</link></entry> + <entry><methodname>mysqli::__construct</methodname></entry> <entry><function>mysqli_connect</function></entry> <entry>N/A</entry> <entry>Open a new connection to the MySQL server [Note: static (i.e. class) method]</entry> </row> <row> - <entry><link linkend="mysqli.debug">$mysqli->debug</link></entry> + <entry><methodname>mysqli->debug</methodname></entry> <entry><function>mysqli_debug</function></entry> <entry>N/A</entry> <entry>Performs debugging operations</entry> </row> <row> - <entry><link linkend="mysqli.dump-debug-info">$mysqli->dump_debug_info</link></entry> + <entry><methodname>mysqli->dump_debug_info</methodname></entry> <entry><function>mysqli_dump_debug_info</function></entry> <entry>N/A</entry> <entry>Dump debugging information into the log</entry> </row> <row> - <entry><link linkend="mysqli.get-charset">$mysqli->get_charset</link></entry> + <entry><methodname>mysqli->get_charset</methodname></entry> <entry><function>mysqli_get_charset</function></entry> <entry>N/A</entry> <entry>Returns a character set object</entry> </row> <row> - <entry><link linkend="mysqli.get-client-info">$mysqli->get_client_info</link></entry> + <entry><methodname>mysqli->get_client_info</methodname></entry> <entry><function>mysqli_get_client_info</function></entry> <entry>N/A</entry> <entry>Returns the MySQL client version as a string</entry> </row> <row> - <entry><link linkend="mysqli.get-client-version">$mysqli->get_client_version</link></entry> + <entry><methodname>mysqli->get_client_version</methodname></entry> <entry><function>mysqli_get_client_version</function></entry> <entry>N/A</entry> <entry>Get MySQL client info</entry> </row> <row> - <entry>$mysqli->get_connection_stats</entry> - <entry>mysqli_get_connection_stats</entry> + <entry>$mysqli->get_connection_stats()</entry> + <entry>mysqli_get_connection_stats()</entry> <entry>N/A</entry> <entry>NOT DOCUMENTED [mysqlnd only]</entry> </row> <row> - <entry><link linkend="mysqli.get-server-info">$mysqli->get_server_info</link></entry> + <entry><methodname>mysqli->get_server_info</methodname></entry> <entry><function>mysqli_get_server_info</function></entry> <entry>N/A</entry> <entry>NOT DOCUMENTED</entry> </row> <row> - <entry><link linkend="mysqli.get-warnings">$mysqli->get_warnings</link></entry> + <entry><methodname>mysqli->get_warnings</methodname></entry> <entry><function>mysqli_get_warnings</function></entry> <entry>N/A</entry> <entry>NOT DOCUMENTED</entry> </row> <row> - <entry><link linkend="mysqli.init">mysqli_init</link></entry> + <entry><methodname>mysqli_init</methodname></entry> <entry><function>mysqli_init</function></entry> <entry>N/A</entry> <entry>Initializes MySQLi and returns a resource for use with @@ -203,143 +203,143 @@ $mysqli object.]</entry> </row> <row> - <entry><link linkend="mysqli.kill">$mysqli->kill</link></entry> + <entry><methodname>mysqli->kill</methodname></entry> <entry><function>mysqli_kill</function></entry> <entry>N/A</entry> <entry>Asks the server to kill a MySQL thread</entry> </row> <row> - <entry><link linkend="mysqli.more-results">$mysqli->more_results</link></entry> + <entry><methodname>mysqli->more_results</methodname></entry> <entry><function>mysqli_more_results</function></entry> <entry>N/A</entry> <entry>Check if there are any more query results from a multi query</entry> </row> <row> - <entry><link linkend="mysqli.multi-query">$mysqli->multi_query</link></entry> + <entry><methodname>mysqli->multi_query</methodname></entry> <entry><function>mysqli_multi_query</function></entry> <entry>N/A</entry> <entry>Performs a query on the database</entry> </row> <row> - <entry><link linkend="mysqli.next-result">$mysqli->next_result</link></entry> + <entry><methodname>mysqli->next_result</methodname></entry> <entry><function>mysqli_next_result</function></entry> <entry>N/A</entry> <entry>Prepare next result from multi_query</entry> </row> <row> - <entry><link linkend="mysqli.options">$mysqli->options</link></entry> + <entry><methodname>mysqli->options</methodname></entry> <entry><function>mysqli_options</function></entry> <entry><function>mysqli_set_opt</function></entry> <entry>Set options</entry> </row> <row> - <entry><link linkend="mysqli.ping">$mysqli->ping</link></entry> + <entry><methodname>mysqli->ping</methodname></entry> <entry><function>mysqli_ping</function></entry> <entry>N/A</entry> <entry>Pings a server connection, or tries to reconnect if the connection has gone down</entry> </row> <row> - <entry><link linkend="mysqli.prepare">$mysqli->prepare</link></entry> + <entry><methodname>mysqli->prepare</methodname></entry> <entry><function>mysqli_prepare</function></entry> <entry>N/A</entry> <entry>Prepare a SQL statement for execution</entry> </row> <row> - <entry><link linkend="mysqli.query">$mysqli->query</link></entry> + <entry><methodname>mysqli->query</methodname></entry> <entry><function>mysqli_query</function></entry> <entry>N/A</entry> <entry>Performs a query on the database</entry> </row> <row> - <entry><link linkend="mysqli.real-connect">$mysqli->real_connect</link></entry> + <entry><methodname>mysqli->real_connect</methodname></entry> <entry><function>mysqli_real_connect</function></entry> <entry>N/A</entry> <entry>Opens a connection to a mysql server</entry> </row> <row> - <entry><link linkend="mysqli.real-escape-string">$mysqli->real_escape_string</link>, - <link linkend="mysqli.real-escape-string">$mysqli->escape_string</link></entry> + <entry><methodname>mysqli->real_escape_string</methodname>, + <methodname>mysqli->escape_string</methodname></entry> <entry><function>mysqli_real_escape_string</function></entry> <entry><function>mysqli_escape_string</function></entry> <entry>Escapes special characters in a string for use in a SQL statement, taking into account the current charset of the connection</entry> </row> <row> - <entry><link linkend="mysqli.real-query">$mysqli->real_query</link></entry> + <entry><methodname>mysqli->real_query</methodname></entry> <entry><function>mysqli_real_query</function></entry> <entry>N/A</entry> <entry>Execute an SQL query</entry> </row> <row> - <entry><link linkend="mysqli.rollback">$mysqli->rollback</link></entry> + <entry><methodname>mysqli->rollback</methodname></entry> <entry><function>mysqli_rollback</function></entry> <entry>N/A</entry> <entry>Rolls back current transaction</entry> </row> <row> - <entry><link linkend="mysqli.select-db">$mysqli->select_db</link></entry> + <entry><methodname>mysqli->select_db</methodname></entry> <entry><function>mysqli_select_db</function></entry> <entry>N/A</entry> <entry>Selects the default database for database queries</entry> </row> <row> - <entry><link linkend="mysqli.set-charset">$mysqli->set_charset</link></entry> + <entry><methodname>mysqli->set_charset</methodname></entry> <entry><function>mysqli_set_charset</function></entry> <entry>N/A</entry> <entry>Sets the default client character set</entry> </row> <row> - <entry><link linkend="mysqli.set-local-infile-default">$mysqli->set_local_infile_default</link></entry> + <entry><methodname>mysqli->set_local_infile_default</methodname></entry> <entry><function>mysqli_set_local_infile_default</function></entry> <entry>N/A</entry> <entry>Unsets user defined handler for load local infile command</entry> </row> <row> - <entry><link linkend="mysqli.set-local-infile-handler">$mysqli->set_local_infile_handler</link></entry> + <entry><methodname>mysqli->set_local_infile_handler</methodname></entry> <entry><function>mysqli_set_local_infile_handler</function></entry> <entry>N/A</entry> <entry>Set callback function for LOAD DATA LOCAL INFILE command</entry> </row> <row> - <entry><link linkend="mysqli.ssl-set">$mysqli->ssl_set</link></entry> + <entry><methodname>mysqli->ssl_set</methodname></entry> <entry><function>mysqli_ssl_set</function></entry> <entry>N/A</entry> <entry>Used for establishing secure connections using SSL</entry> </row> <row> - <entry><link linkend="mysqli.stat">$mysqli->stat</link></entry> + <entry><methodname>mysqli->stat</methodname></entry> <entry><function>mysqli_stat</function></entry> <entry>N/A</entry> <entry>Gets the current system status</entry> </row> <row> - <entry><link linkend="mysqli.stmt-init">$mysqli->stmt_init</link></entry> + <entry><methodname>mysqli->stmt_init</methodname></entry> <entry><function>mysqli_stmt_init</function></entry> <entry>N/A</entry> <entry>Initializes a statement and returns an object for use with mysqli_stmt_prepare</entry> </row> <row> - <entry><link linkend="mysqli.store-result">$mysqli->store_result</link></entry> + <entry><methodname>mysqli->store_result</methodname></entry> <entry><function>mysqli_store_result</function></entry> <entry>N/A</entry> <entry>Transfers a result set from the last query</entry> </row> <row> - <entry><link linkend="mysqli.thread-id">$mysqli->thread_id</link></entry> + <entry><methodname>mysqli->thread_id</methodname></entry> <entry><function>mysqli_thread_id</function></entry> <entry>N/A</entry> <entry>Returns the thread ID for the current connection</entry> </row> <row> - <entry><link linkend="mysqli.thread-safe">$mysqli->thread_safe</link></entry> + <entry><methodname>mysqli->thread_safe</methodname></entry> <entry><function>mysqli_thread_safe</function></entry> <entry>N/A</entry> <entry>Returns whether thread safety is given or not</entry> </row> <row> - <entry><link linkend="mysqli.use-result">$mysqli->use_result</link></entry> + <entry><methodname>mysqli->use_result</methodname></entry> <entry><function>mysqli_use_result</function></entry> <entry>N/A</entry> <entry>Initiate a result set retrieval</entry> @@ -418,115 +418,115 @@ <entry><emphasis role="bold">Methods</emphasis></entry> </row> <row> - <entry><link linkend="mysqli-stmt.attr-get">$mysqli_stmt->attr_get</link></entry> + <entry><methodname>mysqli_stmt->attr_get</methodname></entry> <entry><function>mysqli_stmt_attr_get</function></entry> <entry>N/A</entry> <entry>NOT DOCUMENTED</entry> </row> <row> - <entry><link linkend="mysqli-stmt.attr-set">$mysqli_stmt->attr_set</link></entry> + <entry><methodname>mysqli_stmt->attr_set</methodname></entry> <entry><function>mysqli_stmt_attr_set</function></entry> <entry>N/A</entry> <entry>NOT DOCUMENTED</entry> </row> <row> - <entry><link linkend="mysqli-stmt.bind-param">$mysqli_stmt->bind_param</link></entry> + <entry><methodname>mysqli_stmt->bind_param</methodname></entry> <entry><function>mysqli_stmt_bind_param</function></entry> <entry><function>mysqli_bind_param</function></entry> <entry>Binds variables to a prepared statement as parameters</entry> </row> <row> - <entry><link linkend="mysqli-stmt.bind-result">$mysqli_stmt->bind_result</link></entry> + <entry><methodname>mysqli_stmt->bind_result</methodname></entry> <entry><function>mysqli_stmt_bind_result</function></entry> <entry><function>mysqli_bind_result</function></entry> <entry>Binds variables to a prepared statement for result storage</entry> </row> <row> - <entry><link linkend="mysqli-stmt.close">$mysqli_stmt->close</link></entry> + <entry><methodname>mysqli_stmt->close</methodname></entry> <entry><function>mysqli_stmt_close</function></entry> <entry>N/A</entry> <entry>Closes a prepared statement</entry> </row> <row> - <entry><link linkend="mysqli-stmt.data-seek">$mysqli_stmt->data_seek</link></entry> + <entry><methodname>mysqli_stmt->data_seek</methodname></entry> <entry><function>mysqli_stmt_data_seek</function></entry> <entry>N/A</entry> <entry>Seeks to an arbitrary row in statement result set</entry> </row> <row> - <entry><link linkend="mysqli-stmt.execute">$mysqli_stmt->execute</link></entry> + <entry><methodname>mysqli_stmt->execute</methodname></entry> <entry><function>mysqli_stmt_execute</function></entry> <entry><function>mysqli_execute</function></entry> <entry>Executes a prepared Query</entry> </row> <row> - <entry><link linkend="mysqli-stmt.fetch">$mysqli_stmt->fetch</link></entry> + <entry><methodname>mysqli_stmt->fetch</methodname></entry> <entry><function>mysqli_stmt_fetch</function></entry> <entry><function>mysqli_fetch</function></entry> <entry>Fetch results from a prepared statement into the bound variables</entry> </row> <row> - <entry><link linkend="mysqli-stmt.free-result">$mysqli_stmt->free_result</link></entry> + <entry><methodname>mysqli_stmt->free_result</methodname></entry> <entry><function>mysqli_stmt_free_result</function></entry> <entry>N/A</entry> <entry>Frees stored result memory for the given statement handle</entry> </row> <row> - <entry>$mysqli_stmt->get_result</entry> + <entry>$mysqli_stmt->get_result()</entry> <entry>mysqli_stmt_get_result</entry> <entry>N/A</entry> <entry>NOT DOCUMENTED [mysqlnd only]</entry> </row> <row> - <entry><link linkend="mysqli-stmt.get-warnings">$mysqli_stmt->get_warnings</link></entry> + <entry><methodname>mysqli_stmt->get_warnings</methodname></entry> <entry><function>mysqli_stmt_get_warnings</function></entry> <entry>N/A</entry> <entry>NOT DOCUMENTED</entry> </row> <row> - <entry>$mysqli_stmt->more_results</entry> - <entry>mysqli_stmt_more_results</entry> + <entry>$mysqli_stmt->more_results()</entry> + <entry>mysqli_stmt_more_results()</entry> <entry>N/A</entry> <entry>NOT DOCUMENTED [mysqlnd only]</entry> </row> <row> - <entry>$mysqli_stmt->next_result</entry> - <entry>mysqli_stmt_next_result</entry> + <entry>$mysqli_stmt->next_result()</entry> + <entry>mysqli_stmt_next_result()</entry> <entry>N/A</entry> <entry>NOT DOCUMENTED [mysqlnd only]</entry> </row> <row> - <entry><link linkend="mysqli-stmt.num-rows">$mysqli_stmt->num_rows</link></entry> + <entry><methodname>mysqli_stmt->num_rows</methodname></entry> <entry><function>mysqli_stmt_num_rows</function></entry> <entry>N/A</entry> <entry>NOT DOCUMENTED [see also num_rows property]</entry> </row> <row> - <entry><link linkend="mysqli-stmt.prepare">$mysqli_stmt->prepare</link></entry> + <entry><methodname>mysqli_stmt->prepare</methodname></entry> <entry><function>mysqli_stmt_prepare</function></entry> <entry>N/A</entry> <entry>Prepare a SQL statement for execution</entry> </row> <row> - <entry><link linkend="mysqli-stmt.reset">$mysqli_stmt->reset</link></entry> + <entry><methodname>mysqli_stmt->reset</methodname></entry> <entry><function>mysqli_stmt_reset</function></entry> <entry>N/A</entry> <entry>Resets a prepared statement</entry> </row> <row> - <entry><link linkend="mysqli-stmt.result-metadata">$mysqli_stmt->result_metadata</link></entry> + <entry><methodname>mysqli_stmt->result_metadata</methodname></entry> <entry><function>mysqli_stmt_result_metadata</function></entry> <entry><function>mysqli_get_metadata</function></entry> <entry>Returns result set metadata from a prepared statement</entry> </row> <row> - <entry><link linkend="mysqli-stmt.send-long-data">$mysqli_stmt->send_long_data</link></entry> + <entry><methodname>mysqli_stmt->send_long_data</methodname></entry> <entry><function>mysqli_stmt_send_long_data</function></entry> <entry><function>mysqli_send_long_data</function></entry> <entry>Send data in blocks</entry> </row> <row> - <entry><link linkend="mysqli-stmt.store-result">$mysqli_stmt->store_result</link></entry> + <entry><methodname>mysqli_stmt->store_result</methodname></entry> <entry><function>mysqli_stmt_store_result</function></entry> <entry>N/A</entry> <entry>Transfers a result set from a prepared statement</entry> @@ -580,69 +580,69 @@ <entry><emphasis role="bold">Methods</emphasis></entry> </row> <row> - <entry><link linkend="mysqli-result.data-seek">$mysqli_result->data_seek</link></entry> + <entry><methodname>mysqli_result->data_seek</methodname></entry> <entry><function>mysqli_data_seek</function></entry> <entry>N/A</entry> <entry>Adjusts the result pointer to an arbitary row in the result</entry> </row> <row> - <entry>$mysqli_result->fetch_all</entry> - <entry>mysqli_fetch_all</entry> + <entry>$mysqli_result->fetch_all()</entry> + <entry>mysqli_fetch_all()</entry> <entry>N/A</entry> <entry>NOT DOCUMENTED [mysqlnd only]</entry> </row> <row> - <entry><link linkend="mysqli-result.fetch-array">$mysqli_result->fetch_array</link></entry> + <entry><methodname>mysqli_result->fetch_array</methodname></entry> <entry><function>mysqli_fetch_array</function></entry> <entry>N/A</entry> <entry>Fetch a result row as an associative, a numeric array, or both</entry> </row> <row> - <entry><link linkend="mysqli-result.fetch-assoc">$mysqli_result->fetch_assoc</link></entry> + <entry><methodname>mysqli_result->fetch_assoc</methodname></entry> <entry><function>mysqli_fetch_assoc</function></entry> <entry>N/A</entry> <entry>Fetch a result row as an associative array</entry> </row> <row> - <entry><link linkend="mysqli-result.fetch-field-direct">$mysqli_result->fetch_field_direct</link></entry> + <entry><methodname>mysqli_result->fetch_field_direct</methodname></entry> <entry><function>mysqli_fetch_field_direct</function></entry> <entry>N/A</entry> <entry>Fetch meta-data for a single field</entry> </row> <row> - <entry><link linkend="mysqli-result.fetch-field">$mysqli_result->fetch_field</link></entry> + <entry><methodname>mysqli_result->fetch_field</methodname></entry> <entry><function>mysqli_fetch_field</function></entry> <entry>N/A</entry> <entry>Returns the next field in the result set</entry> </row> <row> - <entry><link linkend="mysqli-result.fetch-fields">$mysqli_result->fetch_fields</link></entry> + <entry><methodname>mysqli_result->fetch_fields</methodname></entry> <entry><function>mysqli_fetch_fields</function></entry> <entry>N/A</entry> <entry>Returns an array of objects representing the fields in a result set</entry> </row> <row> - <entry><link linkend="mysqli-result.fetch-object">$mysqli_result->fetch_object</link></entry> + <entry><methodname>mysqli_result->fetch_object</methodname></entry> <entry><function>mysqli_fetch_object</function></entry> <entry>N/A</entry> <entry>Returns the current row of a result set as an object</entry> </row> <row> - <entry><link linkend="mysqli-result.fetch-row">$mysqli_result->fetch_row</link></entry> + <entry><methodname>mysqli_result->fetch_row</methodname></entry> <entry><function>mysqli_fetch_row</function></entry> <entry>N/A</entry> <entry>Get a result row as an enumerated array</entry> </row> <row> - <entry><link linkend="mysqli-result.field-seek">$mysqli_result->field_seek</link></entry> + <entry><methodname>mysqli_result->field_seek</methodname></entry> <entry><function>mysqli_field_seek</function></entry> <entry>N/A</entry> <entry>Set result pointer to a specified field offset</entry> </row> <row> - <entry><link linkend="mysqli-result.free">$mysqli_result->free</link>, - <link linkend="mysqli-result.free">$mysqli_result->close</link>, - <link linkend="mysqli-result.free">$mysqli_result->free_result</link></entry> + <entry><methodname>mysqli_result->free</methodname>, + <link linkend="mysqli-result.free">mysqli_result->close</link>, + <link linkend="mysqli-result.free">mysqli_result->free_result</link></entry> <entry><function>mysqli_free_result</function></entry> <entry>N/A</entry> <entry>Frees the memory associated with a result</entry> @@ -675,13 +675,13 @@ <entry><emphasis role="bold">Methods</emphasis></entry> </row> <row> - <entry><link linkend="mysqli-driver.embedded-server-end">$mysqli_driver->embedded_server_end</link></entry> + <entry><methodname>mysqli_driver->embedded_server_end</methodname></entry> <entry><function>mysqli_embedded_server_end</function></entry> <entry>N/A</entry> <entry>NOT DOCUMENTED</entry> </row> <row> - <entry><link linkend="mysqli-driver.embedded-server-start">$mysqli_driver->embedded_server_start</link></entry> + <entry><methodname>mysqli_driver->embedded_server_start</methodname></entry> <entry><function>mysqli_embedded_server_start</function></entry> <entry>N/A</entry> <entry>NOT DOCUMENTED</entry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mysqli/summary.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/mysqli/summary.xml diff -u phpdoc/en/reference/mysqli/summary.xml:1.1 phpdoc/en/reference/mysqli/summary.xml:1.2 --- phpdoc/en/reference/mysqli/summary.xml:1.1 Tue Oct 28 16:52:04 2008 +++ phpdoc/en/reference/mysqli/summary.xml Wed Oct 29 14:18:15 2008 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <chapter xml:id="mysqli.summary" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <title>The MySQLi Extension Function Summary</title> @@ -109,93 +109,93 @@ <entry><emphasis role="bold">Methods</emphasis></entry> </row> <row> - <entry><link linkend="mysqli.autocommit">$mysqli->autocommit</link></entry> + <entry><methodname>mysqli->autocommit</methodname></entry> <entry><function>mysqli_autocommit</function></entry> <entry>N/A</entry> <entry>Turns on or off auto-commiting database modifications</entry> </row> <row> - <entry><link linkend="mysqli.change-user">$mysqli->change_user</link></entry> + <entry><methodname>mysqli->change_user</methodname></entry> <entry><function>mysqli_change_user</function></entry> <entry>N/A</entry> <entry>Changes the user of the specified database connection</entry> </row> <row> - <entry><link linkend="mysqli.character-set-name">$mysqli->character_set_name, - $mysqli->client_encoding</link></entry> + <entry><methodname>mysqli->character_set_name</methodname>,<link linkend="mysqli.character-set-name"> + mysqli->client_encoding</link></entry> <entry><function>mysqli_character_set_name</function></entry> <entry><function>mysqli_client_encoding</function></entry> <entry>Returns the default character set for the database connection</entry> </row> <row> - <entry><link linkend="mysqli.close">$mysqli->close</link></entry> + <entry><methodname>mysqli->close</methodname></entry> <entry><function>mysqli_close</function></entry> <entry>N/A</entry> <entry>Closes a previously opened database connection</entry> </row> <row> - <entry><link linkend="mysqli.commit">$mysqli->commit</link></entry> + <entry><methodname>mysqli->commit</methodname></entry> <entry><function>mysqli_commit</function></entry> <entry>N/A</entry> <entry>Commits the current transaction</entry> </row> <row> - <entry><link linkend="mysqli.connect">mysqli::__construct</link></entry> + <entry><methodname>mysqli::__construct</methodname></entry> <entry><function>mysqli_connect</function></entry> <entry>N/A</entry> <entry>Open a new connection to the MySQL server [Note: static (i.e. class) method]</entry> </row> <row> - <entry><link linkend="mysqli.debug">$mysqli->debug</link></entry> + <entry><methodname>mysqli->debug</methodname></entry> <entry><function>mysqli_debug</function></entry> <entry>N/A</entry> <entry>Performs debugging operations</entry> </row> <row> - <entry><link linkend="mysqli.dump-debug-info">$mysqli->dump_debug_info</link></entry> + <entry><methodname>mysqli->dump_debug_info</methodname></entry> <entry><function>mysqli_dump_debug_info</function></entry> <entry>N/A</entry> <entry>Dump debugging information into the log</entry> </row> <row> - <entry><link linkend="mysqli.get-charset">$mysqli->get_charset</link></entry> + <entry><methodname>mysqli->get_charset</methodname></entry> <entry><function>mysqli_get_charset</function></entry> <entry>N/A</entry> <entry>Returns a character set object</entry> </row> <row> - <entry><link linkend="mysqli.get-client-info">$mysqli->get_client_info</link></entry> + <entry><methodname>mysqli->get_client_info</methodname></entry> <entry><function>mysqli_get_client_info</function></entry> <entry>N/A</entry> <entry>Returns the MySQL client version as a string</entry> </row> <row> - <entry><link linkend="mysqli.get-client-version">$mysqli->get_client_version</link></entry> + <entry><methodname>mysqli->get_client_version</methodname></entry> <entry><function>mysqli_get_client_version</function></entry> <entry>N/A</entry> <entry>Get MySQL client info</entry> </row> <row> - <entry>$mysqli->get_connection_stats</entry> - <entry>mysqli_get_connection_stats</entry> + <entry>$mysqli->get_connection_stats()</entry> + <entry>mysqli_get_connection_stats()</entry> <entry>N/A</entry> <entry>NOT DOCUMENTED [mysqlnd only]</entry> </row> <row> - <entry><link linkend="mysqli.get-server-info">$mysqli->get_server_info</link></entry> + <entry><methodname>mysqli->get_server_info</methodname></entry> <entry><function>mysqli_get_server_info</function></entry> <entry>N/A</entry> <entry>NOT DOCUMENTED</entry> </row> <row> - <entry><link linkend="mysqli.get-warnings">$mysqli->get_warnings</link></entry> + <entry><methodname>mysqli->get_warnings</methodname></entry> <entry><function>mysqli_get_warnings</function></entry> <entry>N/A</entry> <entry>NOT DOCUMENTED</entry> </row> <row> - <entry><link linkend="mysqli.init">mysqli_init</link></entry> + <entry><methodname>mysqli_init</methodname></entry> <entry><function>mysqli_init</function></entry> <entry>N/A</entry> <entry>Initializes MySQLi and returns a resource for use with @@ -203,143 +203,143 @@ $mysqli object.]</entry> </row> <row> - <entry><link linkend="mysqli.kill">$mysqli->kill</link></entry> + <entry><methodname>mysqli->kill</methodname></entry> <entry><function>mysqli_kill</function></entry> <entry>N/A</entry> <entry>Asks the server to kill a MySQL thread</entry> </row> <row> - <entry><link linkend="mysqli.more-results">$mysqli->more_results</link></entry> + <entry><methodname>mysqli->more_results</methodname></entry> <entry><function>mysqli_more_results</function></entry> <entry>N/A</entry> <entry>Check if there are any more query results from a multi query</entry> </row> <row> - <entry><link linkend="mysqli.multi-query">$mysqli->multi_query</link></entry> + <entry><methodname>mysqli->multi_query</methodname></entry> <entry><function>mysqli_multi_query</function></entry> <entry>N/A</entry> <entry>Performs a query on the database</entry> </row> <row> - <entry><link linkend="mysqli.next-result">$mysqli->next_result</link></entry> + <entry><methodname>mysqli->next_result</methodname></entry> <entry><function>mysqli_next_result</function></entry> <entry>N/A</entry> <entry>Prepare next result from multi_query</entry> </row> <row> - <entry><link linkend="mysqli.options">$mysqli->options</link></entry> + <entry><methodname>mysqli->options</methodname></entry> <entry><function>mysqli_options</function></entry> <entry><function>mysqli_set_opt</function></entry> <entry>Set options</entry> </row> <row> - <entry><link linkend="mysqli.ping">$mysqli->ping</link></entry> + <entry><methodname>mysqli->ping</methodname></entry> <entry><function>mysqli_ping</function></entry> <entry>N/A</entry> <entry>Pings a server connection, or tries to reconnect if the connection has gone down</entry> </row> <row> - <entry><link linkend="mysqli.prepare">$mysqli->prepare</link></entry> + <entry><methodname>mysqli->prepare</methodname></entry> <entry><function>mysqli_prepare</function></entry> <entry>N/A</entry> <entry>Prepare a SQL statement for execution</entry> </row> <row> - <entry><link linkend="mysqli.query">$mysqli->query</link></entry> + <entry><methodname>mysqli->query</methodname></entry> <entry><function>mysqli_query</function></entry> <entry>N/A</entry> <entry>Performs a query on the database</entry> </row> <row> - <entry><link linkend="mysqli.real-connect">$mysqli->real_connect</link></entry> + <entry><methodname>mysqli->real_connect</methodname></entry> <entry><function>mysqli_real_connect</function></entry> <entry>N/A</entry> <entry>Opens a connection to a mysql server</entry> </row> <row> - <entry><link linkend="mysqli.real-escape-string">$mysqli->real_escape_string</link>, - <link linkend="mysqli.real-escape-string">$mysqli->escape_string</link></entry> + <entry><methodname>mysqli->real_escape_string</methodname>, + <methodname>mysqli->escape_string</methodname></entry> <entry><function>mysqli_real_escape_string</function></entry> <entry><function>mysqli_escape_string</function></entry> <entry>Escapes special characters in a string for use in a SQL statement, taking into account the current charset of the connection</entry> </row> <row> - <entry><link linkend="mysqli.real-query">$mysqli->real_query</link></entry> + <entry><methodname>mysqli->real_query</methodname></entry> <entry><function>mysqli_real_query</function></entry> <entry>N/A</entry> <entry>Execute an SQL query</entry> </row> <row> - <entry><link linkend="mysqli.rollback">$mysqli->rollback</link></entry> + <entry><methodname>mysqli->rollback</methodname></entry> <entry><function>mysqli_rollback</function></entry> <entry>N/A</entry> <entry>Rolls back current transaction</entry> </row> <row> - <entry><link linkend="mysqli.select-db">$mysqli->select_db</link></entry> + <entry><methodname>mysqli->select_db</methodname></entry> <entry><function>mysqli_select_db</function></entry> <entry>N/A</entry> <entry>Selects the default database for database queries</entry> </row> <row> - <entry><link linkend="mysqli.set-charset">$mysqli->set_charset</link></entry> + <entry><methodname>mysqli->set_charset</methodname></entry> <entry><function>mysqli_set_charset</function></entry> <entry>N/A</entry> <entry>Sets the default client character set</entry> </row> <row> - <entry><link linkend="mysqli.set-local-infile-default">$mysqli->set_local_infile_default</link></entry> + <entry><methodname>mysqli->set_local_infile_default</methodname></entry> <entry><function>mysqli_set_local_infile_default</function></entry> <entry>N/A</entry> <entry>Unsets user defined handler for load local infile command</entry> </row> <row> - <entry><link linkend="mysqli.set-local-infile-handler">$mysqli->set_local_infile_handler</link></entry> + <entry><methodname>mysqli->set_local_infile_handler</methodname></entry> <entry><function>mysqli_set_local_infile_handler</function></entry> <entry>N/A</entry> <entry>Set callback function for LOAD DATA LOCAL INFILE command</entry> </row> <row> - <entry><link linkend="mysqli.ssl-set">$mysqli->ssl_set</link></entry> + <entry><methodname>mysqli->ssl_set</methodname></entry> <entry><function>mysqli_ssl_set</function></entry> <entry>N/A</entry> <entry>Used for establishing secure connections using SSL</entry> </row> <row> - <entry><link linkend="mysqli.stat">$mysqli->stat</link></entry> + <entry><methodname>mysqli->stat</methodname></entry> <entry><function>mysqli_stat</function></entry> <entry>N/A</entry> <entry>Gets the current system status</entry> </row> <row> - <entry><link linkend="mysqli.stmt-init">$mysqli->stmt_init</link></entry> + <entry><methodname>mysqli->stmt_init</methodname></entry> <entry><function>mysqli_stmt_init</function></entry> <entry>N/A</entry> <entry>Initializes a statement and returns an object for use with mysqli_stmt_prepare</entry> </row> <row> - <entry><link linkend="mysqli.store-result">$mysqli->store_result</link></entry> + <entry><methodname>mysqli->store_result</methodname></entry> <entry><function>mysqli_store_result</function></entry> <entry>N/A</entry> <entry>Transfers a result set from the last query</entry> </row> <row> - <entry><link linkend="mysqli.thread-id">$mysqli->thread_id</link></entry> + <entry><methodname>mysqli->thread_id</methodname></entry> <entry><function>mysqli_thread_id</function></entry> <entry>N/A</entry> <entry>Returns the thread ID for the current connection</entry> </row> <row> - <entry><link linkend="mysqli.thread-safe">$mysqli->thread_safe</link></entry> + <entry><methodname>mysqli->thread_safe</methodname></entry> <entry><function>mysqli_thread_safe</function></entry> <entry>N/A</entry> <entry>Returns whether thread safety is given or not</entry> </row> <row> - <entry><link linkend="mysqli.use-result">$mysqli->use_result</link></entry> + <entry><methodname>mysqli->use_result</methodname></entry> <entry><function>mysqli_use_result</function></entry> <entry>N/A</entry> <entry>Initiate a result set retrieval</entry> @@ -418,115 +418,115 @@ <entry><emphasis role="bold">Methods</emphasis></entry> </row> <row> - <entry><link linkend="mysqli-stmt.attr-get">$mysqli_stmt->attr_get</link></entry> + <entry><methodname>mysqli_stmt->attr_get</methodname></entry> <entry><function>mysqli_stmt_attr_get</function></entry> <entry>N/A</entry> <entry>NOT DOCUMENTED</entry> </row> <row> - <entry><link linkend="mysqli-stmt.attr-set">$mysqli_stmt->attr_set</link></entry> + <entry><methodname>mysqli_stmt->attr_set</methodname></entry> <entry><function>mysqli_stmt_attr_set</function></entry> <entry>N/A</entry> <entry>NOT DOCUMENTED</entry> </row> <row> - <entry><link linkend="mysqli-stmt.bind-param">$mysqli_stmt->bind_param</link></entry> + <entry><methodname>mysqli_stmt->bind_param</methodname></entry> <entry><function>mysqli_stmt_bind_param</function></entry> <entry><function>mysqli_bind_param</function></entry> <entry>Binds variables to a prepared statement as parameters</entry> </row> <row> - <entry><link linkend="mysqli-stmt.bind-result">$mysqli_stmt->bind_result</link></entry> + <entry><methodname>mysqli_stmt->bind_result</methodname></entry> <entry><function>mysqli_stmt_bind_result</function></entry> <entry><function>mysqli_bind_result</function></entry> <entry>Binds variables to a prepared statement for result storage</entry> </row> <row> - <entry><link linkend="mysqli-stmt.close">$mysqli_stmt->close</link></entry> + <entry><methodname>mysqli_stmt->close</methodname></entry> <entry><function>mysqli_stmt_close</function></entry> <entry>N/A</entry> <entry>Closes a prepared statement</entry> </row> <row> - <entry><link linkend="mysqli-stmt.data-seek">$mysqli_stmt->data_seek</link></entry> + <entry><methodname>mysqli_stmt->data_seek</methodname></entry> <entry><function>mysqli_stmt_data_seek</function></entry> <entry>N/A</entry> <entry>Seeks to an arbitrary row in statement result set</entry> </row> <row> - <entry><link linkend="mysqli-stmt.execute">$mysqli_stmt->execute</link></entry> + <entry><methodname>mysqli_stmt->execute</methodname></entry> <entry><function>mysqli_stmt_execute</function></entry> <entry><function>mysqli_execute</function></entry> <entry>Executes a prepared Query</entry> </row> <row> - <entry><link linkend="mysqli-stmt.fetch">$mysqli_stmt->fetch</link></entry> + <entry><methodname>mysqli_stmt->fetch</methodname></entry> <entry><function>mysqli_stmt_fetch</function></entry> <entry><function>mysqli_fetch</function></entry> <entry>Fetch results from a prepared statement into the bound variables</entry> </row> <row> - <entry><link linkend="mysqli-stmt.free-result">$mysqli_stmt->free_result</link></entry> + <entry><methodname>mysqli_stmt->free_result</methodname></entry> <entry><function>mysqli_stmt_free_result</function></entry> <entry>N/A</entry> <entry>Frees stored result memory for the given statement handle</entry> </row> <row> - <entry>$mysqli_stmt->get_result</entry> + <entry>$mysqli_stmt->get_result()</entry> <entry>mysqli_stmt_get_result</entry> <entry>N/A</entry> <entry>NOT DOCUMENTED [mysqlnd only]</entry> </row> <row> - <entry><link linkend="mysqli-stmt.get-warnings">$mysqli_stmt->get_warnings</link></entry> + <entry><methodname>mysqli_stmt->get_warnings</methodname></entry> <entry><function>mysqli_stmt_get_warnings</function></entry> <entry>N/A</entry> <entry>NOT DOCUMENTED</entry> </row> <row> - <entry>$mysqli_stmt->more_results</entry> - <entry>mysqli_stmt_more_results</entry> + <entry>$mysqli_stmt->more_results()</entry> + <entry>mysqli_stmt_more_results()</entry> <entry>N/A</entry> <entry>NOT DOCUMENTED [mysqlnd only]</entry> </row> <row> - <entry>$mysqli_stmt->next_result</entry> - <entry>mysqli_stmt_next_result</entry> + <entry>$mysqli_stmt->next_result()</entry> + <entry>mysqli_stmt_next_result()</entry> <entry>N/A</entry> <entry>NOT DOCUMENTED [mysqlnd only]</entry> </row> <row> - <entry><link linkend="mysqli-stmt.num-rows">$mysqli_stmt->num_rows</link></entry> + <entry><methodname>mysqli_stmt->num_rows</methodname></entry> <entry><function>mysqli_stmt_num_rows</function></entry> <entry>N/A</entry> <entry>NOT DOCUMENTED [see also num_rows property]</entry> </row> <row> - <entry><link linkend="mysqli-stmt.prepare">$mysqli_stmt->prepare</link></entry> + <entry><methodname>mysqli_stmt->prepare</methodname></entry> <entry><function>mysqli_stmt_prepare</function></entry> <entry>N/A</entry> <entry>Prepare a SQL statement for execution</entry> </row> <row> - <entry><link linkend="mysqli-stmt.reset">$mysqli_stmt->reset</link></entry> + <entry><methodname>mysqli_stmt->reset</methodname></entry> <entry><function>mysqli_stmt_reset</function></entry> <entry>N/A</entry> <entry>Resets a prepared statement</entry> </row> <row> - <entry><link linkend="mysqli-stmt.result-metadata">$mysqli_stmt->result_metadata</link></entry> + <entry><methodname>mysqli_stmt->result_metadata</methodname></entry> <entry><function>mysqli_stmt_result_metadata</function></entry> <entry><function>mysqli_get_metadata</function></entry> <entry>Returns result set metadata from a prepared statement</entry> </row> <row> - <entry><link linkend="mysqli-stmt.send-long-data">$mysqli_stmt->send_long_data</link></entry> + <entry><methodname>mysqli_stmt->send_long_data</methodname></entry> <entry><function>mysqli_stmt_send_long_data</function></entry> <entry><function>mysqli_send_long_data</function></entry> <entry>Send data in blocks</entry> </row> <row> - <entry><link linkend="mysqli-stmt.store-result">$mysqli_stmt->store_result</link></entry> + <entry><methodname>mysqli_stmt->store_result</methodname></entry> <entry><function>mysqli_stmt_store_result</function></entry> <entry>N/A</entry> <entry>Transfers a result set from a prepared statement</entry> @@ -580,69 +580,69 @@ <entry><emphasis role="bold">Methods</emphasis></entry> </row> <row> - <entry><link linkend="mysqli-result.data-seek">$mysqli_result->data_seek</link></entry> + <entry><methodname>mysqli_result->data_seek</methodname></entry> <entry><function>mysqli_data_seek</function></entry> <entry>N/A</entry> <entry>Adjusts the result pointer to an arbitary row in the result</entry> </row> <row> - <entry>$mysqli_result->fetch_all</entry> - <entry>mysqli_fetch_all</entry> + <entry>$mysqli_result->fetch_all()</entry> + <entry>mysqli_fetch_all()</entry> <entry>N/A</entry> <entry>NOT DOCUMENTED [mysqlnd only]</entry> </row> <row> - <entry><link linkend="mysqli-result.fetch-array">$mysqli_result->fetch_array</link></entry> + <entry><methodname>mysqli_result->fetch_array</methodname></entry> <entry><function>mysqli_fetch_array</function></entry> <entry>N/A</entry> <entry>Fetch a result row as an associative, a numeric array, or both</entry> </row> <row> - <entry><link linkend="mysqli-result.fetch-assoc">$mysqli_result->fetch_assoc</link></entry> + <entry><methodname>mysqli_result->fetch_assoc</methodname></entry> <entry><function>mysqli_fetch_assoc</function></entry> <entry>N/A</entry> <entry>Fetch a result row as an associative array</entry> </row> <row> - <entry><link linkend="mysqli-result.fetch-field-direct">$mysqli_result->fetch_field_direct</link></entry> + <entry><methodname>mysqli_result->fetch_field_direct</methodname></entry> <entry><function>mysqli_fetch_field_direct</function></entry> <entry>N/A</entry> <entry>Fetch meta-data for a single field</entry> </row> <row> - <entry><link linkend="mysqli-result.fetch-field">$mysqli_result->fetch_field</link></entry> + <entry><methodname>mysqli_result->fetch_field</methodname></entry> <entry><function>mysqli_fetch_field</function></entry> <entry>N/A</entry> <entry>Returns the next field in the result set</entry> </row> <row> - <entry><link linkend="mysqli-result.fetch-fields">$mysqli_result->fetch_fields</link></entry> + <entry><methodname>mysqli_result->fetch_fields</methodname></entry> <entry><function>mysqli_fetch_fields</function></entry> <entry>N/A</entry> <entry>Returns an array of objects representing the fields in a result set</entry> </row> <row> - <entry><link linkend="mysqli-result.fetch-object">$mysqli_result->fetch_object</link></entry> + <entry><methodname>mysqli_result->fetch_object</methodname></entry> <entry><function>mysqli_fetch_object</function></entry> <entry>N/A</entry> <entry>Returns the current row of a result set as an object</entry> </row> <row> - <entry><link linkend="mysqli-result.fetch-row">$mysqli_result->fetch_row</link></entry> + <entry><methodname>mysqli_result->fetch_row</methodname></entry> <entry><function>mysqli_fetch_row</function></entry> <entry>N/A</entry> <entry>Get a result row as an enumerated array</entry> </row> <row> - <entry><link linkend="mysqli-result.field-seek">$mysqli_result->field_seek</link></entry> + <entry><methodname>mysqli_result->field_seek</methodname></entry> <entry><function>mysqli_field_seek</function></entry> <entry>N/A</entry> <entry>Set result pointer to a specified field offset</entry> </row> <row> - <entry><link linkend="mysqli-result.free">$mysqli_result->free</link>, - <link linkend="mysqli-result.free">$mysqli_result->close</link>, - <link linkend="mysqli-result.free">$mysqli_result->free_result</link></entry> + <entry><methodname>mysqli_result->free</methodname>, + <link linkend="mysqli-result.free">mysqli_result->close</link>, + <link linkend="mysqli-result.free">mysqli_result->free_result</link></entry> <entry><function>mysqli_free_result</function></entry> <entry>N/A</entry> <entry>Frees the memory associated with a result</entry> @@ -675,13 +675,13 @@ <entry><emphasis role="bold">Methods</emphasis></entry> </row> <row> - <entry><link linkend="mysqli-driver.embedded-server-end">$mysqli_driver->embedded_server_end</link></entry> + <entry><methodname>mysqli_driver->embedded_server_end</methodname></entry> <entry><function>mysqli_embedded_server_end</function></entry> <entry>N/A</entry> <entry>NOT DOCUMENTED</entry> </row> <row> - <entry><link linkend="mysqli-driver.embedded-server-start">$mysqli_driver->embedded_server_start</link></entry> + <entry><methodname>mysqli_driver->embedded_server_start</methodname></entry> <entry><function>mysqli_embedded_server_start</function></entry> <entry>N/A</entry> <entry>NOT DOCUMENTED</entry>