Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 4, 2022
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 44 additions & 16 deletions reference/dba/functions/dba-fetch.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -86,7 +115,6 @@
</para>
</refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down