php-doc-en/reference/dba/functions/dba-fetch.xml

132 lines
3.7 KiB
XML

<?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>string</type><methodname>dba_fetch</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>resource</type><parameter>handle</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>.
</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>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>
<varlistentry>
<term><parameter>handle</parameter></term>
<listitem>
<para>
The database handler, returned by <function>dba_open</function> or
<function>dba_popen</function>.
</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;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>4.3.0</entry>
<entry>
The <parameter>skip</parameter> parameter is available to support
cdb's capability of multiple keys having the same name.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</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
-->