From c9f928c69040e3ca0e9cc87acd9e25bd5a463b9c Mon Sep 17 00:00:00 2001
From: Adam Harvey <aharvey@php.net>
Date: Mon, 12 Nov 2012 09:25:24 +0000
Subject: [PATCH] Change the documentation of sqlite_key() to reflect that it
 can only be called as an instance method, unlike every other SQLite function.
 The previous changelog was, in fact, completely incorrect.

This is absolutely not the right way to do this, and anyone who has a better
idea for how to represent this case is welcome to commit their own fix.
Unfortunately, because the OO API is just a set of method aliases for the
procedural API and it's infrequently used, we don't have the class/method
structure that we have in (say) mysqli, and attempting to retrofit it now would
result in all of the URLs for the SQLite function pages breaking.

Ugh.

Fixes doc bug #54073 (The sqlite_key() documentation should mentioned
procedural usage), for a very low value of fixes.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@328319 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/sqlite/functions/sqlite-key.xml | 54 +++--------------------
 1 file changed, 5 insertions(+), 49 deletions(-)

diff --git a/reference/sqlite/functions/sqlite-key.xml b/reference/sqlite/functions/sqlite-key.xml
index e1563daf21..f4cc170070 100644
--- a/reference/sqlite/functions/sqlite-key.xml
+++ b/reference/sqlite/functions/sqlite-key.xml
@@ -9,36 +9,19 @@
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
-   <type>int</type><methodname>sqlite_key</methodname>
-   <methodparam><type>resource</type><parameter>result</parameter></methodparam>
-  </methodsynopsis>
   <para>&style.oop; (method):</para>
   <methodsynopsis>
    <type>int</type><methodname>SQLiteResult::key</methodname>
    <void/>
   </methodsynopsis>
   <para>
-   <function>sqlite_key</function> returns the current row index of the
-   buffered result set <parameter>result</parameter>.
+   <methodname>SQLiteResult::key</methodname> returns the current row index of
+   the buffered result set <parameter>result</parameter>.
   </para>
- </refsect1>
-
- <refsect1 role="parameters">
-  &reftitle.parameters;
   <para>
-   <variablelist>
-    <varlistentry>
-     <term><parameter>result</parameter></term>
-     <listitem>
-      <para>
-       The SQLite result resource.  This parameter is not required when using
-       the object-oriented method.
-      </para>
-      &sqlite.no-unbuffered;
-     </listitem>
-    </varlistentry>
-   </variablelist>
+   Unlike all other SQLite functions, this function does not have a procedural
+   version, and can only be called as a method on a
+   <classname>SQLiteResult</classname> object.
   </para>
  </refsect1>
 
@@ -50,33 +33,6 @@
   </para>
  </refsect1>
 
- <refsect1 role="changelog">
-  &reftitle.changelog;
-  <para>
-   <informaltable>
-    <tgroup cols="2">
-     <thead>
-      <row>
-       <entry>&Version;</entry>
-       <entry>&Description;</entry>
-      </row>
-     </thead>
-     <tbody>
-      <row>
-       <entry>5.0.4</entry>
-       <entry>
-        Prior to PHP 5.0.4, <function>sqlite_key</function> was only able to be
-        called as a method on a
-        <link linkend="sqlite.class.sqliteresult">SQLiteResult</link> object,
-        not procedurally.
-       </entry>
-      </row>
-     </tbody>
-    </tgroup>
-   </informaltable>
-  </para>
- </refsect1>
-
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>