mysql-fetch-object.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: ff4017b6334dae2d5353fe99df8089a828795324 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.mysql-fetch-object" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mysql_fetch_object</refname>
  <refpurpose>Retourne une ligne de résultat MySQL sous la forme d'un objet</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <warning>
   &mysql.alternative.note;
   <simplelist role="alternatives">
    <member><function>mysqli_fetch_object</function></member>
    <member>
     <methodname>PDOStatement::fetch</methodname>
     avec <parameter>mode</parameter> en tant que <constant>PDO::FETCH_OBJ</constant>
    </member>
   </simplelist>
  </warning>
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>object</type><methodname>mysql_fetch_object</methodname>
   <methodparam><type>resource</type><parameter>result</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>class_name</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>params</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>mysql_fetch_object</function> retourne un tableau qui
   contient la ligne demandée dans le résultat <parameter>result</parameter>
   et déplace le pointeur de données interne d'un cran.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &mysql.result.description;
    <varlistentry>
     <term><parameter>class_name</parameter></term>
     <listitem>
      <para>
       Le nom de la classe à instancier, définit les propriétés et retourne.
       SI ce paramètre n'est pas spécifié, un objet <classname>stdClass</classname>
       sera retourné.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>params</parameter></term>
     <listitem>
      <para>
       Un &array; de paramètres à passer au constructeur pour les objets
       <parameter>class_name</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne un &object; avec les propriétés qui correspondent à la ligne
   récupérée, ou &false; s'il n'y a plus de lignes.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>mysql_fetch_object</function></title>
    <programlisting role="php">
<![CDATA[
<?php
mysql_connect("hostname", "user", "password");
mysql_select_db("mydb");
$result = mysql_query("select * from mytable");
while ($row = mysql_fetch_object($result)) {
   echo $row->user_id;
   echo $row->fullname;
}
mysql_free_result($result);
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Exemple avec <function>mysql_fetch_object</function></title>
    <programlisting role="php">
<![CDATA[
<?php
class foo {
    public $name;
}

mysql_connect("hostname", "user", "password");
mysql_select_db("mydb");

$result = mysql_query("select name from mytable limit 1");
$obj = mysql_fetch_object($result, 'foo');
var_dump($obj);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <title>Performance</title>
   <para>
    Concernant la vitesse, <function>mysql_fetch_object</function> est
    aussi rapide que <function>mysql_fetch_array</function> et presque
    aussi rapide que <function>mysql_fetch_row</function> (la
    différence est insignifiante).
   </para>
  </note>
  <note>
   <para>
    <function>mysql_fetch_object</function> est identique à
    <function>mysql_fetch_array</function>, à la
    différence qu'elle retourne un objet à la place
    d'un tableau. Vous pourrez ainsi accéder aux valeurs
    des champs par leur nom, mais plus par leur offset (les
    nombres ne sont pas des noms MySQL).
   </para>
  </note>
  &database.field-case;
  &database.fetch-null;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mysql_fetch_array</function></member>
    <member><function>mysql_fetch_assoc</function></member>
    <member><function>mysql_fetch_row</function></member>
    <member><function>mysql_data_seek</function></member>
    <member><function>mysql_query</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
-->