mysql-fetch-object.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ff4017b6334dae2d5353fe99df8089a828795324 Maintainer: carlos Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->
<refentry xml:id="function.mysql-fetch-object" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mysql_fetch_object</refname>
  <refpurpose>Recupera una fila de resultados como un objeto</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <warning>
   &mysql.alternative.note;
   <simplelist role="alternatives">
    <member><function>mysqli_fetch_object</function></member>
    <member>
     <methodname>PDOStatement::fetch</methodname>
     con <parameter>mode</parameter> como <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>
   Devuelve un objeto con propiedades que corresponden a la fila recuperada
   y mueve el puntero interno hacia delante.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &mysql.result.description;
    <varlistentry>
     <term><parameter>class_name</parameter></term>
     <listitem>
      <para>
       El nombre de la clase donde instanciar, configurar las propiedades y devolver.
       Si no se especifica, se devuelve un objeto <classname>stdClass</classname>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>params</parameter></term>
     <listitem>
      <para>
       Un <type>array</type> opcional de parámetros para pasar al constructor
       de los objetos <parameter>class_name</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve un <type>object</type> con propiedades de tipo string que se corresponden con la
   fila recuperada, o &false; si no quedan más filas.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>mysql_fetch_object</function></title>
    <programlisting role="php">
<![CDATA[
<?php
mysql_connect("nombre_anfitrión", "usuario", "contraseña");
mysql_select_db("mibd");
$resultado = mysql_query("select * from mitabla");
while ($fila = mysql_fetch_object($resultado)) {
    echo $fila->id_usuario;
    echo $fila->nombre_completo;
}
mysql_free_result($resultado);
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Ejemplo de <function>mysql_fetch_object</function></title>
    <programlisting role="php">
<![CDATA[
<?php
class foo {
    public $nombre;
}

mysql_connect("nombre_anfitrión", "usuario", "contraseña");
mysql_select_db("mibd");

$resultado = mysql_query("select nombre from mitabla limit 1");
$objeto = mysql_fetch_object($resultado, 'foo');
var_dump($objeto);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <title>Rendimiento</title>
   <para>
    En cuestión de velocidad, la función es idéntica a
    <function>mysql_fetch_array</function>, y casi tan rápida como
    <function>mysql_fetch_row</function> (la diferencia es
    insignificante).
   </para>
  </note>
  <note>
   <para>
    <function>mysql_fetch_object</function> es similar a
    <function>mysql_fetch_array</function>, con una diferencia: se
    devuelve un objeto, en lugar de un array. Indirectamente, esto significa
    que se puede acceder a los datos únicamente mediante los nombres de los campos, y no
    mediante sus índices (los números son ilegales como nombres de propiedades).
   </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
-->