dba_fetch() signature has changed to follow userland semantics (#1939)

The overloaded signature is still supported but discouraged.

Author: Girgias

reference/dba/functions/dba-fetch.xml

@@ -7,21 +7,25 @@
  </refnamediv>
  <refsect1 role="description">
   &reftitle.description;
+  <methodsynopsis>
+   <type class="union"><type>string</type><type>false</type></type><methodname>dba_fetch</methodname>
+   <methodparam><type class="union"><type>string</type><type>array</type></type><parameter>key</parameter></methodparam>
+   <methodparam><type>resource</type><parameter>dba</parameter></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>skip</parameter><initializer>0</initializer></methodparam>
+  </methodsynopsis>
+  <simpara>
+   Discouraged overloaded signature:
+  </simpara>
   <methodsynopsis>
    <type>string</type><methodname>dba_fetch</methodname>
    <methodparam><type>string</type><parameter>key</parameter></methodparam>
-   <methodparam><type>resource</type><parameter>handle</parameter></methodparam>
+   <methodparam><type>int</type><parameter>skip</parameter></methodparam>
+   <methodparam><type>resource</type><parameter>dba</parameter></methodparam>
   </methodsynopsis>
-   <methodsynopsis>
-    <type>string</type><methodname>dba_fetch</methodname>
-    <methodparam><type>string</type><parameter>key</parameter></methodparam>
-    <methodparam><type>int</type><parameter>skip</parameter></methodparam>
-    <methodparam><type>resource</type><parameter>handle</parameter></methodparam>
-   </methodsynopsis>
   <para>
    <function>dba_fetch</function> fetches the data specified by
    <parameter>key</parameter> from the database specified with
-   <parameter>handle</parameter>.
+   <parameter>dba</parameter>.
   </para>
  </refsect1>
  <refsect1 role="parameters">
@@ -44,27 +48,28 @@
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term><parameter>skip</parameter></term>
+     <term><parameter>dba</parameter></term>
      <listitem>
       <para>
-       The number of key-value pairs to ignore when using cdb databases. 
-       This value is ignored for all other databases which do not support
-       multiple keys with the same name.
+       The database handler, returned by <function>dba_open</function> or
+       <function>dba_popen</function>.
       </para>
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term><parameter>handle</parameter></term>
+     <term><parameter>skip</parameter></term>
      <listitem>
       <para>
-       The database handler, returned by <function>dba_open</function> or
-       <function>dba_popen</function>.
+       The number of key-value pairs to ignore when using cdb databases.
+       This value is ignored for all other databases which do not support
+       multiple keys with the same name.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect1>
+
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
@@ -73,6 +78,30 @@
   </para>
  </refsect1>
 
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>8.2.0</entry>
+      <entry>
+       <function>dba_fetch</function>'s optional skip argument is now at the end
+       in line with PHP userland semantics. The previously overloaded signature
+       is still accepted but discouraged.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
@@ -86,7 +115,6 @@
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml