reference/dba/functions/dba-fetch.xml
effc344e26a66510fa971719bb8af0960c7f2f46
effc344e26a66510fa971719bb8af0960c7f2f46
...
...
@@ -8,20 +8,24 @@
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
+
<type class="union"><type>string</type><type>false</type></type><methodname>dba_fetch</methodname>
12
+
<methodparam><type class="union"><type>string</type><type>array</type></type><parameter>key</parameter></methodparam>
13
+
<methodparam><type>resource</type><parameter>dba</parameter></methodparam>
14
+
<methodparam choice="opt"><type>int</type><parameter>skip</parameter><initializer>0</initializer></methodparam>
15
+
</methodsynopsis>
16
+
<simpara>
17
+
Overloaded signature deprecated as of 8.3.0:
18
+
</simpara>
19
+
<methodsynopsis>
11
20
<type>string</type><methodname>dba_fetch</methodname>
12
-
<methodparam><type>string</type><parameter>key</parameter></methodparam>
13
-
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
21
+
<methodparam><type class="union"><type>string</type><type>array</type></type><parameter>key</parameter></methodparam>
22
+
<methodparam><type>int</type><parameter>skip</parameter></methodparam>
23
+
<methodparam><type>resource</type><parameter>dba</parameter></methodparam>
14
24
</methodsynopsis>
15
-
<methodsynopsis>
16
-
<type>string</type><methodname>dba_fetch</methodname>
17
-
<methodparam><type>string</type><parameter>key</parameter></methodparam>
18
-
<methodparam><type>int</type><parameter>skip</parameter></methodparam>
19
-
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
20
-
</methodsynopsis>
21
25
<para>
22
26
<function>dba_fetch</function> fetches the data specified by
23
27
<parameter>key</parameter> from the database specified with
24
-
<parameter>handle</parameter>.
28
+
<parameter>dba</parameter>.
25
29
</para>
26
30
</refsect1>
27
31
<refsect1 role="parameters">
...
...
@@ -44,27 +48,28 @@
44
48
</listitem>
45
49
</varlistentry>
46
50
<varlistentry>
47
-
<term><parameter>skip</parameter></term>
51
+
<term><parameter>dba</parameter></term>
48
52
<listitem>
49
53
<para>
50
-
The number of key-value pairs to ignore when using cdb databases.
51
-
This value is ignored for all other databases which do not support
52
-
multiple keys with the same name.
54
+
The database handler, returned by <function>dba_open</function> or
55
+
<function>dba_popen</function>.
53
56
</para>
54
57
</listitem>
55
58
</varlistentry>
56
59
<varlistentry>
57
-
<term><parameter>handle</parameter></term>
60
+
<term><parameter>skip</parameter></term>
58
61
<listitem>
59
62
<para>
60
-
The database handler, returned by <function>dba_open</function> or
61
-
<function>dba_popen</function>.
63
+
The number of key-value pairs to ignore when using cdb databases.
64
+
This value is ignored for all other databases which do not support
65
+
multiple keys with the same name.
62
66
</para>
63
67
</listitem>
64
68
</varlistentry>
65
69
</variablelist>
66
70
</para>
67
71
</refsect1>
72
+
68
73
<refsect1 role="returnvalues">
69
74
&reftitle.returnvalues;
70
75
<para>
...
...
@@ -72,30 +77,38 @@
72
77
otherwise.
73
78
</para>
74
79
</refsect1>
80
+
75
81
<refsect1 role="changelog">
76
82
&reftitle.changelog;
77
-
<para>
78
-
<informaltable>
79
-
<tgroup cols="2">
80
-
<thead>
81
-
<row>
82
-
<entry>&Version;</entry>
83
-
<entry>&Description;</entry>
84
-
</row>
85
-
</thead>
86
-
<tbody>
87
-
<row>
88
-
<entry>4.3.0</entry>
89
-
<entry>
90
-
The <parameter>skip</parameter> parameter is available to support
91
-
cdb's capability of multiple keys having the same name.
92
-
</entry>
93
-
</row>
94
-
</tbody>
95
-
</tgroup>
96
-
</informaltable>
97
-
</para>
83
+
<informaltable>
84
+
<tgroup cols="2">
85
+
<thead>
86
+
<row>
87
+
<entry>&Version;</entry>
88
+
<entry>&Description;</entry>
89
+
</row>
90
+
</thead>
91
+
<tbody>
92
+
<row>
93
+
<entry>8.3.0</entry>
94
+
<entry>
95
+
Calling <function>dba_fetch</function> with <parameter>dba</parameter> as
96
+
the 3rd argument is now deprecated.
97
+
</entry>
98
+
</row>
99
+
<row>
100
+
<entry>8.2.0</entry>
101
+
<entry>
102
+
<function>dba_fetch</function>'s optional skip argument is now at the end
103
+
in line with PHP userland semantics. The previously overloaded signature
104
+
is still accepted but discouraged.
105
+
</entry>
106
+
</row>
107
+
</tbody>
108
+
</tgroup>
109
+
</informaltable>
98
110
</refsect1>
111
+
99
112
<refsect1 role="seealso">
100
113
&reftitle.seealso;
101
114
<para>
...
...
@@ -109,7 +122,6 @@
109
122
</para>
110
123
</refsect1>
111
124
</refentry>
112
-
113
125
<!-- Keep this comment at the end of the file
114
126
Local variables:
115
127
mode: sgml
116
128