Update ID, refname and methodsynopsis to the new-oo-style

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@249694 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hannes Magnusson 2008-01-02 15:48:24 +00:00
parent 67093c8193
commit 96435695a5
51 changed files with 403 additions and 432 deletions

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<reference xml:id="class.mysqli" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The MySQLi class</title>
<titleabbrev>MySQLi</titleabbrev>
@ -34,7 +34,7 @@
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mysqli')/db:refentry/db:refsect1[@role='description']/descendant::db:fieldsynopsis[1])" />
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mysqli')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[2])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mysqli')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->

View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-affected-rows" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.affected-rows" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_affected_rows</refname>
<refname>mysqli->affected_rows</refname>
<refname>mysqli_affected_rows</refname>
<refpurpose>Gets the number of affected rows in a previous MySQL operation</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_affected_rows</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<fieldsynopsis><type>int</type><varname>affected_rows</varname></fieldsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_affected_rows</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
Returns the number of rows affected by the last <literal>INSERT</literal>,
<literal>UPDATE</literal>, <literal>REPLACE</literal> or

View file

@ -1,28 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-autocommit" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.autocommit" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::autocommit</refname>
<refname>mysqli_autocommit</refname>
<refname>mysqli->autocommit()</refname>
<refpurpose>Turns on or off auto-commiting database modifications</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method)</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli::autocommit</methodname>
<methodparam><type>bool</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_autocommit</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
<methodparam><type>bool</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method)</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>autocommit</methodname>
<methodparam><type>bool</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Turns on or off auto-commit mode on queries for the database connection.
</para>

View file

@ -1,14 +1,21 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-change-user" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.change-user" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::change_user</refname>
<refname>mysqli_change_user</refname>
<refname>mysqli->change_user()</refname>
<refpurpose>Changes the user of the specified database connection</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli::change_user</methodname>
<methodparam><type>string</type><parameter>user</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam><type>string</type><parameter>database</parameter></methodparam>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_change_user</methodname>
@ -17,16 +24,6 @@
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam><type>string</type><parameter>database</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>change_user</methodname>
<methodparam><type>string</type><parameter>user</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam><type>string</type><parameter>database</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Changes the user of the specified database connection and sets the current
database.

View file

@ -1,27 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-character-set-name" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.character-set-name" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::character_set_name</refname>
<refname>mysqli_character_set_name</refname>
<refname>mysqli->character_set_name()</refname>
<refpurpose>Returns the default character set for the database connection</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>string</type><methodname>mysqli::character_set_name</methodname>
<void />
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>mysqli_character_set_name</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>character_set_name</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
Returns the current character set for the database connection.
</para>

View file

@ -1,27 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-close" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.close" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::close</refname>
<refname>mysqli_close</refname>
<refname>mysqli->close()</refname>
<refpurpose>Closes a previously opened database connection</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli::close</methodname>
<void />
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_close</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>close</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
Closes a previously opened database connection.
</para>

View file

@ -1,27 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-commit" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.commit" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::commit</refname>
<refname>mysqli_commit</refname>
<refname>mysqli->commit()</refname>
<refpurpose>Commits the current transaction</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method)</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli::commit</methodname>
<void />
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_commit</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method)</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>commit</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
Commits the current transaction for the database connection.
</para>

View file

@ -1,13 +1,18 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-connect-errno" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.connect-errno" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli->connect_errno</refname>
<refname>mysqli_connect_errno</refname>
<refpurpose>Returns the error code from last connect call</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<fieldsynopsis><type>string</type><varname>connect_errno</varname></fieldsynopsis>
</classsynopsis>
<methodsynopsis>
<type>int</type><methodname>mysqli_connect_errno</methodname>
<void />

View file

@ -1,13 +1,18 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-connect-error" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.connect-error" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli->connect_error</refname>
<refname>mysqli_connect_error</refname>
<refpurpose>Returns a string description of the last connect error</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<fieldsynopsis><type>string</type><varname>connect_error</varname></fieldsynopsis>
</classsynopsis>
<methodsynopsis>
<type>string</type><methodname>mysqli_connect_error</methodname>
<void />

View file

@ -1,14 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-connect" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.connect" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::__construct</refname>
<refname>mysqli_connect</refname>
<refname>mysqli->__construct()</refname>
<refpurpose>Open a new connection to the MySQL server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (constructor):</para>
<constructorsynopsis>
<methodname>mysqli::__construct</methodname>
<methodparam choice='opt'><type>string</type><parameter>host</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam>
<methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam>
</constructorsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>mysqli</type><methodname>mysqli_connect</methodname>
@ -19,19 +29,6 @@
<methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (constructor):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<constructorsynopsis>
<methodname>__construct</methodname>
<methodparam choice='opt'><type>string</type><parameter>host</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam>
<methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam>
</constructorsynopsis>
</classsynopsis>
<para>
Opens a connection to the MySQL Server running on.
</para>

View file

@ -1,27 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-debug" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.debug" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::debug</refname>
<refname>mysqli_debug</refname>
<refname>mysqli->debug()</refname>
<refpurpose>Performs debugging operations</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli::debug</methodname>
<methodparam><type>string</type><parameter>message</parameter></methodparam>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_debug</methodname>
<methodparam><type>string</type><parameter>message</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>debug</methodname>
<methodparam><type>string</type><parameter>message</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Performs debugging operations using the Fred Fish debugging library.
</para>

View file

@ -1,27 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-dump-debug-info" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.dump-debug-info" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::dump_debug_info</refname>
<refname>mysqli_dump_debug_info</refname>
<refname>mysqli->dump_debug_info()</refname>
<refpurpose>Dump debugging information into the log</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli::dump_debug_info</methodname>
<void/>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_dump_debug_info</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>dump_debug_info</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>
This function is designed to be executed by an user with the SUPER
privilege and is used to dump debugging information into the log for the

View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-errno" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.errno" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_errno</refname>
<refname>mysqli->errno</refname>
<refname>mysqli_errno</refname>
<refpurpose>Returns the error code for the most recent function call</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_errno</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<fieldsynopsis><type>int</type><varname>errno</varname></fieldsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_errno</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
Returns the last error code for the most recent MySQLi function call that
can succeed or fail.

View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-error" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.error" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_error</refname>
<refname>mysqli->error</refname>
<refname>mysqli_error</refname>
<refpurpose>Returns a string description of the last error</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>mysqli_error</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<fieldsynopsis><type>string</type><varname>error</varname></fieldsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>mysqli_error</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
Returns the last error message for the most recent MySQLi function call
that can succeed or fail.

View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-field-count" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.field-count" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_field_count</refname>
<refname>mysqli->field_count</refname>
<refname>mysqli_field_count</refname>
<refpurpose>Returns the number of columns for the most recent query</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_field_count</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>mysqli_result</classname></ooclass>
<fieldsynopsis><type>int</type><varname>field_count</varname></fieldsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_field_count</methodname>
<methodparam><type>mysqli</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

View file

@ -1,13 +1,19 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-get-charset" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.get-charset" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::get_charset</refname>
<refname>mysqli_get_charset</refname>
<refpurpose>Returns a character set object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>object</type><methodname>mysqli::get_charset</methodname>
<void />
</methodsynopsis>
<methodsynopsis>
<type>object</type><methodname>mysqli_get_charset</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>

View file

@ -1,13 +1,18 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-get-client-info" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.get-client-info" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::get_client_info</refname>
<refname>mysqli_get_client_info</refname>
<refpurpose>Returns the MySQL client version as a string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mysqli::get_client_info</methodname>
<void />
</methodsynopsis>
<methodsynopsis>
<type>string</type><methodname>mysqli_get_client_info</methodname>
<void />

View file

@ -1,13 +1,18 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-get-client-version" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.get-client-version" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::get_client_version</refname>
<refname>mysqli_get_client_version</refname>
<refpurpose>Get MySQL client info</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mysqli::get_client_version</methodname>
<void/>
</methodsynopsis>
<methodsynopsis>
<type>int</type><methodname>mysqli_get_client_version</methodname>
<void/>

View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-get-host-info" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.get-host-info" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_get_host_info</refname>
<refname>mysqli->host_info</refname>
<refname>mysqli_get_host_info</refname>
<refpurpose>Returns a string representing the type of connection used</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Procdural style:</para>
<methodsynopsis>
<type>string</type><methodname>mysqli_get_host_info</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<fieldsynopsis><type>string</type><varname>host_info</varname></fieldsynopsis>
</classsynopsis>
<para>Procdural style:</para>
<methodsynopsis>
<type>string</type><methodname>mysqli_get_host_info</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
The <function>mysqli_get_host_info</function> function returns a string
describing the connection represented by the <parameter>link</parameter>

View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-get-proto-info" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.get-proto-info" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_get_proto_info</refname>
<refname>mysqli->protocol_version</refname>
<refname>mysqli_get_proto_info</refname>
<refpurpose>Returns the version of the MySQL protocol used</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_get_proto_info</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<fieldsynopsis><type>string</type><varname>protocol_version</varname></fieldsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_get_proto_info</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
Returns an integer representing the MySQL protocol version used by the
connection represented by the <parameter>link</parameter> parameter.

View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-get-server-info" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.get-server-info" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_get_server_info</refname>
<refname>mysqli->server_info</refname>
<refname>mysqli_get_server_info</refname>
<refpurpose>Returns the version of the MySQL server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>mysqli_get_server_info</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<fieldsynopsis><type>string</type><varname>server_info</varname></fieldsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>mysqli_get_server_info</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
Returns a string representing the version of the MySQL server that the
MySQLi extension is connected to.

View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-get-server-version" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.get-server-version" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_get_server_version</refname>
<refname>mysqli->server_version</refname>
<refname>mysqli_get_server_version</refname>
<refpurpose>Returns the version of the MySQL server as an integer</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_get_server_version</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<fieldsynopsis><type>int</type><varname>server_version</varname></fieldsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_get_server_version</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
The <function>mysqli_get_server_version</function> function returns the
version of the server connected to (represented by the

View file

@ -1,13 +1,19 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-get-warnings" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.get-warnings" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::get_warnings</refname>
<refname>mysqli_get_warnings</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>object</type><methodname>mysqli::get_warnings</methodname>
<void />
</methodsynopsis>
<methodsynopsis>
<type>object</type><methodname>mysqli_get_warnings</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>

View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-info" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.info" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_info</refname>
<refname>mysqli->info</refname>
<refname>mysqli_info</refname>
<refpurpose>Retrieves information about the most recently executed query</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>mysqli_info</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property)</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<fieldsynopsis><type>string</type><varname>info</varname></fieldsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>mysqli_info</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
The <function>mysqli_info</function> function returns a string providing
information about the last query executed. The nature of this string is

View file

@ -1,26 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-init" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.init" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::init</refname>
<refname>mysqli_init</refname>
<refpurpose>Initializes MySQLi and returns a resource for use with mysqli_real_connect()</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>mysqli</type><methodname>init</methodname>
<void/>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>mysqli</type><methodname>mysqli_init</methodname>
<void/>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>mysqli</type><methodname>init</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>
Allocates or initializes a MYSQL object suitable for
<function>mysqli_options</function> and <function>mysqli_real_connect</function>.

View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-insert-id" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.insert-id" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_insert_id</refname>
<refname>mysqli->insert_id</refname>
<refname>mysqli_insert_id</refname>
<refpurpose>Returns the auto generated id used in the last query</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_insert_id</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<fieldsynopsis><type>int</type><varname>insert_id</varname></fieldsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_insert_id</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
The <function>mysqli_insert_id</function> function returns the ID generated
by a query on a table with a column having the AUTO_INCREMENT attribute. If

View file

@ -1,28 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-kill" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.kill" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::kill</refname>
<refname>mysqli_kill</refname>
<refname>mysqli->kill()</refname>
<refpurpose>Asks the server to kill a MySQL thread</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method)</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli::kill</methodname>
<methodparam><type>int</type><parameter>processid</parameter></methodparam>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_kill</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
<methodparam><type>int</type><parameter>processid</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method)</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>kill</methodname>
<methodparam><type>int</type><parameter>processid</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<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

View file

@ -1,14 +1,18 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-more-results" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.more-results" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::more_results</refname>
<refname>mysqli_more_results</refname>
<refname>mysqli->more_results</refname>
<refpurpose>Check if there are any more query results from a multi query</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mysqli::more_results</methodname>
<void />
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>mysqli_more_results</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>

View file

@ -1,28 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-multi-query" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.multi-query" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::multi_query</refname>
<refname>mysqli_multi_query</refname>
<refname>mysqli->multi_query()</refname>
<refpurpose>Performs a query on the database</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli::multi_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_multi_query</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>multi_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Executes one or multiple queries which are concatenated by a semicolon.
</para>

View file

@ -1,14 +1,18 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-next-result" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.next-result" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::next_result</refname>
<refname>mysqli_next_result</refname>
<refname>mysqli->next_result()</refname>
<refpurpose>Prepare next result from multi_query</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mysqli::next_result</methodname>
<void />
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>mysqli_next_result</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>

View file

@ -1,14 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-options" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.options" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::options</refname>
<refname>mysqli_options</refname>
<refname>mysqli->options()</refname>
<refpurpose>Set options</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method)</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli::options</methodname>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_options</methodname>
@ -16,15 +22,6 @@
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method)</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>options</methodname>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Used to set extra connect options and affect behavior for a connection.
</para>

View file

@ -1,27 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-ping" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.ping" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::ping</refname>
<refname>mysqli_ping</refname>
<refname>mysqli->ping()</refname>
<refpurpose>Pings a server connection, or tries to reconnect if the connection has gone down</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli::ping</methodname>
<void/>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_ping</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>ping</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>
Checks whether the connection to the server is working. If it has gone
down, and global option <literal>mysqli.reconnect</literal> is enabled

View file

@ -1,28 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-prepare" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.prepare" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::prepare</refname>
<refname>mysqli_prepare</refname>
<refname>mysqli->prepare()</refname>
<refpurpose>Prepare a SQL statement for execution</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method)</para>
<methodsynopsis>
<type>mysqli_stmt</type><methodname>prepare</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>Procedure style:</para>
<methodsynopsis>
<type>mysqli_stmt</type><methodname>mysqli_prepare</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method)</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>mysqli_stmt</type><methodname>prepare</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Prepares the SQL query pointed to by the null-terminated string query, and
returns a statement handle to be used for further operations on the

View file

@ -1,14 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-query" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.query" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::query</refname>
<refname>mysqli_query</refname>
<refname>mysqli->query()</refname>
<refpurpose>Performs a query on the database</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>mixed</type><methodname>mysqli::query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam choice='opt'><type>int</type><parameter>resultmode</parameter></methodparam>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>mixed</type><methodname>mysqli_query</methodname>
@ -16,15 +22,6 @@
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam choice='opt'><type>int</type><parameter>resultmode</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>mixed</type><methodname>query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam choice='opt'><type>int</type><parameter>resultmode</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Performs a <parameter>query</parameter> against the database.
</para>

View file

@ -1,14 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-real-connect" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.real-connect" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::real_connect</refname>
<refname>mysqli_real_connect</refname>
<refname>mysqli->real_connect()</refname>
<refpurpose>Opens a connection to a mysql server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method)</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli::real_connect</methodname>
<methodparam choice='opt'><type>string</type><parameter>host</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam>
<methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam>
<methodparam choice='opt'><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_real_connect</methodname>
@ -21,20 +32,6 @@
<methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam>
<methodparam choice='opt'><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method)</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>real_connect</methodname>
<methodparam choice='opt'><type>string</type><parameter>host</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam>
<methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam>
<methodparam choice='opt'><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Establish a connection to a MySQL database engine.
</para>

View file

@ -1,32 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-real-escape-string" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.real-escape-string" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::real_escape_string</refname>
<refname>mysqli_real_escape_string</refname>
<refname>mysqli->real_escape_string()</refname>
<refpurpose>Escapes special characters in a string for use in a SQL statement, taking into account the current charset of the connection</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>mysqli_real_escape_string</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>escapestr</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (both methods are equivalent):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>escape_string</methodname>
<type>string</type><methodname>mysqli::escape_string</methodname>
<methodparam><type>string</type><parameter>escapestr</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>string</type><methodname>real_escape_string</methodname>
<methodparam><type>string</type><parameter>escapestr</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>mysqli_real_escape_string</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>escapestr</parameter></methodparam>
</methodsynopsis>
<para>
This function is used to create a legal SQL string that you can use in an
SQL statement. The given string is encoded to an escaped SQL string,

View file

@ -1,28 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-real-query" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.real-query" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::real_query</refname>
<refname>mysqli_real_query</refname>
<refname>mysqli->real_query()</refname>
<refpurpose>Execute an SQL query</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>bool</type><methodname>real_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_real_query</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>real_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Executes a single query against the database whose result can then be
retrieved or stored using the <function>mysqli_store_result</function> or

View file

@ -1,25 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-rollback" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.rollback" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::rollback</refname>
<refname>mysqli_rollback</refname>
<refname>mysqli->rollback()</refname>
<refpurpose>Rolls back current transaction</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli::rollback</methodname>
<void/>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_rollback</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>rollback</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>
Rollbacks the current transaction for the database.
</para>

View file

@ -1,28 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-select-db" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.select-db" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::select_db</refname>
<refname>mysqli_select_db</refname>
<refname>mysqli->select_db()</refname>
<refpurpose>Selects the default database for database queries</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli::select_db</methodname>
<methodparam><type>string</type><parameter>dbname</parameter></methodparam>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_select_db</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>dbname</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>select_db</methodname>
<methodparam><type>string</type><parameter>dbname</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Selects the default database to be used when performing queries against
the database connection.

View file

@ -1,28 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-set-charset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.set-charset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mysqli::set_charset</refname>
<refname>mysqli_set_charset</refname>
<refname>mysqli->set_charset</refname>
<refpurpose>Sets the default client character set</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli::set_charset</methodname>
<methodparam><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_set_charset</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>set_charset</methodname>
<methodparam><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Sets the default character set to be used when sending data from and to
the database server.

View file

@ -1,7 +1,8 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-set-local-infile-default" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.set-local-infile-default" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::set_local_infile_default</refname>
<refname>mysqli_set_local_infile_default</refname>
<refpurpose>Unsets user defined handler for load local infile command</refpurpose>
</refnamediv>

View file

@ -1,7 +1,8 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-set-local-infile-handler" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.set-local-infile-handler" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::set_local_infile_handler</refname>
<refname>mysqli_set_local_infile_handler</refname>
<refpurpose>Set callback functions for LOAD DATA LOCAL INFILE command</refpurpose>
</refnamediv>

View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-sqlstate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.sqlstate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mysqli_sqlstate</refname>
<refname>mysqli->sqlstate</refname>
<refname>mysqli_sqlstate</refname>
<refpurpose>Returns the SQLSTATE error from previous MySQL operation</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>mysqli_sqlstate</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<fieldsynopsis><type>string</type><varname>sqlstate</varname></fieldsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>mysqli_sqlstate</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
Returns a string containing the SQLSTATE error code for the last error.
The error code consists of five characters. <literal>'00000'</literal> means no error.

View file

@ -1,14 +1,23 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-ssl-set" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.ssl-set" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::ssl_set</refname>
<refname>mysqli_ssl_set</refname>
<refname>mysqli->ssl_set()</refname>
<refpurpose>Used for establishing secure connections using SSL</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli::ssl_set</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>cert</parameter></methodparam>
<methodparam><type>string</type><parameter>ca</parameter></methodparam>
<methodparam><type>string</type><parameter>capath</parameter></methodparam>
<methodparam><type>string</type><parameter>cipher</parameter></methodparam>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_ssl_set</methodname>
@ -19,18 +28,6 @@
<methodparam><type>string</type><parameter>capath</parameter></methodparam>
<methodparam><type>string</type><parameter>cipher</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>ssl_set</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>cert</parameter></methodparam>
<methodparam><type>string</type><parameter>ca</parameter></methodparam>
<methodparam><type>string</type><parameter>capath</parameter></methodparam>
<methodparam><type>string</type><parameter>cipher</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Used for establishing secure connections using SSL. It must be called
before <function>mysqli_real_connect</function>. This function does

View file

@ -1,27 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-stat" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.stat" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::stat</refname>
<refname>mysqli_stat</refname>
<refname>mysqli->stat()</refname>
<refpurpose>Gets the current system status</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>string</type><methodname>mysqli::stat</methodname>
<void />
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>mysqli_stat</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>stat</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
<function>mysqli_stat</function> returns a string containing
information similar to that provided by the 'mysqladmin status' command.

View file

@ -1,19 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-stmt-init" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.stmt-init" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::stmt_init</refname>
<refname>mysqli_stmt_init</refname>
<refname>mysqli->stmt_init()</refname>
<refpurpose>Initializes a statement and returns an object for use with mysqli_stmt_prepare</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style :</para>
<methodsynopsis>
<type>mysqli_stmt</type><methodname>mysqli_stmt_init</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
@ -22,6 +17,11 @@
<void/>
</methodsynopsis>
</classsynopsis>
<para>Procedural style :</para>
<methodsynopsis>
<type>mysqli_stmt</type><methodname>mysqli_stmt_init</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
Allocates and initializes a statement object suitable for
<function>mysqli_stmt_prepare</function>.

View file

@ -1,27 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-store-result" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.store-result" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::store_result</refname>
<refname>mysqli_store_result</refname>
<refname>mysqli->store_result()</refname>
<refpurpose>Transfers a result set from the last query</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>mysqli_result</type><methodname>store_result</methodname>
<void />
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>mysqli_result</type><methodname>mysqli_store_result</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>mysqli_result</type><methodname>store_result</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
Transfers the result set from the last query on the database connection
represented by the <parameter>link</parameter> parameter to be used with

View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-thread-id" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.thread-id" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::thread_id</refname>
<refname>mysqli_thread_id</refname>
<refname>mysqli->thread_id</refname>
<refpurpose>Returns the thread ID for the current connection</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_thread_id</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<fieldsynopsis><type>int</type><varname>thread_id</varname></fieldsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_thread_id</methodname>
<methodparam><type>mysqli</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

View file

@ -1,7 +1,8 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-thread-safe" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.thread-safe" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::thread_safe</refname>
<refname>mysqli_thread_safe</refname>
<refpurpose>Returns whether thread safety is given or not</refpurpose>
</refnamediv>

View file

@ -1,27 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-use-result" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.use-result" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::use_result</refname>
<refname>mysqli_use_result</refname>
<refname>mysqli->use_result()</refname>
<refpurpose>Initiate a result set retrieval</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>mysqli_result</type><methodname>use_result</methodname>
<void />
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>mysqli_result</type><methodname>mysqli_use_result</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>mysqli_result</type><methodname>use_result</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
Used to initiate the retrieval of a result set from the last query
executed using the <function>mysqli_real_query</function> function on the

View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-warning-count" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli.warning-count" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::warning_count</refname>
<refname>mysqli_warning_count</refname>
<refname>mysqli->warning_count</refname>
<refpurpose>Returns the number of warnings from the last query for the given link</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_warning_count</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<fieldsynopsis><type>int</type><varname>warning_count</varname></fieldsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_warning_count</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
Returns the number of warnings from the last query in the connection.
</para>