php-doc-en/reference/ingres-ii/functions/ingres-fetch-object.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ingres-fetch-object" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ingres_fetch_object</refname>
  <refpurpose>Fetch a row of result into an object</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>object</type><methodname>ingres_fetch_object</methodname>
   <methodparam><type>resource</type><parameter>result</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam>
  </methodsynopsis>
  <para>
   This function is similar to
   <function>ingres_fetch_array</function>, with one difference - an
   object is returned instead of an array.  Indirectly, this means
   that you can access the data only by the field names and not by
   their offsets (numbers are illegal property names).
  </para>
  <para>
   With regard to speed, the function is identical to
   <function>ingres_fetch_array</function>, and almost as quick as
   <function>ingres_fetch_row</function> (the difference is
   insignificant).
  </para>
  <note>
   <title>Related Configurations</title>
   <para>
    See also the <link
    linkend="ini.ingres.fetch-buffer-size">ingres.fetch_buffer_size</link>
    and <link linkend="ini.ingres.utf8">ingres.utf8</link>
    directives in <link linkend="ingres.configuration">Runtime
    Configuration</link>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>link</parameter></term>
     <listitem>
      <para>
       The query result identifier
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>result_type</parameter></term>
     <listitem>
      <para>
       (Optional argument.) <parameter>result_type</parameter> is a
       constant and can take the following values: <constant>INGRES_ASSOC</constant>,
       <constant>INGRES_NUM</constant>, and <constant>INGRES_BOTH</constant>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an object that corresponds to the fetched row,
   or &false; if there are no more rows
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Fetch a row into an object</title>
    <programlisting role="php">
<![CDATA[
<?php
$link = ingres_connect($database, $user, $password);
$result = ingres_query($link, "select * from table");
while ($row = ingres_fetch_object($result)) {
    echo $row->user_id;
    echo $row->fullname;
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ingres_query</function></member>
    <member><function>ingres_num_fields</function></member>
    <member><function>ingres_field_name</function></member>
    <member><function>ingres_fetch_array</function></member>
    <member><function>ingres_fetch_assoc</function></member>
    <member><function>ingres_fetch_row</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
-->