From 21c3cd0442e9170693da4a1dfd5505ae1ae5f2c7 Mon Sep 17 00:00:00 2001 From: John Coggeshall Date: Mon, 19 May 2003 03:54:02 +0000 Subject: [PATCH] Documented another 6 or so functions. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@127682 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../functions/mysqli-get-client-info.xml | 7 +-- .../mysqli/functions/mysqli-get-host-info.xml | 8 +-- .../functions/mysqli-get-proto-info.xml | 7 +-- .../functions/mysqli-get-server-info.xml | 8 +-- .../functions/mysqli-get-server-version.xml | 10 ++-- reference/mysqli/functions/mysqli-info.xml | 49 +++++++++++++++++-- .../mysqli/functions/mysqli-insert-id.xml | 17 +++++-- 7 files changed, 85 insertions(+), 21 deletions(-) diff --git a/reference/mysqli/functions/mysqli-get-client-info.xml b/reference/mysqli/functions/mysqli-get-client-info.xml index 091c9a3cb1..8131b9b6fc 100644 --- a/reference/mysqli/functions/mysqli-get-client-info.xml +++ b/reference/mysqli/functions/mysqli-get-client-info.xml @@ -1,9 +1,9 @@ - + mysqli_get_client_info - + Retrun the MySQL client version as a string Description @@ -12,7 +12,8 @@ void -&warn.undocumented.func; + The mysqli_get_client_info is used to return a string + representing the client version being used in the MySQLi extension. diff --git a/reference/mysqli/functions/mysqli-get-host-info.xml b/reference/mysqli/functions/mysqli-get-host-info.xml index 419424c413..eb383ae007 100644 --- a/reference/mysqli/functions/mysqli-get-host-info.xml +++ b/reference/mysqli/functions/mysqli-get-host-info.xml @@ -1,9 +1,9 @@ - + mysqli_get_host_info - + Return a string representing the type of connection used Description @@ -12,7 +12,9 @@ resourcelink -&warn.undocumented.func; + The mysqli_get_host_info function returns a string + describing the connection represented by the link + parameter is using (including the server host name). diff --git a/reference/mysqli/functions/mysqli-get-proto-info.xml b/reference/mysqli/functions/mysqli-get-proto-info.xml index d9feb54256..854e0f0e58 100644 --- a/reference/mysqli/functions/mysqli-get-proto-info.xml +++ b/reference/mysqli/functions/mysqli-get-proto-info.xml @@ -1,9 +1,9 @@ - + mysqli_get_proto_info - + Return the version of the MySQL protocol used Description @@ -12,7 +12,8 @@ resourcelink -&warn.undocumented.func; + Returns an integer representing the MySQL protocol version used by the + connection represented by the link parameter. diff --git a/reference/mysqli/functions/mysqli-get-server-info.xml b/reference/mysqli/functions/mysqli-get-server-info.xml index 67582169d4..fdbed542ae 100644 --- a/reference/mysqli/functions/mysqli-get-server-info.xml +++ b/reference/mysqli/functions/mysqli-get-server-info.xml @@ -1,9 +1,9 @@ - + mysqli_get_server_info - + Return the version of the MySQL server Description @@ -12,7 +12,9 @@ resourcelink -&warn.undocumented.func; + Returns a string representing the version of the MySQL server that the + MySQLi extension is connected to (represented by the + link parameter). diff --git a/reference/mysqli/functions/mysqli-get-server-version.xml b/reference/mysqli/functions/mysqli-get-server-version.xml index 28a7980cac..6762fe47d6 100644 --- a/reference/mysqli/functions/mysqli-get-server-version.xml +++ b/reference/mysqli/functions/mysqli-get-server-version.xml @@ -1,9 +1,9 @@ - + mysqli_get_server_version - + Return the version of the MySQL server as an integer Description @@ -12,7 +12,11 @@ resourcelink -&warn.undocumented.func; + The mysqli_get_server_version function returns the + version of the server connected to (represented by the + link parameter) as an integer. The form of this + version number is main_version * 10000 + minor_version * 100 + sub_version + (i.e. version 4.1.0 is 40100). diff --git a/reference/mysqli/functions/mysqli-info.xml b/reference/mysqli/functions/mysqli-info.xml index 62334756d8..68cb6acae6 100644 --- a/reference/mysqli/functions/mysqli-info.xml +++ b/reference/mysqli/functions/mysqli-info.xml @@ -1,9 +1,9 @@ - + mysqli_info - + Retrieves information about the most recently executed query Description @@ -12,8 +12,51 @@ resourcelink -&warn.undocumented.func; + The mysqli_info function returns a string providing + information about the last query executed. The nature of this string is + provided below: + + + Possible mysqli_info return values + + + + Query type + Example result string + + + + + INSERT INTO...SELECT... + Records: 100 Duplicates: 0 Warnings: 0 + + + INSERT INTO...VALUES (...),(...),(...) + Records: 3 Duplicates: 0 Warnings: 0 + + + LOAD DATA INFILE ... + Records: 1 Deleted: 0 Skipped: 0 Warnings: 0 + + + ALTER TABLE ... + Records: 3 Duplicates: 0 Warnings: 0 + + + UPDATE ... + Rows matched: 40 Changed: 40 Warnings: 0 + + + +
+ + + + Queries which do not fall into one of the above formats are not supported. + In these situations, mysqli_info will return &false; + + diff --git a/reference/mysqli/functions/mysqli-insert-id.xml b/reference/mysqli/functions/mysqli-insert-id.xml index 9c0340c074..abcb8706a7 100644 --- a/reference/mysqli/functions/mysqli-insert-id.xml +++ b/reference/mysqli/functions/mysqli-insert-id.xml @@ -1,9 +1,9 @@ - + mysqli_insert_id - + Get the auto generated id used in the last query Description @@ -12,8 +12,19 @@ resourcelink -&warn.undocumented.func; + The mysqli_insert_id returns the ID generated by a + query on a table with an column having the AUTO_INCREMENT attribute. If the + last query wasn't an INSERT or UPDATE statement or if the modified table + does not have a column with the AUTO_INCREMENT attribute this function + will return zero. + + + Performing an INSERT or UPDATE statement using the LAST_INSERT_ID() + function will also modify the value returned by the + mysqli_insert_id function. + +