From ba25e8d0b87e4b5ba865b75c19b288c284d93a26 Mon Sep 17 00:00:00 2001
From: Georg Richter <georg@php.net>
Date: Fri, 20 Feb 2004 13:05:10 +0000
Subject: [PATCH] - added more samples - marked undocumented functions for
 embedded server and   replication as experimental

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@151917 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../mysqli/functions/mysqli-data-seek.xml     | 110 ++++++++++++------
 reference/mysqli/functions/mysqli-debug.xml   |  12 +-
 .../mysqli-disable-reads-from-master.xml      |   4 +-
 .../functions/mysqli-disable-rpl-parse.xml    |   4 +-
 .../functions/mysqli-dump-debug-info.xml      |   3 +-
 .../functions/mysqli-embedded-connect.xml     |   4 +-
 .../mysqli-enable-reads-from-master.xml       |   4 +-
 .../functions/mysqli-enable-rpl-parse.xml     |   4 +-
 .../mysqli/functions/mysqli-master-query.xml  |   4 +-
 .../functions/mysqli-rpl-parse-enabled.xml    |   4 +-
 .../mysqli/functions/mysqli-rpl-probe.xml     |   4 +-
 .../functions/mysqli-rpl-query-type.xml       |   4 +-
 .../mysqli/functions/mysqli-send-query.xml    |   4 +-
 .../mysqli/functions/mysqli-server-end.xml    |   4 +-
 .../mysqli/functions/mysqli-server-init.xml   |   4 +-
 15 files changed, 107 insertions(+), 66 deletions(-)

diff --git a/reference/mysqli/functions/mysqli-data-seek.xml b/reference/mysqli/functions/mysqli-data-seek.xml
index 565c7842de..99ddd64ed0 100644
--- a/reference/mysqli/functions/mysqli-data-seek.xml
+++ b/reference/mysqli/functions/mysqli-data-seek.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.10 $ -->
+<!-- $Revision: 1.11 $ -->
   <refentry id="function.mysqli-data-seek">
    <refnamediv>
     <refname>mysqli_data_seek</refname>
@@ -42,43 +42,6 @@
      &return.success;
     </para>
    </refsect1>
-   <refsect1>
-    <title>Example</title>
-    <para>
-     <example>
-      <title>Using the mysqli_data_seek function</title>
-      <programlisting role="php">
-<![CDATA[
-<?php
-                                                                              
-    /* Open a connection */
-    $link = mysqli_connect("localhost", "username", "password");
-    mysqli_select_db("mydb");
-                                                                                                               
-    /* Get some rows and store them */
-    $query = "SELECT DINSTINCT name FROM employee ORDER BY name";
-    $result = mysqli_query($query) or die(mysqli_error());
-
-    $rows = mysqli_store_result($result);
-
-    $total = mysqli_num_fields($rows);
-
-    if ($total > 0) { // there is at least one row
-        /* Get the last employee */
-        mysqli_data_seek($rows, mysqli_num_rows($result) -1);
-        $employee = mysqli_fetch_row($rows);
-        printf ("Employee name : %s\n", $employee[0]);
-    }
-        
-    mysqli_free_result($rows);
-    mysqli_close($link);
-
-?>
-]]>
-      </programlisting>
-     </example>
-    </para>
-   </refsect1>
    <refsect1>
     <title>See also</title>
     <para>
@@ -87,6 +50,77 @@
      <function>mysqli_num_rows</function>.
     </para>
    </refsect1>
+   <refsect1>
+    <title>Example</title>
+    <para>
+     <example>
+      <title>Object oriented style</title>
+      <programlisting role="php">
+<![CDATA[
+<?php
+/* Open a connection */
+$mysqli = new mysqli("localhost", "my_user", "my_password", "test");
+
+$mysqli->query( "DROP TABLE IF EXISTS friends");
+$mysqli->query( "CREATE TABLE friends (id int, name varchar(30))");
+
+$mysqli->query( "INSERT INTO friends VALUES (1, 'Greant'),
+  (2, 'Stocker'), (3, 'Rethans'), (4, 'Wendel')");
+                                                                                                               
+/* Get some rows */
+$query = "SELECT name FROM friends ORDER BY name";
+$result = $mysqli->query( $query) or die(mysqli_error($link));
+
+$total = $result->field_count;
+
+if ($total > 0) { // there is at least one row
+    /* Get the last employee */
+    $result->data_seek($result->num_rows -1);
+    $friend = $result->fetch_row();
+    printf ("Friends name : %s\n", $friend[0]);
+}
+        
+$result->close();
+$mysqli->close();
+?>
+]]>
+      </programlisting>
+     </example>
+     <example>
+      <title>Object oriented style</title>
+      <programlisting role="php">
+<![CDATA[
+<?php
+/* Open a connection */
+$link = mysqli_connect("localhost", "my_user", "my_password", "test");
+
+mysqli_query($link, "DROP TABLE IF EXISTS friends");
+mysqli_query($link, "CREATE TABLE friends (id int, name varchar(30))");
+
+mysqli_query($link, "INSERT INTO friends VALUES (1, 'Greant'),
+ (2, 'Stocker'), (3, 'Rethans'), (4, 'Wendel')");
+                                                                                                               
+/* Get some rows */
+$query = "SELECT name FROM friends ORDER BY name";
+$result = mysqli_query($link, $query) or die(mysqli_error($link));
+
+$total = mysqli_num_fields($result);
+
+if ($total > 0) { /* there is at least one row */
+    /* Get the last employee */
+    mysqli_data_seek($result, mysqli_num_rows($result) -1);
+    $friend = mysqli_fetch_row($result);
+    printf ("Friends name : %s\n", $friend[0]);
+}
+        
+mysqli_free_result($result);
+mysqli_close($link);
+?>
+]]>
+      </programlisting>
+     </example>
+    </para>
+   </refsect1>
   </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/reference/mysqli/functions/mysqli-debug.xml b/reference/mysqli/functions/mysqli-debug.xml
index 59dc0b70a7..bd3be510fe 100644
--- a/reference/mysqli/functions/mysqli-debug.xml
+++ b/reference/mysqli/functions/mysqli-debug.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
   <refentry id="function.mysqli-debug">
    <refnamediv>
     <refname>mysqli_debug</refname>
@@ -16,6 +16,12 @@
      operations using the Fred Fish debugging library. The <parameter>debug</parameter>
      parameter is a string representing the debugging operation to perform.
     </para>
+    <note>
+     <para>
+      To use the <function>mysqli_debug</function> function you must complile
+      the MySQL client library to support debugging.
+     </para>
+    </note>
    </refsect1>
    <refsect1>
     <title>Return values</title>
@@ -30,8 +36,8 @@
 <![CDATA[
 <?php
     
-    /* Create a trace file in '/tmp/client.trace' on the local (client) machine: */
-    mysqli_debug("d:t:0,/tmp/client.trace");
+/* Create a trace file in '/tmp/client.trace' on the local (client) machine: */
+mysqli_debug("d:t:0,/tmp/client.trace");
     
 ?>
 ]]>
diff --git a/reference/mysqli/functions/mysqli-disable-reads-from-master.xml b/reference/mysqli/functions/mysqli-disable-reads-from-master.xml
index 0137a8b5d6..9afb735a8b 100644
--- a/reference/mysqli/functions/mysqli-disable-reads-from-master.xml
+++ b/reference/mysqli/functions/mysqli-disable-reads-from-master.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
   <refentry id="function.mysqli-disable-reads-from-master">
    <refnamediv>
     <refname>mysqli_disable_reads_from_master</refname>
@@ -12,7 +12,7 @@
       <methodparam><type>resource</type><parameter>link</parameter></methodparam>
      </methodsynopsis>
 
-     &warn.undocumented.func;
+     &warn.experimental.func;
 
    </refsect1>
   </refentry>
diff --git a/reference/mysqli/functions/mysqli-disable-rpl-parse.xml b/reference/mysqli/functions/mysqli-disable-rpl-parse.xml
index 40cb607ba0..6d682b11ba 100644
--- a/reference/mysqli/functions/mysqli-disable-rpl-parse.xml
+++ b/reference/mysqli/functions/mysqli-disable-rpl-parse.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
   <refentry id="function.mysqli-disable-rpl-parse">
    <refnamediv>
     <refname>mysqli_disable_rpl_parse</refname>
@@ -12,7 +12,7 @@
       <methodparam><type>object</type><parameter>link</parameter></methodparam>
      </methodsynopsis>
 
-    &warn.undocumented.func;
+    &warn.experimental.func;
 
    </refsect1>
   </refentry>
diff --git a/reference/mysqli/functions/mysqli-dump-debug-info.xml b/reference/mysqli/functions/mysqli-dump-debug-info.xml
index 77fe0982d3..b7b08c3b79 100644
--- a/reference/mysqli/functions/mysqli-dump-debug-info.xml
+++ b/reference/mysqli/functions/mysqli-dump-debug-info.xml
@@ -1,8 +1,9 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
   <refentry id="function.mysqli-dump-debug-info">
    <refnamediv>
     <refname>mysqli_dump_debug_info</refname>
+    <refname>mysqli->dump_debug_info</refname>
     <refpurpose>Dump debugging information into the log</refpurpose>
    </refnamediv>
    <refsect1>
diff --git a/reference/mysqli/functions/mysqli-embedded-connect.xml b/reference/mysqli/functions/mysqli-embedded-connect.xml
index 590641a697..35e714df1b 100644
--- a/reference/mysqli/functions/mysqli-embedded-connect.xml
+++ b/reference/mysqli/functions/mysqli-embedded-connect.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
   <refentry id="function.mysqli-embedded-connect">
    <refnamediv>
     <refname>mysqli_embedded_connect</refname>
@@ -12,7 +12,7 @@
       <methodparam><type>void</type><parameter></parameter></methodparam>
      </methodsynopsis>
 
-    &warn.undocumented.func;
+    &warn.experimental.func;
 
    </refsect1>
   </refentry>
diff --git a/reference/mysqli/functions/mysqli-enable-reads-from-master.xml b/reference/mysqli/functions/mysqli-enable-reads-from-master.xml
index 712b978d4c..c549a4a8d6 100644
--- a/reference/mysqli/functions/mysqli-enable-reads-from-master.xml
+++ b/reference/mysqli/functions/mysqli-enable-reads-from-master.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
   <refentry id="function.mysqli-enable-reads-from-master">
    <refnamediv>
     <refname>mysqli_enable_reads_from_master</refname>
@@ -12,7 +12,7 @@
       <methodparam><type>object</type><parameter>link</parameter></methodparam>
      </methodsynopsis>
 
-    &warn.undocumented.func;
+    &warn.experimental.func;
 
    </refsect1>
   </refentry>
diff --git a/reference/mysqli/functions/mysqli-enable-rpl-parse.xml b/reference/mysqli/functions/mysqli-enable-rpl-parse.xml
index a8478c9772..0dd7f82199 100644
--- a/reference/mysqli/functions/mysqli-enable-rpl-parse.xml
+++ b/reference/mysqli/functions/mysqli-enable-rpl-parse.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
   <refentry id="function.mysqli-enable-rpl-parse">
    <refnamediv>
     <refname>mysqli_enable_rpl_parse</refname>
@@ -12,7 +12,7 @@
       <methodparam><type>object</type><parameter>link</parameter></methodparam>
      </methodsynopsis>
 
-    &warn.undocumented.func;
+    &warn.experimental.func;
 
    </refsect1>
   </refentry>
diff --git a/reference/mysqli/functions/mysqli-master-query.xml b/reference/mysqli/functions/mysqli-master-query.xml
index d30cff64f8..e9f7355dd7 100644
--- a/reference/mysqli/functions/mysqli-master-query.xml
+++ b/reference/mysqli/functions/mysqli-master-query.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
   <refentry id="function.mysqli-master-query">
    <refnamediv>
     <refname>mysqli_master_query</refname>
@@ -13,7 +13,7 @@
       <methodparam><type>string</type><parameter>query</parameter></methodparam>
      </methodsynopsis>
 
-    &warn.undocumented.func;
+    &warn.experimental.func;
 
    </refsect1>
   </refentry>
diff --git a/reference/mysqli/functions/mysqli-rpl-parse-enabled.xml b/reference/mysqli/functions/mysqli-rpl-parse-enabled.xml
index 8b5b171037..2354a70f77 100644
--- a/reference/mysqli/functions/mysqli-rpl-parse-enabled.xml
+++ b/reference/mysqli/functions/mysqli-rpl-parse-enabled.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
   <refentry id="function.mysqli-rpl-parse-enabled">
    <refnamediv>
     <refname>mysqli_rpl_parse_enabled</refname>
@@ -12,7 +12,7 @@
       <methodparam><type>object</type><parameter>link</parameter></methodparam>
      </methodsynopsis>
 
-    &warn.undocumented.func;
+    &warn.experimental.func;
 
    </refsect1>
   </refentry>
diff --git a/reference/mysqli/functions/mysqli-rpl-probe.xml b/reference/mysqli/functions/mysqli-rpl-probe.xml
index 6d4ac417ee..9df58dad87 100644
--- a/reference/mysqli/functions/mysqli-rpl-probe.xml
+++ b/reference/mysqli/functions/mysqli-rpl-probe.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
   <refentry id="function.mysqli-rpl-probe">
    <refnamediv>
     <refname>mysqli_rpl_probe</refname>
@@ -12,7 +12,7 @@
       <methodparam><type>object</type><parameter>link</parameter></methodparam>
      </methodsynopsis>
 
-    &warn.undocumented.func;
+    &warn.experimental.func;
 
    </refsect1>
   </refentry>
diff --git a/reference/mysqli/functions/mysqli-rpl-query-type.xml b/reference/mysqli/functions/mysqli-rpl-query-type.xml
index a08b3ad7be..6bef52d1b1 100644
--- a/reference/mysqli/functions/mysqli-rpl-query-type.xml
+++ b/reference/mysqli/functions/mysqli-rpl-query-type.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
   <refentry id="function.mysqli-rpl-query-type">
    <refnamediv>
     <refname>mysqli_rpl_query_type</refname>
@@ -12,7 +12,7 @@
       <methodparam><type>string</type><parameter>query</parameter></methodparam>
      </methodsynopsis>
 
-    &warn.undocumented.func;
+    &warn.experimental.func;
 
    </refsect1>
   </refentry>
diff --git a/reference/mysqli/functions/mysqli-send-query.xml b/reference/mysqli/functions/mysqli-send-query.xml
index 15858f6134..c9028f38f8 100644
--- a/reference/mysqli/functions/mysqli-send-query.xml
+++ b/reference/mysqli/functions/mysqli-send-query.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
   <refentry id="function.mysqli-send-query">
    <refnamediv>
     <refname>mysqli_send_query</refname>
@@ -13,7 +13,7 @@
       <methodparam><type>string</type><parameter>query</parameter></methodparam>
      </methodsynopsis>
 
-    &warn.undocumented.func;
+    &warn.experimental.func;
 
    </refsect1>
   </refentry>
diff --git a/reference/mysqli/functions/mysqli-server-end.xml b/reference/mysqli/functions/mysqli-server-end.xml
index f702b95627..56d4003d9b 100644
--- a/reference/mysqli/functions/mysqli-server-end.xml
+++ b/reference/mysqli/functions/mysqli-server-end.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
   <refentry id="function.mysqli-server-end">
    <refnamediv>
     <refname>mysqli_server_end</refname>
@@ -12,7 +12,7 @@
       <void/>
      </methodsynopsis>
 
-    &warn.undocumented.func;
+    &warn.experimental.func;
 
    </refsect1>
   </refentry>
diff --git a/reference/mysqli/functions/mysqli-server-init.xml b/reference/mysqli/functions/mysqli-server-init.xml
index ff216cc35a..ad91b87a16 100644
--- a/reference/mysqli/functions/mysqli-server-init.xml
+++ b/reference/mysqli/functions/mysqli-server-init.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
   <refentry id="function.mysqli-server-init">
    <refnamediv>
     <refname>mysqli_server_init</refname>
@@ -12,7 +12,7 @@
       <void/>
      </methodsynopsis>
 
-    &warn.undocumented.func;
+    &warn.experimental.func;
 
    </refsect1>
   </refentry>