db2-fetch-object.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 871b71764cdca8238069f27436d96011a6a2cb36 Maintainer: takagi Status: ready -->
<refentry xml:id="function.db2-fetch-object" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_fetch_object</refname>
  <refpurpose>
   結果セット内の行を表す、カラムをプロパティとするオブジェクトを返す
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>stdClass</type><type>false</type></type><methodname>db2_fetch_object</methodname>
   <methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>row_number</parameter><initializer>-1</initializer></methodparam>
  </methodsynopsis>


  <para>
   結果セット内の行を表す、カラムをプロパティとするオブジェクトを返します。
  </para>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stmt</parameter></term>
     <listitem>
      <para>
       結果セットを含む有効な <literal>stmt</literal> リソース。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>row_number</parameter></term>
     <listitem>
      <para>
       結果セット内の 1 から始まる行番号を指定します。
       結果セットで前進のみのカーソルを使用している場合にこのパラメータを渡すと、
       PHP の警告が発生します。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   結果セット内の行を表すオブジェクトを返します。
   オブジェクトのプロパティが、結果セット内のカラム名に対応します。
  </para>
  <para>
   IBM DB2、Cloudscape および Apache Derby データベースサーバーは、
   通常はカラム名を大文字として扱います。そのため、
   オブジェクトのプロパティも同じようになります。
  </para>
  <para>
   SELECT 文の中でスカラ関数をコールすることでカラムの値を変更している場合、
   データベースサーバーは、そのカラムの名前としてカラム番号を返します。
   もし何らかの意味のある名前をオブジェクトのプロパティとして使用したいのなら、
   AS 句を使用して結果セット内のカラムに名前を割り当てる必要があります。
  </para>
  <para>
   行が取得されなかった場合は &false; を返します。
  </para>
 </refsect1>

<refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>db2_fetch_object</function> の例</title>
    <para>
     次の例では、スカラ関数 RTRIM を使用した SELECT 文を発行します。
     この関数は、カラムの最後の空白を取り除きます。プロパティ
     "BREED" および "2" を持つオブジェクトを作成するのではなく、
     SELECT 文で AS 句を使用し、変更したカラムに "name" という名前をつけます。
     データベースサーバーはカラム名を大文字に変換するので、
     返されるオブジェクトのプロパティは "BREED" および "NAME" となります。
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$conn = db2_connect($database, $user, $password);

$sql = "SELECT breed, RTRIM(name) AS name
    FROM animals
    WHERE id = ?";

if ($conn) {
    $stmt = db2_prepare($conn, $sql);
    db2_execute($stmt, array(0));

    while ($pet = db2_fetch_object($stmt)) {
        echo "Come here, {$pet->NAME}, my little {$pet->BREED}!";
    }
    db2_close($conn);
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Come here, Pook, my little cat!
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>db2_fetch_array</function></member>
    <member><function>db2_fetch_assoc</function></member>
    <member><function>db2_fetch_both</function></member>
    <member><function>db2_fetch_row</function></member>
    <member><function>db2_result</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
-->