sqlsrv-fetch-object.xml

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

<refentry xml:id="function.sqlsrv-fetch-object" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>sqlsrv_fetch_object</refname>
  <refpurpose>Devuelve la siguiente fila de datos de un conjunto resultado como un objeto</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>sqlsrv_fetch_object</methodname>
   <methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>className</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>ctorParams</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>row</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam>
  </methodsynopsis>
  <para>
   Devuelve la siguiente fila de datos de un conjunto resultado como una instancia de la clase
   especificada, donde las propiedades correspondientes a los nombres de los campos de la fila recuperada y los valores, se corresponden con
   los valores de la fila recuperada.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stmt</parameter></term>
     <listitem>
      <para>
       Un recurso de consulta creado por <function>sqlsrv_query</function> o 
       <function>sqlsrv_execute</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>className</parameter></term>
     <listitem>
      <para>
       El nombre de la clase a instanciar. Si no se especifica el nombre de la clase, 
       se instanciará la clase stdClass.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>ctorParams</parameter></term>
     <listitem>
      <para>
       Los valores pasados al constructor de la clase especificada. Si el constructor 
       de la clase especificada tiene parámetros, se proporcionará el array 
       ctorParams.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>row</parameter></term>
     <listitem>
      <para>
       La fila a la que se accederá. Este parámetro únicamente puede utilizarse si la consulta 
       especificada se preparó con un cursor con scroll. En ese caso, este parámetro 
       puede tomar uno de los siguientes valores:
       <simplelist>
        <member>SQLSRV_SCROLL_NEXT</member>
        <member>SQLSRV_SCROLL_PRIOR</member>
        <member>SQLSRV_SCROLL_FIRST</member>
        <member>SQLSRV_SCROLL_LAST</member>
        <member>SQLSRV_SCROLL_ABSOLUTE</member>
        <member>SQLSRV_SCROLL_RELATIVE</member>
       </simplelist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       Especifica la fila a la que se accederá si el parámetro de fila se ha especificado como 
       <constant>SQLSRV_SCROLL_ABSOLUTE</constant> o
       <constant>SQLSRV_SCROLL_RELATIVE</constant>. Notar que la primera fila en un 
       conjunto de resultado tiene el índice 0.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para> 
   Devuelve un objeto en caso de éxito, &null; si no hay más filas a devolver,
   y &false; si se produce un error o si la clase especificada no existe.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo con <function>sqlsrv_fetch_object</function></title>
    <para>
    El siguiente ejemplo demuestra cómo devolver una columna como un objeto stdClass.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$serverName = "serverName\sqlexpress";
$connectionInfo = array( "Database"=>"dbName", "UID"=>"username", "PWD"=>"password");
$conn = sqlsrv_connect( $serverName, $connectionInfo);
if( $conn === false ) {
     die( print_r( sqlsrv_errors(), true));
}

$sql = "SELECT fName, lName FROM Table_1";
$stmt = sqlsrv_query( $conn, $sql);
if( $stmt === false ) {
     die( print_r( sqlsrv_errors(), true));
}

// Devolver cada fila como un objeto.
// Puesto que no se especifica ninguna clase, cada fila devolverá un objeto stdClass.
// Los nombres de propiedades corresponden a nombres de campo.
while( $obj = sqlsrv_fetch_object( $stmt)) {
      echo $obj->fName.", ".$obj->lName."<br />";
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <para>
   Si se especifica un nombre de clase con el parámetro opcional $className y la  
   clase tiene propiedades cuyos nombres coinciden con los nombres de campos del conjunto de resultado, los valores correspondientes
   del conjunto de resultado se aplicarán a las propiedades. Si un nombre de campo del conjunto resultado
   no coincide con ninguna propiedad de clase, una propiedad con el nombre de campo se añadirá al
   objeto del conjunto resultado y el valor del resultado se aplicará a la propiedad. Se aplican las
   reglas siguientes cuando se utiliza el parámetro $className:
   <simplelist>
      <member>El nombre de propiedad de campo coincidente es sensible al uso de mayúsculas y minúsculas (es case sensitive).</member>
      <member>La coincidencia con la propiedad de campo se da aunque se utilicen modificadores de acceso.</member>
      <member>Los tipos de datos de la propiedad de clase se ignoran cuando se aplica un valor de campo a la propiedad.</member>
      <member>Si la clase no existe, la función devuelve &false; y añade un error a la colección de errores.</member>
   </simplelist>
   A pesar de que se defina el parámetro $className, si se devuelve un campo sin 
   nombre, el valor de campo será ignorado y se añadirá una alerta
   a la colección de errores.
  </para>
  <para>
   Cuando se trate un conjunto de resultado que tenga varias columnas con el mismo nombre, podría
   ser mejor utilizar <function>sqlsrv_fetch_array</function> o la combinación de 
   <function>sqlsrv_fetch</function> y <function>sqlsrv_get_field</function>.
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>sqlsrv_fetch</function></member>
    <member><function>sqlsrv_fetch_array</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
-->