From 647c1d6f7b6556a21b823c6a7c50a72553019df4 Mon Sep 17 00:00:00 2001 From: Philip Olson Date: Wed, 30 Mar 2005 06:27:14 +0000 Subject: [PATCH] WS. The methodsynopsis needed to be moved left one additional space. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@183141 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/mysql/functions/mysql-db-name.xml | 16 +++++++--------- reference/mysql/functions/mysql-db-query.xml | 16 +++++++--------- reference/mysql/functions/mysql-drop-db.xml | 14 ++++++-------- reference/mysql/functions/mysql-errno.xml | 12 +++++------- reference/mysql/functions/mysql-error.xml | 12 +++++------- reference/mysql/functions/mysql-fetch-array.xml | 14 ++++++-------- reference/mysql/functions/mysql-fetch-assoc.xml | 10 +++++----- reference/mysql/functions/mysql-fetch-field.xml | 14 ++++++-------- .../mysql/functions/mysql-fetch-lengths.xml | 10 +++++----- reference/mysql/functions/mysql-fetch-object.xml | 10 +++++----- reference/mysql/functions/mysql-fetch-row.xml | 10 +++++----- reference/mysql/functions/mysql-field-flags.xml | 12 ++++++------ reference/mysql/functions/mysql-field-len.xml | 12 ++++++------ reference/mysql/functions/mysql-field-name.xml | 12 ++++++------ reference/mysql/functions/mysql-field-seek.xml | 12 ++++++------ reference/mysql/functions/mysql-field-table.xml | 12 ++++++------ reference/mysql/functions/mysql-field-type.xml | 12 ++++++------ reference/mysql/functions/mysql-free-result.xml | 10 +++++----- .../mysql/functions/mysql-get-client-info.xml | 10 +++++----- .../mysql/functions/mysql-get-host-info.xml | 10 +++++----- .../mysql/functions/mysql-get-proto-info.xml | 10 +++++----- .../mysql/functions/mysql-get-server-info.xml | 10 +++++----- reference/mysql/functions/mysql-info.xml | 12 +++++------- reference/mysql/functions/mysql-insert-id.xml | 12 +++++------- reference/mysql/functions/mysql-list-dbs.xml | 12 +++++------- reference/mysql/functions/mysql-list-fields.xml | 16 +++++++--------- .../mysql/functions/mysql-list-processes.xml | 12 +++++------- reference/mysql/functions/mysql-list-tables.xml | 14 ++++++-------- reference/mysql/functions/mysql-num-fields.xml | 10 +++++----- reference/mysql/functions/mysql-num-rows.xml | 10 +++++----- reference/mysql/functions/mysql-pconnect.xml | 16 ++++++++-------- reference/mysql/functions/mysql-ping.xml | 12 +++++------- reference/mysql/functions/mysql-result.xml | 16 +++++++--------- reference/mysql/functions/mysql-select-db.xml | 14 ++++++-------- reference/mysql/functions/mysql-tablename.xml | 12 ++++++------ .../mysql/functions/mysql-unbuffered-query.xml | 12 ++++++------ 36 files changed, 204 insertions(+), 236 deletions(-) diff --git a/reference/mysql/functions/mysql-db-name.xml b/reference/mysql/functions/mysql-db-name.xml index 0ec3cf6def..8102ad4c04 100644 --- a/reference/mysql/functions/mysql-db-name.xml +++ b/reference/mysql/functions/mysql-db-name.xml @@ -1,5 +1,5 @@ - + @@ -8,14 +8,12 @@ Description - - stringmysql_db_name - resourceresult - introw - mixed - field - - + + stringmysql_db_name + resourceresult + introw + mixedfield + mysql_db_name takes as its first parameter the result pointer from a call to diff --git a/reference/mysql/functions/mysql-db-query.xml b/reference/mysql/functions/mysql-db-query.xml index 9dce31293c..9625553899 100644 --- a/reference/mysql/functions/mysql-db-query.xml +++ b/reference/mysql/functions/mysql-db-query.xml @@ -1,5 +1,5 @@ - + @@ -8,14 +8,12 @@ Description - - resourcemysql_db_query - stringdatabase - stringquery - resource - link_identifier - - + + resourcemysql_db_query + stringdatabase + stringquery + resourcelink_identifier + Returns a positive MySQL result resource to the query result, or &false; on error. The function also returns &true;/&false; for diff --git a/reference/mysql/functions/mysql-drop-db.xml b/reference/mysql/functions/mysql-drop-db.xml index 6eb60efe30..4363b6ed87 100644 --- a/reference/mysql/functions/mysql-drop-db.xml +++ b/reference/mysql/functions/mysql-drop-db.xml @@ -1,5 +1,5 @@ - + @@ -8,13 +8,11 @@ Description - - boolmysql_drop_db - stringdatabase_name - resource - link_identifier - - + + boolmysql_drop_db + stringdatabase_name + resourcelink_identifier + mysql_drop_db attempts to drop (remove) an entire database from the server associated with the specified diff --git a/reference/mysql/functions/mysql-errno.xml b/reference/mysql/functions/mysql-errno.xml index 1571c8d8c6..0fa05adbaa 100644 --- a/reference/mysql/functions/mysql-errno.xml +++ b/reference/mysql/functions/mysql-errno.xml @@ -1,5 +1,5 @@ - + @@ -11,12 +11,10 @@ Description - - intmysql_errno - resource - link_identifier - - + + intmysql_errno + resourcelink_identifier + Returns the error number from the last MySQL function, or 0 (zero) if no error occurred. diff --git a/reference/mysql/functions/mysql-error.xml b/reference/mysql/functions/mysql-error.xml index bca0e49298..ead2ae9905 100644 --- a/reference/mysql/functions/mysql-error.xml +++ b/reference/mysql/functions/mysql-error.xml @@ -1,5 +1,5 @@ - + @@ -11,12 +11,10 @@ Description - - stringmysql_error - resource - link_identifier - - + + stringmysql_error + resourcelink_identifier + Returns the error text from the last MySQL function, or '' (the empty string) if no error occurred. diff --git a/reference/mysql/functions/mysql-fetch-array.xml b/reference/mysql/functions/mysql-fetch-array.xml index 8ecb86c9f3..af5825cde4 100644 --- a/reference/mysql/functions/mysql-fetch-array.xml +++ b/reference/mysql/functions/mysql-fetch-array.xml @@ -1,5 +1,5 @@ - + @@ -10,13 +10,11 @@ Description - - arraymysql_fetch_array - resourceresult - int - result_type - - + + arraymysql_fetch_array + resourceresult + intresult_type + Returns an array that corresponds to the fetched row, or &false; if there are no more rows. diff --git a/reference/mysql/functions/mysql-fetch-assoc.xml b/reference/mysql/functions/mysql-fetch-assoc.xml index e3bcf63507..c8404e54a4 100644 --- a/reference/mysql/functions/mysql-fetch-assoc.xml +++ b/reference/mysql/functions/mysql-fetch-assoc.xml @@ -1,5 +1,5 @@ - + @@ -10,10 +10,10 @@ Description - - arraymysql_fetch_assoc - resourceresult - + + arraymysql_fetch_assoc + resourceresult + Returns an associative array that corresponds to the fetched row, or &false; if there are no more rows. diff --git a/reference/mysql/functions/mysql-fetch-field.xml b/reference/mysql/functions/mysql-fetch-field.xml index 1f388e520f..727ac56e24 100644 --- a/reference/mysql/functions/mysql-fetch-field.xml +++ b/reference/mysql/functions/mysql-fetch-field.xml @@ -1,5 +1,5 @@ - + @@ -10,13 +10,11 @@ Description - - objectmysql_fetch_field - resourceresult - int - field_offset - - + + objectmysql_fetch_field + resourceresult + intfield_offset + Returns an object containing field information. diff --git a/reference/mysql/functions/mysql-fetch-lengths.xml b/reference/mysql/functions/mysql-fetch-lengths.xml index 051f26f463..e77eb15d7c 100644 --- a/reference/mysql/functions/mysql-fetch-lengths.xml +++ b/reference/mysql/functions/mysql-fetch-lengths.xml @@ -1,5 +1,5 @@ - + @@ -10,10 +10,10 @@ Description - - arraymysql_fetch_lengths - resourceresult - + + arraymysql_fetch_lengths + resourceresult + Returns an array that corresponds to the lengths of each field in the last row fetched by mysql_fetch_row, diff --git a/reference/mysql/functions/mysql-fetch-object.xml b/reference/mysql/functions/mysql-fetch-object.xml index bc4767552b..1772264250 100644 --- a/reference/mysql/functions/mysql-fetch-object.xml +++ b/reference/mysql/functions/mysql-fetch-object.xml @@ -1,5 +1,5 @@ - + @@ -8,10 +8,10 @@ Description - - objectmysql_fetch_object - resourceresult - + + objectmysql_fetch_object + resourceresult + Returns an object with properties that correspond to the fetched row, or &false; if there are no more rows. diff --git a/reference/mysql/functions/mysql-fetch-row.xml b/reference/mysql/functions/mysql-fetch-row.xml index 6c708e85bf..1c857370d7 100644 --- a/reference/mysql/functions/mysql-fetch-row.xml +++ b/reference/mysql/functions/mysql-fetch-row.xml @@ -1,5 +1,5 @@ - + @@ -8,10 +8,10 @@ Description - - arraymysql_fetch_row - resourceresult - + + arraymysql_fetch_row + resourceresult + Returns an array that corresponds to the fetched row, or &false; if there are no more rows. diff --git a/reference/mysql/functions/mysql-field-flags.xml b/reference/mysql/functions/mysql-field-flags.xml index 9dee3f8ec5..4704a7e053 100644 --- a/reference/mysql/functions/mysql-field-flags.xml +++ b/reference/mysql/functions/mysql-field-flags.xml @@ -1,5 +1,5 @@ - + @@ -10,11 +10,11 @@ Description - - stringmysql_field_flags - resourceresult - intfield_offset - + + stringmysql_field_flags + resourceresult + intfield_offset + mysql_field_flags returns the field flags of the specified field. The flags are reported as a single word diff --git a/reference/mysql/functions/mysql-field-len.xml b/reference/mysql/functions/mysql-field-len.xml index b641c31a8b..e8cd504139 100644 --- a/reference/mysql/functions/mysql-field-len.xml +++ b/reference/mysql/functions/mysql-field-len.xml @@ -1,5 +1,5 @@ - + @@ -10,11 +10,11 @@ Description - - intmysql_field_len - resourceresult - intfield_offset - + + intmysql_field_len + resourceresult + intfield_offset + mysql_field_len returns the length of the specified field. diff --git a/reference/mysql/functions/mysql-field-name.xml b/reference/mysql/functions/mysql-field-name.xml index c85b866762..159e05fc00 100644 --- a/reference/mysql/functions/mysql-field-name.xml +++ b/reference/mysql/functions/mysql-field-name.xml @@ -1,5 +1,5 @@ - + @@ -10,11 +10,11 @@ Description - - stringmysql_field_name - resourceresult - intfield_index - + + stringmysql_field_name + resourceresult + intfield_index + mysql_field_name returns the name of the specified field index. result must be a diff --git a/reference/mysql/functions/mysql-field-seek.xml b/reference/mysql/functions/mysql-field-seek.xml index 4419cce88a..3eef26b7f1 100644 --- a/reference/mysql/functions/mysql-field-seek.xml +++ b/reference/mysql/functions/mysql-field-seek.xml @@ -1,5 +1,5 @@ - + @@ -10,11 +10,11 @@ Description - - intmysql_field_seek - resourceresult - intfield_offset - + + intmysql_field_seek + resourceresult + intfield_offset + Seeks to the specified field offset. If the next call to mysql_fetch_field doesn't include a field diff --git a/reference/mysql/functions/mysql-field-table.xml b/reference/mysql/functions/mysql-field-table.xml index f26811f7a7..32638c9aa7 100644 --- a/reference/mysql/functions/mysql-field-table.xml +++ b/reference/mysql/functions/mysql-field-table.xml @@ -1,5 +1,5 @@ - + @@ -10,11 +10,11 @@ Description - - stringmysql_field_table - resourceresult - intfield_offset - + + stringmysql_field_table + resourceresult + intfield_offset + Returns the name of the table that the specified field is in. diff --git a/reference/mysql/functions/mysql-field-type.xml b/reference/mysql/functions/mysql-field-type.xml index e158e71ea5..eb3e76e2fd 100644 --- a/reference/mysql/functions/mysql-field-type.xml +++ b/reference/mysql/functions/mysql-field-type.xml @@ -1,5 +1,5 @@ - + @@ -10,11 +10,11 @@ Description - - stringmysql_field_type - resourceresult - intfield_offset - + + stringmysql_field_type + resourceresult + intfield_offset + mysql_field_type is similar to the mysql_field_name function. The arguments are diff --git a/reference/mysql/functions/mysql-free-result.xml b/reference/mysql/functions/mysql-free-result.xml index 853705a4cd..7c8b33fc68 100644 --- a/reference/mysql/functions/mysql-free-result.xml +++ b/reference/mysql/functions/mysql-free-result.xml @@ -1,5 +1,5 @@ - + @@ -8,10 +8,10 @@ Description - - boolmysql_free_result - resourceresult - + + boolmysql_free_result + resourceresult + mysql_free_result will free all memory associated with the result identifier result. diff --git a/reference/mysql/functions/mysql-get-client-info.xml b/reference/mysql/functions/mysql-get-client-info.xml index 0760dafff6..d67aab1e5e 100644 --- a/reference/mysql/functions/mysql-get-client-info.xml +++ b/reference/mysql/functions/mysql-get-client-info.xml @@ -1,5 +1,5 @@ - + @@ -8,10 +8,10 @@ Description - - stringmysql_get_client_info - - + + stringmysql_get_client_info + + mysql_get_client_info returns a string that represents the client library version. diff --git a/reference/mysql/functions/mysql-get-host-info.xml b/reference/mysql/functions/mysql-get-host-info.xml index 9513a95572..c58cde688a 100644 --- a/reference/mysql/functions/mysql-get-host-info.xml +++ b/reference/mysql/functions/mysql-get-host-info.xml @@ -1,5 +1,5 @@ - + @@ -8,10 +8,10 @@ Description - - stringmysql_get_host_info - resourcelink_identifier - + + stringmysql_get_host_info + resourcelink_identifier + mysql_get_host_info returns a string describing the type of connection in use for the connection diff --git a/reference/mysql/functions/mysql-get-proto-info.xml b/reference/mysql/functions/mysql-get-proto-info.xml index f37782108e..e7fc7711a3 100644 --- a/reference/mysql/functions/mysql-get-proto-info.xml +++ b/reference/mysql/functions/mysql-get-proto-info.xml @@ -1,5 +1,5 @@ - + @@ -8,10 +8,10 @@ Description - - intmysql_get_proto_info - resourcelink_identifier - + + intmysql_get_proto_info + resourcelink_identifier + mysql_get_proto_info returns the protocol version used by connection diff --git a/reference/mysql/functions/mysql-get-server-info.xml b/reference/mysql/functions/mysql-get-server-info.xml index 2f7b09e0cd..68f4040c18 100644 --- a/reference/mysql/functions/mysql-get-server-info.xml +++ b/reference/mysql/functions/mysql-get-server-info.xml @@ -1,5 +1,5 @@ - + @@ -8,10 +8,10 @@ Description - - stringmysql_get_server_info - resourcelink_identifier - + + stringmysql_get_server_info + resourcelink_identifier + mysql_get_server_info returns the server version used by connection diff --git a/reference/mysql/functions/mysql-info.xml b/reference/mysql/functions/mysql-info.xml index 80e52f2fa7..baf4cf7c05 100644 --- a/reference/mysql/functions/mysql-info.xml +++ b/reference/mysql/functions/mysql-info.xml @@ -1,5 +1,5 @@ - + @@ -10,12 +10,10 @@ Description - - stringmysql_info - resource - link_identifier - - + + stringmysql_info + resourcelink_identifier + mysql_info returns detailed information about the last query using the given link_identifier. diff --git a/reference/mysql/functions/mysql-insert-id.xml b/reference/mysql/functions/mysql-insert-id.xml index f9aaeddfa2..fc25af1eaf 100644 --- a/reference/mysql/functions/mysql-insert-id.xml +++ b/reference/mysql/functions/mysql-insert-id.xml @@ -1,5 +1,5 @@ - + @@ -10,12 +10,10 @@ Description - - intmysql_insert_id - resource - link_identifier - - + + intmysql_insert_id + resourcelink_identifier + mysql_insert_id returns the ID generated for an AUTO_INCREMENT column by the previous INSERT query using the diff --git a/reference/mysql/functions/mysql-list-dbs.xml b/reference/mysql/functions/mysql-list-dbs.xml index 3879434f86..9d6668fc1b 100644 --- a/reference/mysql/functions/mysql-list-dbs.xml +++ b/reference/mysql/functions/mysql-list-dbs.xml @@ -1,5 +1,5 @@ - + @@ -10,12 +10,10 @@ Description - - resourcemysql_list_dbs - resource - link_identifier - - + + resourcemysql_list_dbs + resourcelink_identifier + mysql_list_dbs will return a result pointer containing the databases available from the current mysql diff --git a/reference/mysql/functions/mysql-list-fields.xml b/reference/mysql/functions/mysql-list-fields.xml index 47cc4b1e03..c9c6dff0a6 100644 --- a/reference/mysql/functions/mysql-list-fields.xml +++ b/reference/mysql/functions/mysql-list-fields.xml @@ -1,5 +1,5 @@ - + @@ -8,14 +8,12 @@ Description - - resourcemysql_list_fields - stringdatabase_name - stringtable_name - resource - link_identifier - - + + resourcemysql_list_fields + stringdatabase_name + stringtable_name + resourcelink_identifier + The function mysql_list_fields is deprecated. It diff --git a/reference/mysql/functions/mysql-list-processes.xml b/reference/mysql/functions/mysql-list-processes.xml index bc5e43cf6b..da4216dfab 100644 --- a/reference/mysql/functions/mysql-list-processes.xml +++ b/reference/mysql/functions/mysql-list-processes.xml @@ -1,5 +1,5 @@ - + @@ -8,12 +8,10 @@ Description - - resourcemysql_list_processes - resource - link_identifier - - + + resourcemysql_list_processes + resourcelink_identifier + mysql_list_processes returns a result pointer describing the current server threads. diff --git a/reference/mysql/functions/mysql-list-tables.xml b/reference/mysql/functions/mysql-list-tables.xml index c4ca5851f3..4471a73e02 100644 --- a/reference/mysql/functions/mysql-list-tables.xml +++ b/reference/mysql/functions/mysql-list-tables.xml @@ -1,5 +1,5 @@ - + @@ -8,13 +8,11 @@ Description - - resourcemysql_list_tables - stringdatabase - resource - link_identifier - - + + resourcemysql_list_tables + stringdatabase + resourcelink_identifier + mysql_list_tables takes a database name and returns a result pointer much like the diff --git a/reference/mysql/functions/mysql-num-fields.xml b/reference/mysql/functions/mysql-num-fields.xml index 1967d7c02e..94b725b441 100644 --- a/reference/mysql/functions/mysql-num-fields.xml +++ b/reference/mysql/functions/mysql-num-fields.xml @@ -1,5 +1,5 @@ - + @@ -8,10 +8,10 @@ Description - - intmysql_num_fields - resourceresult - + + intmysql_num_fields + resourceresult + mysql_num_fields returns the number of fields in the result set result. diff --git a/reference/mysql/functions/mysql-num-rows.xml b/reference/mysql/functions/mysql-num-rows.xml index d3396246fd..085e4237b2 100644 --- a/reference/mysql/functions/mysql-num-rows.xml +++ b/reference/mysql/functions/mysql-num-rows.xml @@ -1,5 +1,5 @@ - + @@ -8,10 +8,10 @@ Description - - intmysql_num_rows - resourceresult - + + intmysql_num_rows + resourceresult + mysql_num_rows returns the number of rows in a result set. This command is only valid for SELECT statements. diff --git a/reference/mysql/functions/mysql-pconnect.xml b/reference/mysql/functions/mysql-pconnect.xml index b492fab0dc..231e2074d9 100644 --- a/reference/mysql/functions/mysql-pconnect.xml +++ b/reference/mysql/functions/mysql-pconnect.xml @@ -1,5 +1,5 @@ - + @@ -10,13 +10,13 @@ Description - - resourcemysql_pconnect - stringserver - stringusername - stringpassword - intclient_flags - + + resourcemysql_pconnect + stringserver + stringusername + stringpassword + intclient_flags + Returns a positive MySQL persistent link identifier on success, or &false; on error. diff --git a/reference/mysql/functions/mysql-ping.xml b/reference/mysql/functions/mysql-ping.xml index af4ba15848..64a0e7774e 100644 --- a/reference/mysql/functions/mysql-ping.xml +++ b/reference/mysql/functions/mysql-ping.xml @@ -1,5 +1,5 @@ - + @@ -8,12 +8,10 @@ Description - - boolmysql_ping - resource - link_identifier - - + + boolmysql_ping + resourcelink_identifier + mysql_ping checks whether or not the connection to the server is working. If it has gone down, an automatic reconnection is diff --git a/reference/mysql/functions/mysql-result.xml b/reference/mysql/functions/mysql-result.xml index 26fc9bfeea..b40556ff8d 100644 --- a/reference/mysql/functions/mysql-result.xml +++ b/reference/mysql/functions/mysql-result.xml @@ -1,5 +1,5 @@ - + @@ -8,14 +8,12 @@ Description - - mixedmysql_result - resourceresult - introw - mixed - field - - + + mixedmysql_result + resourceresult + introw + mixedfield + mysql_result returns the contents of one cell from a MySQL result set. The field argument can be the diff --git a/reference/mysql/functions/mysql-select-db.xml b/reference/mysql/functions/mysql-select-db.xml index 344c9c9253..8d1f8dc8f5 100644 --- a/reference/mysql/functions/mysql-select-db.xml +++ b/reference/mysql/functions/mysql-select-db.xml @@ -1,5 +1,5 @@ - + @@ -8,13 +8,11 @@ Description - - boolmysql_select_db - stringdatabase_name - resource - link_identifier - - + + boolmysql_select_db + stringdatabase_name + resourcelink_identifier + &return.success; diff --git a/reference/mysql/functions/mysql-tablename.xml b/reference/mysql/functions/mysql-tablename.xml index 585229bf1a..96d3f1488d 100644 --- a/reference/mysql/functions/mysql-tablename.xml +++ b/reference/mysql/functions/mysql-tablename.xml @@ -1,5 +1,5 @@ - + @@ -8,11 +8,11 @@ Description - - stringmysql_tablename - resourceresult - inti - + + stringmysql_tablename + resourceresult + inti + mysql_tablename takes a result pointer returned by the mysql_list_tables function diff --git a/reference/mysql/functions/mysql-unbuffered-query.xml b/reference/mysql/functions/mysql-unbuffered-query.xml index 1be9a5cd8e..93d8415ea1 100644 --- a/reference/mysql/functions/mysql-unbuffered-query.xml +++ b/reference/mysql/functions/mysql-unbuffered-query.xml @@ -1,5 +1,5 @@ - + @@ -11,11 +11,11 @@ Description - - resourcemysql_unbuffered_query - stringquery - resourcelink_identifier - + + resourcemysql_unbuffered_query + stringquery + resourcelink_identifier + mysql_unbuffered_query sends a SQL query query to MySQL, without fetching and