dba-fetch.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 44428b04b7b046593e9ab33874eddd1fea7dfab1 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi -->
<refentry xml:id="function.dba-fetch" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>dba_fetch</refname>
  <refpurpose>キーが指すデータを取得する</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>
   以下はオーバーロードされているが、PHP 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> は、<parameter>dba</parameter>
   が指すデータベースから <parameter>key</parameter> が指すデータを
   取得します。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       データを取得するキー。
      </para>
      <note>
       <para>
        inifile を利用する際には、この関数は配列を受け入れることが可能です。
        インデックス 0 にはグループ名、インデックス 1 には値の名前を格納します。
        <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>
       cdb データベースを使用する際に無視する キー / 値 の組み合わせ数。
       複数のキーに同じ名前をつけることがサポートされていないデータベースです、
       この値は無視されます。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   キー / データの組が見つかった場合にそれに関連する文字列、
   それ以外の場合に &false; を返します。
  </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>
       <parameter>dba</parameter> を第3引数に渡して <function>dba_fetch</function> をコールすることは、推奨されなくなりました。
      </entry>
     </row>
     <row>
      <entry>8.2.0</entry>
      <entry>
       <function>dba_fetch</function>
       関数のオプションの skip 引数は、
       PHP でユーザーが使える関数のセマンティクスに従い、
       最後に置かれるようになりました。
       以前のオーバーロードされたシグネチャも引き続き許可されますが、
       使わないことをお勧めします。
      </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
-->