db2-fetch-object.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e41806c30bf6975e452c0d4ce35ab0984c2fa68c Maintainer: tardeenfamenor Status: ready -->
<!-- Reviewed: no -->

<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.db2-fetch-object" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_fetch_object</refname>
  <refpurpose>
   Devolver un objeto con atributos que representan a las columnas de una fila extraida
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>object</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>
   Devuelve un objeto en el que cada atributo representa una columna devuelta de una 
   fila extraida del bloque de resultados.
  </para>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stmt</parameter></term>
     <listitem>
      <para>
       Un recurso <literal>stmt</literal> válido que contenga el bloque de resultados.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>row_number</parameter></term>
     <listitem>
      <para>
       Solicita una fila específica, indexada a partir de uno, del bloque de resultados. Este parámetro provoca 
       una advertencia de PHP si los resultados utilizan cursor de no-recorrido.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve un objeto que representa una fila del bloque de resultados. Los 
   atributos del objeto son creados a partir de los nombres de las columnas del resultado.
  </para>
  <para>
   Los servidores de base de datos como IBM DB2, Cloudscape, y Apache Derby usualmente convierten a 
   mayúsculas los nombres de las columnas por lo que esto se verá reflejado en los atributos del objeto. 
  </para>
  <para>
   Si una sentencia SELECT a su vez llama a una función escalar para modificar el valor 
   de una columna, los servidores de base de datos devuelven el número de la columna como si 
   fuera el nombre de la misma para ser usada como atributo. Si se quiere un nombre de columna más 
   descriptivo, se puede usar la clausula AS para asignar un alias a la columna del resultado.
  </para>
  <para>
   Devuelve &false; si no hay fila devuelta.
  </para>
 </refsect1>

<refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>db2_fetch_object</function></title>
    <para>
     El siguiente ejemplo ejecuta una sentencia SELECT con una función escalar 
     (RTRIM) que elimina espacios al final de la columna. En lugar de 
     crear un objeto con las propiedades "BREED" y "2", se utilizará la claúsula AS
     en la sentencia SELECT para asignar el nombre "name" a la columna modificada. 
     El servidor de base de datos convierte los nombres de las columnas a mayúsculas,
     lo que resultará en un objeto con los atributos "BREED" y "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
-->