File: dba-fetch.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (144 lines) | stat: -rw-r--r-- 4,273 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.dba-fetch" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>dba_fetch</refname>
  <refpurpose>Fetch data specified by key</refpurpose>
 </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>Dba\Connection</type><parameter>dba</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>skip</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <simpara>
   Overloaded signature deprecated as of 8.3.0:
  </simpara>
  <methodsynopsis>
   <type>string</type><methodname>dba_fetch</methodname>
   <methodparam><type class="union"><type>string</type><type>array</type></type><parameter>key</parameter></methodparam>
   <methodparam><type>int</type><parameter>skip</parameter></methodparam>
   <methodparam><type>resource</type><parameter>dba</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>dba_fetch</function> fetches the data specified by
   <parameter>key</parameter> from the database specified with
   <parameter>dba</parameter>.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       The key the data is specified by.
      </para>
      <note>
       <para>
        When working with inifiles this function accepts arrays as keys
        where index 0 is the group and index 1 is the value name. See:
        <function>dba_key_split</function>.
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>dba</parameter></term>
     <listitem>
      <para>
       &dba.parameter.dba;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>skip</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.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the associated string if the key/data pair is found, &false; 
   otherwise.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &dba.changelog.dba-object;
     <row>
      <entry>8.3.0</entry>
      <entry>
       Calling <function>dba_fetch</function> with <parameter>dba</parameter> as
       the 3rd argument is now deprecated.
      </entry>
     </row>
     <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>
   <simplelist>
    <member><function>dba_exists</function></member>
    <member><function>dba_delete</function></member>
    <member><function>dba_insert</function></member>
    <member><function>dba_replace</function></member>
    <member><function>dba_key_split</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->