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

major white space fixes

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@128728 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2003-05-25 19:09:28 +00:00
parent 50a1ebbefd
commit 49753523ac
30 changed files with 278 additions and 277 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
reference/mysqli/functions/mysqli-affected-rows.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.mysqli-affected-rows">
<refnamediv>
<refname>mysqli_affected_rows</refname>
@ -12,23 +12,23 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
<function>mysqli_affected_rows</function> returns the number of rows affected by the last
INSERT, UPDATE, or DELETE query associated with the provided <parameter>link</parameter>
parameter. If the last query was invalid, this function will return -1.
<function>mysqli_affected_rows</function> returns the number of rows affected by the last
INSERT, UPDATE, or DELETE query associated with the provided <parameter>link</parameter>
parameter. If the last query was invalid, this function will return -1.
</para>
<note>
<para>
When deleting the entire contents of a table (i.e. 'DELETE FROM foo'), this function will
not return the number of rows that were actually deleted.
When deleting the entire contents of a table (i.e. 'DELETE FROM foo'), this function will
not return the number of rows that were actually deleted.
</para>
</note>
<para>
The <function>mysqli_affected_rows</function> function only works with queries which modify
a table. In order to return the number of rows from a SELECT query, use the
<function>mysqli_num_rows()</function> function instead.
The <function>mysqli_affected_rows</function> function only works with queries which modify
a table. In order to return the number of rows from a SELECT query, use the
<function>mysqli_num_rows()</function> function instead.
</para>
<para>
<example>
<example>
<title>Delete-Query</title>
<programlisting role="php">
<![CDATA[
@ -49,7 +49,7 @@
]]>
</programlisting>
<para>
The above example would produce the following output:
The above example would produce the following output:
<screen>
<![CDATA[
Records deleted: 10

20
reference/mysqli/functions/mysqli-autocommit.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.mysqli-autocommit">
<refnamediv>
<refname>mysqli_autocommit</refname>
@ -13,17 +13,17 @@
<methodparam><type>bool</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
<function>mysqli_autocommit</function> is used to turn on or off auto-commit mode
on queries for the database connection represented by the <parameter>link</parameter>
resource.
<function>mysqli_autocommit</function> is used to turn on or off auto-commit mode
on queries for the database connection represented by the <parameter>link</parameter>
resource.
</para>
<para>
&return.success;
&return.success;
</para>
<para>
<example>
<title>Using the mysqli_autocommit function</title>
<programlisting role="php">
<example>
<title>Using the mysqli_autocommit function</title>
<programlisting role="php">
<![CDATA[
<?php
@ -36,8 +36,8 @@
?>
]]>
</programlisting>
</example>
</programlisting>
</example>
</para>
</refsect1>
</refentry>

42
reference/mysqli/functions/mysqli-change-user.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.mysqli-change-user">
<refnamediv>
<refname>mysqli_change_user</refname>
@ -15,36 +15,36 @@
<methodparam><type>string</type><parameter>database</parameter></methodparam>
</methodsynopsis>
<para>
<function>mysqli_change_user</function> is used to change the user of the specified
database connection as given by the <parameter>link</parameter> parameter and to set the
current database to that specified by the <parameter>database</parameter> parameter.
<function>mysqli_change_user</function> is used to change the user of the specified
database connection as given by the <parameter>link</parameter> parameter and to set the
current database to that specified by the <parameter>database</parameter> parameter.
</para>
<para>
&return.success;
&return.success;
</para>
<para>
If desired, the &null; value may be passed in place of the <parameter>database</parameter>
parameter resulting in only changing the user and not selecting a database. To select
a database in this case use the <function>mysqli_select_db</function> function.
If desired, the &null; value may be passed in place of the <parameter>database</parameter>
parameter resulting in only changing the user and not selecting a database. To select
a database in this case use the <function>mysqli_select_db</function> function.
</para>
<para>
In order to successfully change users a valid <parameter>username</parameter> and
<parameter>password</parameter> parameters must be provided and that user must have
sufficient permissions to access the desired database. If for any reason authorization
fails, the current user authentication will remain.
In order to successfully change users a valid <parameter>username</parameter> and
<parameter>password</parameter> parameters must be provided and that user must have
sufficient permissions to access the desired database. If for any reason authorization
fails, the current user authentication will remain.
</para>
<note>
<para>
Using this command will always cause the current database connection to behave as if
was a completely new database connection, regardless of if the operation was completed
successfully. This reset includes performing a rollback on any active transactions,
closing all temporary tables, and unlocking all locked tables.
Using this command will always cause the current database connection to behave as if
was a completely new database connection, regardless of if the operation was completed
successfully. This reset includes performing a rollback on any active transactions,
closing all temporary tables, and unlocking all locked tables.
</para>
</note>
<para>
<example>
<title>Using the mysqli_change_user function</title>
<programlisting role="php">
<example>
<title>Using the mysqli_change_user function</title>
<programlisting role="php">
<![CDATA[
<?php
@ -57,8 +57,8 @@
?>
]]>
</programlisting>
</example>
</programlisting>
</example>
</para>
</refsect1>
</refentry>

20
reference/mysqli/functions/mysqli-character-set-name.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.mysqli-character-set-name">
<refnamediv>
<refname>mysqli_character_set_name</refname>
@ -12,13 +12,13 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
Returns the current character set for the database connection specified by the
<parameter>link</parameter> parameter.
</para>
Returns the current character set for the database connection specified by the
<parameter>link</parameter> parameter.
</para>
<para>
<example>
<title>Using the mysqli_character_set_name function</title>
<programlisting role="php">
<example>
<title>Using the mysqli_character_set_name function</title>
<programlisting role="php">
<![CDATA[
<?php
@ -31,11 +31,11 @@
?>
]]>
</programlisting>
</example>
</programlisting>
</example>
</para>
<para>
See also <function>mysqli_real_escape_string</function>.
See also <function>mysqli_real_escape_string</function>.
</para>
</refsect1>
</refentry>

6
reference/mysqli/functions/mysqli-close.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.mysqli-close">
<refnamediv>
<refname>mysqli_close</refname>
@ -12,8 +12,8 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
The <function>mysqli_close</function> function closes a previously opened database
connection specified by the <parameter>link</parameter> parameter.
The <function>mysqli_close</function> function closes a previously opened database
connection specified by the <parameter>link</parameter> parameter.
</para>
<para>
See also

10
reference/mysqli/functions/mysqli-commit.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.mysqli-commit">
<refnamediv>
<refname>mysqli_commit</refname>
@ -12,12 +12,12 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
Commits the current transaction for the database specified by the
<parameter>link</parameter> parameter.
Commits the current transaction for the database specified by the
<parameter>link</parameter> parameter.
</para>
<para>
See also: <function>mysqli_autocommit</function>,
<function>mysqli_rollback</function>.
See also <function>mysqli_autocommit</function>,
<function>mysqli_rollback</function>.
</para>
</refsect1>
</refentry>

52
reference/mysqli/functions/mysqli-connect.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.mysqli-connect">
<refnamediv>
<refname>mysqli_connect</refname>
@ -17,41 +17,41 @@
<methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam>
</methodsynopsis>
<para>
The <function>mysqli_connect</function> function attempts to open a connection to the MySQL Server
running on <parameter>host</parameter> which can be either a hostname or an IP address. Passing the
&null; value or the string "localhost" to this parameter, the local host is assumed. When possible,
pipes will be used instead of the TCP/IP protocol. If successful, the <function>mysqli_connect</function>
will return a resource representing the connection to the database, or &false; on failure.
The <function>mysqli_connect</function> function attempts to open a connection to the MySQL Server
running on <parameter>host</parameter> which can be either a hostname or an IP address. Passing the
&null; value or the string "localhost" to this parameter, the local host is assumed. When possible,
pipes will be used instead of the TCP/IP protocol. If successful, the <function>mysqli_connect</function>
will return a resource representing the connection to the database, or &false; on failure.
</para>
<para>
The <parameter>username</parameter> and <parameter>password</parameter> parameters specify the
username and password under which to connect to the MySQL server. If the password is not provided
(the &null; value is passed), the MySQL server will attempt to authenticate the user against those
user records which have no password only. This allows one username to be used with different
permissions (depending on if a password as provided or not).
The <parameter>username</parameter> and <parameter>password</parameter> parameters specify the
username and password under which to connect to the MySQL server. If the password is not provided
(the &null; value is passed), the MySQL server will attempt to authenticate the user against those
user records which have no password only. This allows one username to be used with different
permissions (depending on if a password as provided or not).
</para>
<para>
The <parameter>dbname</parameter> parameter if provided will specify the default database to be
used when performing queries.
The <parameter>dbname</parameter> parameter if provided will specify the default database to be
used when performing queries.
</para>
<para>
The <parameter>port</parameter> and <parameter>socket</parameter> parameters are used in
conjunction with the <parameter>hostname</parameter> parameter to further control how to connect
to the database server. The <parameter>port</parameter> parameter specifies the port number to
attempt to connect to the MySQL server on, while the <parameter>socket</parameter> parameter
specifies the socket or named pipe that should be used.
The <parameter>port</parameter> and <parameter>socket</parameter> parameters are used in
conjunction with the <parameter>hostname</parameter> parameter to further control how to connect
to the database server. The <parameter>port</parameter> parameter specifies the port number to
attempt to connect to the MySQL server on, while the <parameter>socket</parameter> parameter
specifies the socket or named pipe that should be used.
</para>
<note>
<para>
Specifying the <parameter>socket</parameter> parameter will not explicitly determine the type
of connection to be used when connecting to the MySQL server. How the connection is made to the
MySQL database is determined by the <parameter>host</parameter> parameter.
Specifying the <parameter>socket</parameter> parameter will not explicitly determine the type
of connection to be used when connecting to the MySQL server. How the connection is made to the
MySQL database is determined by the <parameter>host</parameter> parameter.
</para>
</note>
<para>
<example>
<title>Using the mysqli_connect function</title>
<programlisting role="php">
<example>
<title>Using the mysqli_connect function</title>
<programlisting role="php">
<![CDATA[
<?php
@ -60,8 +60,8 @@ $link = mysqli_connect("localhost", "foo", "password", "bar");
?>
]]>
</programlisting>
</example>
</programlisting>
</example>
</para>
<para>
See also

24
reference/mysqli/functions/mysqli-data-seek.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.mysqli-data-seek">
<refnamediv>
<refname>mysqli_data_seek</refname>
@ -13,21 +13,21 @@
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>
The <function>mysqli_data_seek</function> function seeks to an arbitrary result pointer
specified by the <parameter>offset</parameter> in the result set represented by
<parameter>result</parameter>. The <parameter>offset</parameter> parameter must be between
zero and the total number of rows minus one (0..<function>mysqli_num_rows</function> - 1).
The <function>mysqli_data_seek</function> function seeks to an arbitrary result pointer
specified by the <parameter>offset</parameter> in the result set represented by
<parameter>result</parameter>. The <parameter>offset</parameter> parameter must be between
zero and the total number of rows minus one (0..<function>mysqli_num_rows</function> - 1).
</para>
<note>
<para>
This function can only be used with results attained from the use of the
<function>mysqli_store_result</function> function.
This function can only be used with results attained from the use of the
<function>mysqli_store_result</function> function.
</para>
</note>
<para>
<example>
<title>Using the mysqli_data_seek function</title>
<programlisting role="php">
<example>
<title>Using the mysqli_data_seek function</title>
<programlisting role="php">
<![CDATA[
<?php
@ -54,8 +54,8 @@
?>
]]>
</programlisting>
</example>
</programlisting>
</example>
</para>
<para>
See also

16
reference/mysqli/functions/mysqli-debug.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.mysqli-debug">
<refnamediv>
<refname>mysqli_debug</refname>
@ -12,14 +12,14 @@
<methodparam><type>string</type><parameter>debug</parameter></methodparam>
</methodsynopsis>
<para>
The <function>mysqli_debug</function> function is used to perform debugging
operations using the Fred Fish debugging library. The <parameter>debug</parameter>
parameter is a string representing the debugging operation to perform.
The <function>mysqli_debug</function> function is used to perform debugging
operations using the Fred Fish debugging library. The <parameter>debug</parameter>
parameter is a string representing the debugging operation to perform.
</para>
<para>
<example>
<title>Generating a Trace File</title>
<programlisting role="php">
<example>
<title>Generating a Trace File</title>
<programlisting role="php">
<![CDATA[
<?php
@ -28,7 +28,7 @@
?>
]]>
</programlisting>
</programlisting>
</example>
</para>
</refsect1>

8
reference/mysqli/functions/mysqli-dump-debug-info.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.mysqli-dump-debug-info">
<refnamediv>
<refname>mysqli_dump_debug_info</refname>
@ -12,9 +12,9 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
This function is designed to be executed by an user with the SUPER privlege and
is used to dump debugging information into the log for the MySQL Server relating
to the connection specified by the <parameter>link</parameter> parameter.
This function is designed to be executed by an user with the SUPER privlege and
is used to dump debugging information into the log for the MySQL Server relating
to the connection specified by the <parameter>link</parameter> parameter.
</para>
<para>
&return.success;

4
reference/mysqli/functions/mysqli-enable-reads-from-master.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.mysqli-enable-reads-from-master">
<refnamediv>
<refname>mysqli_enable_reads_from_master</refname>
@ -12,7 +12,7 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
&warn.undocumented.func;
</refsect1>
</refentry>

4
reference/mysqli/functions/mysqli-enable-rpl-parse.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.mysqli-enable-rpl-parse">
<refnamediv>
<refname>mysqli_enable_rpl_parse</refname>
@ -12,7 +12,7 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
&warn.undocumented.func;
</refsect1>
</refentry>

17
reference/mysqli/functions/mysqli-errno.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.mysqli-errno">
<refnamediv>
<refname>mysqli_errno</refname>
@ -12,20 +12,19 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
The <function>mysqli_errno</function> function will return the last error code for
the most recent MySQLi function call that can succeed or fail with respect to the
database link defined by the <parameter>link</parameter> parameter. If no errors
have occured, this function will return zero.
The <function>mysqli_errno</function> function will return the last error code for
the most recent MySQLi function call that can succeed or fail with respect to the
database link defined by the <parameter>link</parameter> parameter. If no errors
have occured, this function will return zero.
</para>
<note>
<para>
A complete list of the error codes and their meanings can be found in the constants
section of the MySQLi documentation
A complete list of the error codes and their meanings can be found in the constants
section of the MySQLi documentation
</para>
</note>
<para>
See also
<function>mysqli_error</function>.
See also <function>mysqli_error</function>.
</para>
</refsect1>
</refentry>

27
reference/mysqli/functions/mysqli-error.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.mysqli-error">
<refnamediv>
<refname>mysqli_error</refname>
@ -12,17 +12,17 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
The <function>mysqli_error</function> function is identical to the corresponding
<function>mysqli_errno</function> function in every way, except instead of returning
an integer error code the <function>mysqli_error</function> function will return
a string representation of the last error to occur for the database connection
represented by the <parameter>link</parameter> parameter. If no error has occured,
this function will return an empty string.
The <function>mysqli_error</function> function is identical to the corresponding
<function>mysqli_errno</function> function in every way, except instead of returning
an integer error code the <function>mysqli_error</function> function will return
a string representation of the last error to occur for the database connection
represented by the <parameter>link</parameter> parameter. If no error has occured,
this function will return an empty string.
</para>
<para>
<example>
<title>Using the mysqli_error function</title>
<programlisting role="php">
<example>
<title>Using the mysqli_error function</title>
<programlisting role="php">
<![CDATA[
<?php
@ -33,12 +33,11 @@
?>
]]>
</programlisting>
</example>
</programlisting>
</example>
</para>
<para>
See also
<function>mysqli_errno</function>.
See also <function>mysqli_errno</function>.
</para>
</refsect1>
</refentry>

33
reference/mysqli/functions/mysqli-execute.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.mysqli-execute">
<refnamediv>
<refname>mysqli_execute</refname>
@ -12,26 +12,26 @@
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>
The <function>mysqli_execute</function> function executes a query that has been previously
prepared using the <function>mysqli_prepare</function> function represented by the
<parameter>stmt</parameter> resource. When executed any parameter markers which exist will
automatically be replaced with the appropiate data.
The <function>mysqli_execute</function> function executes a query that has been previously
prepared using the <function>mysqli_prepare</function> function represented by the
<parameter>stmt</parameter> resource. When executed any parameter markers which exist will
automatically be replaced with the appropiate data.
</para>
<para>
If the statement is UPDATE, DELETE, or INSERT, the total number of affected rows can be
determined by using the <function>mysqli_stmt_affected_rows</function> function. Likewise,
if the query yields a result set the <function>mysqli_fetch</function> function is used.
If the statement is UPDATE, DELETE, or INSERT, the total number of affected rows can be
determined by using the <function>mysqli_stmt_affected_rows</function> function. Likewise,
if the query yields a result set the <function>mysqli_fetch</function> function is used.
</para>
<note>
<para>
When using <function>mysqli_execute</function>, the <function>mysqli_fetch</function>
function must be used to fetch the data prior to preforming any additional queries.
When using <function>mysqli_execute</function>, the <function>mysqli_fetch</function>
function must be used to fetch the data prior to preforming any additional queries.
</para>
</note>
<para>
<example>
<title>Using the mysqli_execute function</title>
<programlisting role="php">
<example>
<title>Using the mysqli_execute function</title>
<programlisting role="php">
<![CDATA[
<?php
@ -65,12 +65,13 @@
?>
]]>
</programlisting>
</programlisting>
</example>
</para>
<para>
See also <function>mysqli_prepare</function> and
<function>mysqli_bind_param</function>
See also
<function>mysqli_prepare</function> and
<function>mysqli_bind_param</function>.
</para>
</refsect1>
</refentry>

50
reference/mysqli/functions/mysqli-fetch-array.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.mysqli-fetch-array">
<refnamediv>
<refname>mysqli_fetch_array</refname>
@ -13,33 +13,34 @@
<methodparam choice='opt'><type>int</type><parameter>resulttype</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array that corresponds to the fetched row or &false; if there are no more rows for the
database connection represented by the <parameter>link</parameter> parameter.
Returns an array that corresponds to the fetched row or &false; if there are no more rows for the
database connection represented by the <parameter>link</parameter> parameter.
</para>
<para>
<function>mysqli_fetch_array</function> is an extended version of the
<function>mysqli_fetch_row</function> function. In addition to storing the data in the
numeric indices of the result array, the <function>mysqli_fetch_array</function> function can
also store the data in associative indices, using the field names of the result set as keys.
<function>mysqli_fetch_array</function> is an extended version of the
<function>mysqli_fetch_row</function> function. In addition to storing the data in the
numeric indices of the result array, the <function>mysqli_fetch_array</function> function can
also store the data in associative indices, using the field names of the result set as keys.
</para>
<para>
If two or more columns of the result have the same field names, the last column will take
precedence and overwrite the earlier data. In order to access multiple columns with the same
name, the numerically indexed version of the row must be used.
If two or more columns of the result have the same field names, the last column will take
precedence and overwrite the earlier data. In order to access multiple columns with the same
name, the numerically indexed version of the row must be used.
</para>
<para>
The optional second argument <parameter>result_type</parameter> is a constant indicating what
type of array should be produced from the current row data. The possible values for this parameter
are the constants MYSQLI_ASSOC, MYSQLI_NUM, or MYSQLI_BOTH. By default the
<function>mysqli_fetch_array</function> function will assume MYSQLI_BOTH for this parameter.
The optional second argument <parameter>result_type</parameter> is a constant indicating what
type of array should be produced from the current row data. The possible values for this parameter
are the constants MYSQLI_ASSOC, MYSQLI_NUM, or MYSQLI_BOTH. By default the
<function>mysqli_fetch_array</function> function will assume MYSQLI_BOTH for this parameter.
</para>
<para>
By using the MYSQLI_ASSOC constant this function will behave identically to the
<function>mysqli_fetch_assoc</function>, while MYSQLI_NUM will behave identically to the
<function>mysqli_fetch_row</function> function. The final option MYSQLI_BOTH will create a single
array with the attributes of both.
By using the MYSQLI_ASSOC constant this function will behave identically to the
<function>mysqli_fetch_assoc</function>, while MYSQLI_NUM will behave identically to the
<function>mysqli_fetch_row</function> function. The final option MYSQLI_BOTH will create a single
array with the attributes of both.
</para>
<example>
<para>
<example>
<title>mysqli_fetch_array with MYSQLI_NUM</title>
<programlisting role="php">
<![CDATA[
@ -58,8 +59,8 @@
?>
]]>
</programlisting>
</example>
<example>
</example>
<example>
<title>mysqli_fetch_array with MYSQLI_ASSOC</title>
<programlisting role="php">
<![CDATA[
@ -78,8 +79,8 @@
?>
]]>
</programlisting>
</example>
<example>
</example>
<example>
<title>mysqli_fetch_array with MYSQLI_BOTH</title>
<programlisting role="php">
<![CDATA[
@ -98,7 +99,8 @@
?>
]]>
</programlisting>
</example>
</example>
</para>
</refsect1>
</refentry>

24
reference/mysqli/functions/mysqli-fetch-assoc.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.mysqli-fetch-assoc">
<refnamediv>
<refname>mysqli_fetch_assoc</refname>
@ -12,21 +12,21 @@
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
Returns an associative array that corresponds to the fetched row or FALSE if there are no
more rows.
Returns an associative array that corresponds to the fetched row or FALSE if there are no
more rows.
</para>
<para>
The <function>mysqli_fetch_assoc</function> function is used to return an associative array
representing the next row in the result set for the result represented by the
<parameter>result</parameter> parameter, where each key in the array represents the name
of one of the result set's columns.
The <function>mysqli_fetch_assoc</function> function is used to return an associative array
representing the next row in the result set for the result represented by the
<parameter>result</parameter> parameter, where each key in the array represents the name
of one of the result set's columns.
</para>
<para>
If two or more columns in the result set have the same column name, the associative array
returned by the <function>mysqli_fetch_assoc</function> function will contain the value of
the last column of that name. If you must work with result sets with this properity, the
<function>mysqli_fetch_row</function> should be used which returns an numerically-indexed
array instead.
If two or more columns in the result set have the same column name, the associative array
returned by the <function>mysqli_fetch_assoc</function> function will contain the value of
the last column of that name. If you must work with result sets with this properity, the
<function>mysqli_fetch_row</function> should be used which returns an numerically-indexed
array instead.
</para>
<example>
<title>An expanded <function>mysqli_fetch_assoc</function> example</title>

12
reference/mysqli/functions/mysqli-fetch-field.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.mysqli-fetch-field">
<refnamediv>
<refname>mysqli_fetch_field</refname>
@ -12,11 +12,11 @@
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
The <function>mysqli_fetch_field</function> function is used to return the attributes
of the next column in the result set represented by the <parameter>result</parameter>
parameter as an object. When executed this function will return an object containing
the attributes of the current column or &false; if there are no more columns in the
result set.
The <function>mysqli_fetch_field</function> function is used to return the attributes
of the next column in the result set represented by the <parameter>result</parameter>
parameter as an object. When executed this function will return an object containing
the attributes of the current column or &false; if there are no more columns in the
result set.
</para>
<para>
<table>

12
reference/mysqli/functions/mysqli-fetch-fields.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.mysqli-fetch-fields">
<refnamediv>
<refname>mysqli_fetch_fields</refname>
@ -12,11 +12,11 @@
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
This function serves an identical purpose to the <function>mysqli_fetch_field</function>
function with the single difference that, instead of returning one object at a time for
each field, the columns are returned as an array of objects. For a description of the
attributes of each object and their meaning, see the <function>mysqli_fetch_field</function>
function.
This function serves an identical purpose to the <function>mysqli_fetch_field</function>
function with the single difference that, instead of returning one object at a time for
each field, the columns are returned as an array of objects. For a description of the
attributes of each object and their meaning, see the <function>mysqli_fetch_field</function>
function.
</para>
</refsect1>
</refentry>

10
reference/mysqli/functions/mysqli-fetch-lengths.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.mysqli-fetch-lengths">
<refnamediv>
<refname>mysqli_fetch_lengths</refname>
@ -12,10 +12,10 @@
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
The <function>mysqli_fetch_lengths</function> function returns an array containing the
lengths of every column of the current row within the result set represented by the
<parameter>result</parameter> parameter. If succesfully, an numerically indexed array
representing the lengths of each column is returned or &false; on failure.
The <function>mysqli_fetch_lengths</function> function returns an array containing the
lengths of every column of the current row within the result set represented by the
<parameter>result</parameter> parameter. If succesfully, an numerically indexed array
representing the lengths of each column is returned or &false; on failure.
</para>
</refsect1>
</refentry>

8
reference/mysqli/functions/mysqli-fetch-object.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.mysqli-fetch-object">
<refnamediv>
<refname>mysqli_fetch_object</refname>
@ -12,9 +12,9 @@
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
The <function>mysqli_fetch_object</function> will return the current row result set
as an object where the attributes of the object rerpesent the names of the fields found
within the result set. If no more rows exist in the current result set, &false; is returned.
The <function>mysqli_fetch_object</function> will return the current row result set
as an object where the attributes of the object rerpesent the names of the fields found
within the result set. If no more rows exist in the current result set, &false; is returned.
</para>
</refsect1>
</refentry>

14
reference/mysqli/functions/mysqli-fetch-row.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.mysqli-fetch-row">
<refnamediv>
<refname>mysqli_fetch_row</refname>
@ -12,14 +12,14 @@
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array that corresponds to the fetched row, or &false; if there are no more rows.
Returns an array that corresponds to the fetched row, or &false; if there are no more rows.
</para>
<para>
<function>mysqli_fetch_row</function> fetches one row of data from the result set represented by
<parameter>result</parameter> and returns it as an enumerated array, where each column is stored
in an array offset starting from 0 (zero). Each subsequent call to the
<function>mysqli_fetch_row</function> function will return the next row within the result set,
or &false; if there are no more rows.
<function>mysqli_fetch_row</function> fetches one row of data from the result set represented by
<parameter>result</parameter> and returns it as an enumerated array, where each column is stored
in an array offset starting from 0 (zero). Each subsequent call to the
<function>mysqli_fetch_row</function> function will return the next row within the result set,
or &false; if there are no more rows.
</para>
</refsect1>
</refentry>

12
reference/mysqli/functions/mysqli-field-count.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.mysqli-field-count">
<refnamediv>
<refname>mysqli_field_count</refname>
@ -12,11 +12,11 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
Returns the number of columns for the most recent query on the connection
represented by the <parameter>link</parameter> parameter. This function
can be useful when using the <function>mysqli_store_result</function>
function to determine if the query should have produced a non-empty result
set or not without knowing the nature of the query.
Returns the number of columns for the most recent query on the connection
represented by the <parameter>link</parameter> parameter. This function
can be useful when using the <function>mysqli_store_result</function>
function to determine if the query should have produced a non-empty result
set or not without knowing the nature of the query.
</para>
</refsect1>
</refentry>

8
reference/mysqli/functions/mysqli-kill.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.mysqli-kill">
<refnamediv>
<refname>mysqli_kill</refname>
@ -13,9 +13,9 @@
<methodparam><type>int</type><parameter>processid</parameter></methodparam>
</methodsynopsis>
<para>
This function is used to ask the server to kill a MySQL thread specified
by the <parameter>processid</parameter> parameter. This value must be
retrieved by calling the <function>mysqli_thread_id</function> function.
This function is used to ask the server to kill a MySQL thread specified
by the <parameter>processid</parameter> parameter. This value must be
retrieved by calling the <function>mysqli_thread_id</function> function.
</para>
</refsect1>
</refentry>

24
reference/mysqli/functions/mysqli-query.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.mysqli-query">
<refnamediv>
<refname>mysqli_query</refname>
@ -14,17 +14,17 @@
<methodparam choice='opt'><type>int</type><parameter>resultmode</parameter></methodparam>
</methodsynopsis>
<para>
The <function>mysqli_query</function> function is used to simplify the
act of performing a query against the database represented by the
<parameter>link</parameter> parameter. Functionally, using this
function is identical to calling <function>mysqli_real_query</function>
followed either by <function>mysqli_use_result</function> or
<function>mysqli_store_result</function> where <parameter>query</parameter>
is the query string itself and <parameter>resultmode</parameter> is
either the constant MYSQLI_USE_RESULT or MYSQLI_STORE_RESULT depending
on the desired behavior. By default, if the
<parameter>resultmode</parameter> is not provided MYSQLI_STORE_RESULT
is used.
The <function>mysqli_query</function> function is used to simplify the
act of performing a query against the database represented by the
<parameter>link</parameter> parameter. Functionally, using this
function is identical to calling <function>mysqli_real_query</function>
followed either by <function>mysqli_use_result</function> or
<function>mysqli_store_result</function> where <parameter>query</parameter>
is the query string itself and <parameter>resultmode</parameter> is
either the constant MYSQLI_USE_RESULT or MYSQLI_STORE_RESULT depending
on the desired behavior. By default, if the
<parameter>resultmode</parameter> is not provided MYSQLI_STORE_RESULT
is used.
</para>
</refsect1>
</refentry>

4
reference/mysqli/functions/mysqli-real-escape-string.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.mysqli-real-escape-string">
<refnamediv>
<refname>mysqli_real_escape_string</refname>
@ -19,7 +19,7 @@
&warn.undocumented.func;
<para>
See also <function>mysqli_character_set_name</function>.
See also <function>mysqli_character_set_name</function>.
</para>
</refsect1>
</refentry>

16
reference/mysqli/functions/mysqli-real-query.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.mysqli-real-query">
<refnamediv>
<refname>mysqli_real_query</refname>
@ -13,16 +13,16 @@
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
The <function>mysqli_real_query</function> function is used to execute
only a query against the database represented by the <parameter>link</parameter>
whose result can then be retrieved or stored using the
<function>mysqli_store_result</function> or <function>mysqli_use_result</function>
functions.
The <function>mysqli_real_query</function> function is used to execute
only a query against the database represented by the <parameter>link</parameter>
whose result can then be retrieved or stored using the
<function>mysqli_store_result</function> or <function>mysqli_use_result</function>
functions.
</para>
<note>
<para>
In order to determine if a given query should return a result set or not,
see <function>mysqli_field_count</function>.
In order to determine if a given query should return a result set or not,
see <function>mysqli_field_count</function>.
</para>
</note>
</refsect1>

16
reference/mysqli/functions/mysqli-store-result.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.mysqli-store-result">
<refnamediv>
<refname>mysqli_store_result</refname>
@ -12,16 +12,16 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
Transfers the result set from the last query on the database connection
represented by the <parameter>link</parameter> parameter to be used with
the <function>mysqli_data_seek</function> function.
Transfers the result set from the last query on the database connection
represented by the <parameter>link</parameter> parameter to be used with
the <function>mysqli_data_seek</function> function.
</para>
<note>
<para>
Although it is always good practice to free the memory used by the result of
a query using the <function>mysqli_free_result</function> function, when
transfering large result sets using the <function>mysqli_store_result</function>
this becomes particularly important.
Although it is always good practice to free the memory used by the result of
a query using the <function>mysqli_free_result</function> function, when
transfering large result sets using the <function>mysqli_store_result</function>
this becomes particularly important.
</para>
</note>
</refsect1>

14
reference/mysqli/functions/mysqli-thread-id.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.mysqli-thread-id">
<refnamediv>
<refname>mysqli_thread_id</refname>
@ -12,15 +12,15 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
The <function>mysqli_thread_id</function> function returns the thread
ID for the current connection which can then be killed using the
<function>mysqli_kill</function> function.
The <function>mysqli_thread_id</function> function returns the thread
ID for the current connection which can then be killed using the
<function>mysqli_kill</function> function.
</para>
<note>
<para>
The thread ID is assigned on a connection-by-connection basis. Hence,
if the connection is broken and then re-established a new thread ID
will be assigned.
The thread ID is assigned on a connection-by-connection basis. Hence,
if the connection is broken and then re-established a new thread ID
will be assigned.
</para>
</note>
</refsect1>

26
reference/mysqli/functions/mysqli-use-result.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.mysqli-use-result">
<refnamediv>
<refname>mysqli_use_result</refname>
@ -12,21 +12,21 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
<function>mysqli_use_result</function> is used to initiate the retrieval
of a result set from the last query executed using the
<function>mysqli_real_query</function> function on the database connection
specified by the <parameter>link</parameter> parameter. Either this or the
<function>mysqli_store_result</function> function must be called before the
results of a query can be retrieved, and one or the other must be called
to prevent the next query on that database connection from failing.
<function>mysqli_use_result</function> is used to initiate the retrieval
of a result set from the last query executed using the
<function>mysqli_real_query</function> function on the database connection
specified by the <parameter>link</parameter> parameter. Either this or the
<function>mysqli_store_result</function> function must be called before the
results of a query can be retrieved, and one or the other must be called
to prevent the next query on that database connection from failing.
</para>
<note>
<para>
The <function>mysqli_use_result</function> function does not transfer
the entire result set from the database and hence cannot be used functions
such as <function>mysqli_data_seek</function> to move to a particular
row within the set. To use this functionality, the result set must be
stored using <function>mysqli_store_result</function>
The <function>mysqli_use_result</function> function does not transfer
the entire result set from the database and hence cannot be used functions
such as <function>mysqli_data_seek</function> to move to a particular
row within the set. To use this functionality, the result set must be
stored using <function>mysqli_store_result</function>
</para>
</note>
</refsect1>