From 59d58462f01be6d74bb8a0f30dcfcae0cd7c5436 Mon Sep 17 00:00:00 2001
From: Hannes Magnusson <bjori@php.net>
Date: Wed, 26 Dec 2007 14:06:30 +0000
Subject: [PATCH] MFB: Upgrade to the new-oo-style #NOTE: Someone from MySQL AB
 really should sanitycheck this #      These methods<->function<->props
 mapping makes no sense to me #      so there are probably some errors in the
 method/prop listing

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@249011 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/mysqli/mysqli.xml        | 132 +++++++++++++++++++++++++++++
 reference/mysqli/mysqli_driver.xml |  70 +++++++++++++++
 reference/mysqli/mysqli_result.xml |  83 ++++++++++++++++++
 reference/mysqli/mysqli_stmt.xml   |  94 ++++++++++++++++++++
 4 files changed, 379 insertions(+)
 create mode 100644 reference/mysqli/mysqli.xml
 create mode 100644 reference/mysqli/mysqli_driver.xml
 create mode 100644 reference/mysqli/mysqli_result.xml
 create mode 100644 reference/mysqli/mysqli_stmt.xml

diff --git a/reference/mysqli/mysqli.xml b/reference/mysqli/mysqli.xml
new file mode 100644
index 0000000000..5726af6cac
--- /dev/null
+++ b/reference/mysqli/mysqli.xml
@@ -0,0 +1,132 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.2 $ -->
+<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>
+ 
+ <partintro>
+ 
+<!-- {{{ ClassName intro -->
+  <section xml:id="mysqli.intro">
+   &reftitle.intro;
+   <para>
+    Represents a connection between PHP and a MySQL database.
+   </para>
+  </section>
+<!-- }}} -->
+ 
+  <section xml:id="mysqli.synopsis">
+   <title>Class synopsis</title>
+ 
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>MySQLi</classname></ooclass>
+ 
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>MySQLi</classname>
+     </ooclass>
+    </classsynopsisinfo>
+<!-- }}} -->
+ 
+    <classsynopsisinfo role="comment">Properties</classsynopsisinfo>
+    <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])" />
+   </classsynopsis>
+<!-- }}} -->
+ 
+  </section>
+ 
+ </partintro>
+ 
+<!-- &reference.mysqli.entities.mysqli; -->
+<!-- {{{ FIXME: These entities should be removed and the one above used -->
+ &reference.mysqli.functions.mysqli-autocommit;
+ &reference.mysqli.functions.mysqli-change-user;
+ &reference.mysqli.functions.mysqli-character-set-name;
+ &reference.mysqli.functions.mysqli-client-encoding;
+ &reference.mysqli.functions.mysqli-close;
+ &reference.mysqli.functions.mysqli-commit;
+ &reference.mysqli.functions.mysqli-connect;
+ &reference.mysqli.functions.mysqli-debug;
+ &reference.mysqli.functions.mysqli-disable-reads-from-master;
+ &reference.mysqli.functions.mysqli-disable-rpl-parse;
+ &reference.mysqli.functions.mysqli-dump-debug-info;
+ &reference.mysqli.functions.mysqli-enable-reads-from-master;
+ &reference.mysqli.functions.mysqli-enable-rpl-parse;
+ &reference.mysqli.functions.mysqli-get-client-info;
+ &reference.mysqli.functions.mysqli-get-server-info;
+ &reference.mysqli.functions.mysqli-get-warnings;
+ &reference.mysqli.functions.mysqli-init;
+ &reference.mysqli.functions.mysqli-kill;
+ &reference.mysqli.functions.mysqli-set-local-infile-default;
+ &reference.mysqli.functions.mysqli-set-local-infile-handler;
+ &reference.mysqli.functions.mysqli-master-query;
+ &reference.mysqli.functions.mysqli-multi-query;
+ &reference.mysqli.functions.mysqli-more-results;
+ &reference.mysqli.functions.mysqli-next-result;
+ &reference.mysqli.functions.mysqli-options;
+ &reference.mysqli.functions.mysqli-ping;
+ &reference.mysqli.functions.mysqli-prepare;
+ &reference.mysqli.functions.mysqli-query;
+ &reference.mysqli.functions.mysqli-real-connect;
+ &reference.mysqli.functions.mysqli-real-escape-string;
+ &reference.mysqli.functions.mysqli-escape-string;
+ &reference.mysqli.functions.mysqli-real-query;
+ &reference.mysqli.functions.mysqli-rollback;
+ &reference.mysqli.functions.mysqli-rpl-parse-enabled;
+ &reference.mysqli.functions.mysqli-rpl-probe;
+ &reference.mysqli.functions.mysqli-rpl-query-type;
+ &reference.mysqli.functions.mysqli-select-db;
+ &reference.mysqli.functions.mysqli-set-charset;
+ &reference.mysqli.functions.mysqli-set-opt;
+ &reference.mysqli.functions.mysqli-slave-query;
+ &reference.mysqli.functions.mysqli-ssl-set;
+ &reference.mysqli.functions.mysqli-stat;
+ &reference.mysqli.functions.mysqli-stmt-init;
+ &reference.mysqli.functions.mysqli-store-result;
+ &reference.mysqli.functions.mysqli-thread-safe;
+ &reference.mysqli.functions.mysqli-use-result;
+
+
+ &reference.mysqli.functions.mysqli-get-host-info;
+ &reference.mysqli.functions.mysqli-get-server-version;
+ &reference.mysqli.functions.mysqli-info;
+ &reference.mysqli.functions.mysqli-affected-rows;
+ &reference.mysqli.functions.mysqli-get-client-version;
+ &reference.mysqli.functions.mysqli-errno;
+ &reference.mysqli.functions.mysqli-error;
+ &reference.mysqli.functions.mysqli-field-count;
+ &reference.mysqli.functions.mysqli-insert-id;
+ &reference.mysqli.functions.mysqli-get-proto-info;
+ &reference.mysqli.functions.mysqli-sqlstate;
+ &reference.mysqli.functions.mysqli-thread-id;
+ &reference.mysqli.functions.mysqli-warning-count;
+<!-- }}} -->
+ 
+</reference>
+ 
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
+
diff --git a/reference/mysqli/mysqli_driver.xml b/reference/mysqli/mysqli_driver.xml
new file mode 100644
index 0000000000..4527972f1c
--- /dev/null
+++ b/reference/mysqli/mysqli_driver.xml
@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.2 $ -->
+<reference xml:id="class.mysqli-driver" 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_Driver class</title>
+ <titleabbrev>MySQLi_Driver</titleabbrev>
+ 
+ <partintro>
+ 
+<!-- {{{ ClassName intro -->
+  <section xml:id="mysqli-driver.intro">
+   &reftitle.intro;
+   <para>
+    MySQLi Driver.
+   </para>
+  </section>
+<!-- }}} -->
+ 
+  <section xml:id="mysqli-driver.synopsis">
+   <title>Class synopsis</title>
+ 
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>MySQLi_Driver</classname></ooclass>
+ 
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>MySQLi_Driver</classname>
+     </ooclass>
+    </classsynopsisinfo>
+<!-- }}} -->
+ 
+    <classsynopsisinfo role="comment">Methods</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mysqli-driver')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+   </classsynopsis>
+<!-- }}} -->
+ 
+  </section>
+ 
+ </partintro>
+ 
+<!-- &reference.mysqli.entities.mysqli-driver; -->
+<!-- {{{ FIXME: Remove me -->
+&reference.mysqli.functions.mysqli-embedded-server-end;
+&reference.mysqli.functions.mysqli-embedded-server-start;
+<!-- }}} -->
+
+ </reference>
+ 
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
+
diff --git a/reference/mysqli/mysqli_result.xml b/reference/mysqli/mysqli_result.xml
new file mode 100644
index 0000000000..8e926a7a6b
--- /dev/null
+++ b/reference/mysqli/mysqli_result.xml
@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.2 $ -->
+<reference xml:id="class.mysqli-result" 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_Result class</title>
+ <titleabbrev>MySQLi_Result</titleabbrev>
+ 
+ <partintro>
+ 
+<!-- {{{ ClassName intro -->
+  <section xml:id="mysqli-result.intro">
+   &reftitle.intro;
+   <para>
+    Represents the result set obtained from a query against the database.
+   </para>
+  </section>
+<!-- }}} -->
+ 
+  <section xml:id="mysqli-result.synopsis">
+   <title>Class synopsis</title>
+ 
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>MySQLi_Result</classname></ooclass>
+ 
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>MySQLi_STMT</classname>
+     </ooclass>
+    </classsynopsisinfo>
+<!-- }}} -->
+ 
+    <classsynopsisinfo role="comment">Properties</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mysqli-result')/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-result')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[2])" />
+   </classsynopsis>
+<!-- }}} -->
+ 
+  </section>
+ 
+ </partintro>
+ 
+<!-- &reference.mysqli.entities.mysqli-result; -->
+<!-- {{{ FIXME: Remove me -->
+&reference.mysqli.functions.mysqli-free-result;
+&reference.mysqli.functions.mysqli-data-seek;
+&reference.mysqli.functions.mysqli-fetch-array;
+&reference.mysqli.functions.mysqli-fetch-assoc;
+&reference.mysqli.functions.mysqli-fetch-field-direct;
+&reference.mysqli.functions.mysqli-fetch-field;
+&reference.mysqli.functions.mysqli-fetch-fields;
+&reference.mysqli.functions.mysqli-fetch-object;
+&reference.mysqli.functions.mysqli-fetch-row;
+&reference.mysqli.functions.mysqli-field-seek;
+&reference.mysqli.functions.mysqli-field-tell;
+&reference.mysqli.functions.mysqli-fetch-lengths;
+<!-- }}} -->
+
+ </reference>
+ 
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
+
diff --git a/reference/mysqli/mysqli_stmt.xml b/reference/mysqli/mysqli_stmt.xml
new file mode 100644
index 0000000000..bede8335ce
--- /dev/null
+++ b/reference/mysqli/mysqli_stmt.xml
@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.2 $ -->
+<reference xml:id="class.mysqli-stmt" 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_STMT class</title>
+ <titleabbrev>MySQLi_STMT</titleabbrev>
+ 
+ <partintro>
+ 
+<!-- {{{ ClassName intro -->
+  <section xml:id="mysqli-stmt.intro">
+   &reftitle.intro;
+   <para>
+    Represents a prepared statement.
+   </para>
+  </section>
+<!-- }}} -->
+ 
+  <section xml:id="mysqli-stmt.synopsis">
+   <title>Class synopsis</title>
+ 
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>MySQLi_STMT</classname></ooclass>
+ 
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>MySQLi_STMT</classname>
+     </ooclass>
+    </classsynopsisinfo>
+<!-- }}} -->
+ 
+    <classsynopsisinfo role="comment">Properties</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mysqli-stmt')/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-stmt')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[2])" />
+   </classsynopsis>
+<!-- }}} -->
+ 
+  </section>
+ 
+ </partintro>
+ 
+<!-- &reference.mysqli.entities.mysqli-stmt; -->
+
+<!-- {{{ FIXME: Remove these entities -->
+&reference.mysqli.functions.mysqli-stmt-attr-get;
+&reference.mysqli.functions.mysqli-stmt-attr-set;
+&reference.mysqli.functions.mysqli-stmt-bind-param;
+&reference.mysqli.functions.mysqli-stmt-bind-result;
+&reference.mysqli.functions.mysqli-stmt-close;
+&reference.mysqli.functions.mysqli-stmt-data-seek;
+&reference.mysqli.functions.mysqli-stmt-execute;
+&reference.mysqli.functions.mysqli-stmt-fetch;
+&reference.mysqli.functions.mysqli-stmt-free-result;
+&reference.mysqli.functions.mysqli-stmt-get-warnings;
+&reference.mysqli.functions.mysqli-stmt-prepare;
+&reference.mysqli.functions.mysqli-stmt-reset;
+&reference.mysqli.functions.mysqli-stmt-result-metadata;
+&reference.mysqli.functions.mysqli-stmt-send-long-data;
+&reference.mysqli.functions.mysqli-stmt-affected-rows;
+&reference.mysqli.functions.mysqli-stmt-store-result;
+&reference.mysqli.functions.mysqli-stmt-errno;
+&reference.mysqli.functions.mysqli-stmt-error;
+&reference.mysqli.functions.mysqli-stmt-field-count;
+&reference.mysqli.functions.mysqli-stmt-insert-id;
+&reference.mysqli.functions.mysqli-stmt-num-rows;
+&reference.mysqli.functions.mysqli-stmt-param-count;
+&reference.mysqli.functions.mysqli-stmt-sqlstate;
+<!-- }}} -->
+ </reference>
+ 
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
+