php-doc-en/reference/mysqli/functions/mysqli-fetch-object.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.18 $ -->
<refentry id="function.mysqli-fetch-object">
 <refnamediv>
  <refname>mysqli_fetch_object</refname>
  <refname>result->fetch_object</refname>
  <refpurpose>Returns the current row of a result set as an object</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <para>Procedural style:</para>
  <methodsynopsis>
   <type>object</type><methodname>mysqli_fetch_object</methodname>
   <methodparam><type>mysqli_result</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>Object oriented style (method):</para>
  <classsynopsis>
   <ooclass><classname>mysqli_result</classname></ooclass>
   <methodsynopsis>
    <type>object</type><methodname>fetch_object</methodname>
    <methodparam choice="opt"><type>string</type><parameter>class_name</parameter></methodparam>
    <methodparam choice="opt"><type>array</type><parameter>params</parameter></methodparam>
   </methodsynopsis>
  </classsynopsis>    
  <para>
   The <function>mysqli_fetch_object</function> will return the current row result set 
   as an object where the attributes of the object represent the names of the fields found
   within the result set. If no more rows exist in the current result set, &null; is returned.
  </para>
 </refsect1>
 <refsect1>
  &reftitle.returnvalues;
  <para>
   Returns an object that corresponds to the fetched row or &null; if there are no more rows in resultset.
  </para>
  &database.field-case;
  &database.fetch-null;
 </refsect1>
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.0.0</entry>
       <entry>
        Added the ability to return as a different object.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 <refsect1>
  &reftitle.seealso;
  <para>
   <function>mysqli_fetch_array</function>,
   <function>mysqli_fetch_assoc</function>,
   <function>mysqli_fetch_row</function>,
   <function>mysqli_query</function>&listendand;
   <function>mysqli_data_seek</function>.
  </para>
 </refsect1>
 <refsect1>
  &reftitle.examples;
  <example>
   <title>Object oriented style</title>
   <programlisting role="php">
<![CDATA[
<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");

/* check connection */
if (mysqli_connect_errno()) {
    printf("Connect failed: %s\n", mysqli_connect_error());
    exit();
}
 
$query = "SELECT Name, CountryCode FROM City ORDER by ID DESC LIMIT 50,5";

if ($result = $mysqli->query($query)) {

    /* fetch object array */
    while ($obj = $result->fetch_object()) {
        printf ("%s (%s)\n", $obj->Name, $obj->CountryCode);
    }

    /* free result set */
    $result->close();
}

/* close connection */
$mysqli->close();
?>
]]>
   </programlisting>
  </example>
  <example>
   <title>Procedural style</title>
   <programlisting role="php">
<![CDATA[
<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "world");

/* check connection */
if (mysqli_connect_errno()) {
    printf("Connect failed: %s\n", mysqli_connect_error());
    exit();
}

$query = "SELECT Name, CountryCode FROM City ORDER by ID DESC LIMIT 50,5";

if ($result = mysqli_query($link, $query)) {

    /* fetch associative array */
    while ($obj = mysqli_fetch_object($result)) {
        printf ("%s (%s)\n", $obj->Name, $obj->CountryCode);
    }

    /* free result set */
    mysqli_free_result($result);
}

/* close connection */
mysqli_close($link);
?>
]]>
   </programlisting>
  </example>
  &example.outputs;
  <screen>
<![CDATA[
Pueblo (USA)
Arvada (USA)
Cape Coral (USA)
Green Bay (USA)
Santa Clara (USA)
]]>
  </screen>
 </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:"../../../../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
-->