db2-fetch-object.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 871b71764cdca8238069f27436d96011a6a2cb36 Maintainer: jsgoupil Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="function.db2-fetch-object" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_fetch_object</refname>
  <refpurpose>
   Retourne un objet avec les propriétés représentant des colonnes dans la
   ligne extraite
  </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>
   Retourne un objet dans lequel chaque propriété représente une colonne
   retournée dans la ligne extraite du jeu de résultats.
  </para>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stmt</parameter></term>
     <listitem>
      <para>
       Une ressource <literal>stmt</literal> valide contenant le jeu de résultats.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>row_number</parameter></term>
     <listitem>
      <para>
       Demande une ligne spécifique commençant à l'index 1 du jeu de
       résultats. Si vous passez ce paramètre, vous obtiendrez une 
       alerte PHP si le résultat utilise un curseur à avancement
       seul.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne un objet représentant une seule ligne dans le jeu de résultats.
   Les propriétés de l'objet correspondent au nom des colonnes dans le jeu de
   résultats.
  </para>
  <para>
   Les serveurs IBM DB2, Cloudscape et Apache Derby remplissent normalement les
   nom des colonnes avec des majuscules, par conséquent, les propriétés de
   l'objet refléteront ce cas.
  </para>
  <para>
   Si votre requête SELECT appelle une fonction scalaire pour modifier la
   valeur d'une colonne, les serveurs de base de données retournent le numéro
   de colonne en tant que nom de colonne dans le jeu de résultats. Si vous
   préférez une description plus détaillée du nom des colonnes et des
   propriétés de l'objet, vous pouvez utiliser la clause AS pour assigner un
   nom à la colonne dans le jeu de résultats.
  </para>
  <para>
   Retourne &false; si aucune ligne n'a été récupérée.
  </para>
 </refsect1>

<refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>db2_fetch_object</function></title>
    <para>
     L'exemple suivant envoie une requête SELECT avec une fonction scalaire,
     RTRIM, qui supprime les espaces à partir de la fin de la colonne. Au lieu
     de créer un objet avec les propriétés "RACE" et "2", nous utilisons la
     clause AS dans la requête SELECT pour assigner le nom "nom" à la colonne
     modifiée. Le serveur de base de données remplit le nom des colonnes avec
     des majuscules, alors l'objet aura les propriétés "RACE" et "NOM".
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$conn = db2_connect($database, $user, $password);

$sql = "SELECT race, RTRIM(nom) AS nom
    FROM animaux
    WHERE id = ?";

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

    while ($pet = db2_fetch_object($stmt)) {
        echo "Viens ici, {$pet->NOM}, mon petit {$pet->RACE} !";
    }
    db2_close($conn);
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Viens ici, Pook, mon petit chat !
]]>
    </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
-->