sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 16:38:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Documented another 6 or so functions.

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@127682 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
John Coggeshall 2003-05-19 03:54:02 +00:00
parent 0cd6b030a5
commit 21c3cd0442
7 changed files with 85 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
reference/mysqli/functions/mysqli-get-client-info.xml
View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-get-client-info">
<refnamediv>
<refname>mysqli_get_client_info</refname>
<refpurpose></refpurpose>
<refpurpose>Retrun the MySQL client version as a string</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -12,7 +12,8 @@
<methodparam><type>void</type><parameter></parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
The <function>mysqli_get_client_info</function> is used to return a string
representing the client version being used in the MySQLi extension.
</para>
</refsect1>
</refentry>

8
reference/mysqli/functions/mysqli-get-host-info.xml
View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-get-host-info">
<refnamediv>
<refname>mysqli_get_host_info</refname>
<refpurpose></refpurpose>
<refpurpose>Return a string representing the type of connection used</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -12,7 +12,9 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
The <function>mysqli_get_host_info</function> function returns a string
describing the connection represented by the <parameter>link</parameter>
parameter is using (including the server host name).
</para>
</refsect1>
</refentry>

7
reference/mysqli/functions/mysqli-get-proto-info.xml
View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-get-proto-info">
<refnamediv>
<refname>mysqli_get_proto_info</refname>
<refpurpose></refpurpose>
<refpurpose>Return the version of the MySQL protocol used</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -12,7 +12,8 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
Returns an integer representing the MySQL protocol version used by the
connection represented by the <parameter>link</parameter> parameter.
</para>
</refsect1>
</refentry>

8
reference/mysqli/functions/mysqli-get-server-info.xml
View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-get-server-info">
<refnamediv>
<refname>mysqli_get_server_info</refname>
<refpurpose></refpurpose>
<refpurpose>Return the version of the MySQL server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -12,7 +12,9 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
Returns a string representing the version of the MySQL server that the
MySQLi extension is connected to (represented by the
<parameter>link</parameter> parameter).
</para>
</refsect1>
</refentry>

10
reference/mysqli/functions/mysqli-get-server-version.xml
View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-get-server-version">
<refnamediv>
<refname>mysqli_get_server_version</refname>
<refpurpose></refpurpose>
<refpurpose>Return the version of the MySQL server as an integer</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -12,7 +12,11 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
The <function>mysqli_get_server_version</function> function returns the
version of the server connected to (represented by the
<parameter>link</parameter> 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).
</para>
</refsect1>
</refentry>

49
reference/mysqli/functions/mysqli-info.xml
View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-info">
<refnamediv>
<refname>mysqli_info</refname>
<refpurpose></refpurpose>
<refpurpose>Retrieves information about the most recently executed query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -12,8 +12,51 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
The <function>mysqli_info</function> function returns a string providing
information about the last query executed. The nature of this string is
provided below:
</para>
<para>
<table>
<title>Possible mysqli_info return values</title>
<tgroup cols='2'>
<thead>
<row>
<entry>Query type</entry>
<entry>Example result string</entry>
</row>
</thead>
<tbody>
<row>
<entry>INSERT INTO...SELECT...</entry>
<entry>Records: 100 Duplicates: 0 Warnings: 0</entry>
</row>
<row>
<entry>INSERT INTO...VALUES (...),(...),(...)</entry>
<entry>Records: 3 Duplicates: 0 Warnings: 0</entry>
</row>
<row>
<entry>LOAD DATA INFILE ...</entry>
<entry>Records: 1 Deleted: 0 Skipped: 0 Warnings: 0</entry>
</row>
<row>
<entry>ALTER TABLE ...</entry>
<entry>Records: 3 Duplicates: 0 Warnings: 0</entry>
</row>
<row>
<entry>UPDATE ...</entry>
<entry>Rows matched: 40 Changed: 40 Warnings: 0</entry>
</row>
</tbody>
<tgroup>
<table>
</para>
<note>
<para>
Queries which do not fall into one of the above formats are not supported.
In these situations, <function>mysqli_info</function> will return &false;
</para>
</note>
</refsect1>
</refentry>

17
reference/mysqli/functions/mysqli-insert-id.xml
View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-insert-id">
<refnamediv>
<refname>mysqli_insert_id</refname>
<refpurpose></refpurpose>
<refpurpose>Get the auto generated id used in the last query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -12,8 +12,19 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
The <function>mysqli_insert_id</function> 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.
</para>
<note>
<para>
Performing an INSERT or UPDATE statement using the LAST_INSERT_ID()
function will also modify the value returned by the
<function>mysqli_insert_id</function> function.
</para>
</note>
</refsect1>
</refentry>