Document fetchObject (bug #35862)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@204478 c90b9560-bf6c-de11-be94-00142212c4b1

reference/pdo/functions/PDOStatement-fetchObject.xml

@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. -->
+<refentry id="function.PDOStatement-fetchObject">
+ <refnamediv>
+  <refname>PDOStatement::fetchObject</refname>
+  <refpurpose>Fetches the next row and returns it as an object.</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>mixed</type><methodname>PDOStatement::fetchObject</methodname>
+   <methodparam choice="opt"><type>string</type><parameter>class_name</parameter></methodparam>
+   <methodparam choice="opt"><type>array</type><parameter>ctor_args</parameter></methodparam>
+  </methodsynopsis>
+
+  <para>
+   Fetches the next row and returns it as an object. This function is an
+   alternative to <function>PDOStatement::fetch</function> with
+   <constant>PDO::FETCH_CLASS</constant> or
+   <constant>PDO::FETCH_OBJ</constant> style.
+  </para>
+
+ </refsect1>
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>class_name</parameter></term>
+     <listitem>
+      <para>
+       Name of the created class, defaults to <literal>stdClass</literal>.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>ctor_args</parameter></term>
+     <listitem>
+      <para>
+       Elements of this array are passed to the constructor.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns an instance of the required class with property names that
+   correspond to the column names or &false; in case of an error.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>PDOStatement::fetch</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:"../../../../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
+-->