php-doc-en/reference/pdo/pdostatement/fetchobject.xml

89 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="pdostatement.fetchobject" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>PDOStatement::fetchObject</refname>
<refpurpose>Fetches the next row and returns it as an object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>object</type><type>false</type></type><methodname>PDOStatement::fetchObject</methodname>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>class</parameter><initializer>"stdClass"</initializer></methodparam>
<methodparam choice="opt"><type>array</type><parameter>constructorArgs</parameter><initializer>[]</initializer></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>
<para>
When an object is fetched, its properties are assigned from respective
column values, and afterwards its constructor is invoked.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>class</parameter></term>
<listitem>
<para>
Name of the created class.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>constructorArgs</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 &return.falseforfailure;.
</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:"~/.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
-->