php-doc-en/reference/pdo/pdostatement/setfetchmode.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

169 lines
4.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="pdostatement.setfetchmode" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>PDOStatement->setFetchMode</refname>
<refpurpose>
Set the default fetch mode for this statement
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>PDOStatement::setFetchMode</methodname>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>PDOStatement::setFetchMode</methodname>
<methodparam><type>int</type><parameter>PDO::FETCH_COLUMN</parameter></methodparam>
<methodparam><type>int</type><parameter>colno</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>PDOStatement::setFetchMode</methodname>
<methodparam><type>int</type><parameter>PDO::FETCH_CLASS</parameter></methodparam>
<methodparam><type>string</type><parameter>classname</parameter></methodparam>
<methodparam><type>array</type><parameter>ctorargs</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>PDOStatement::setFetchMode</methodname>
<methodparam><type>int</type><parameter>PDO::FETCH_INTO</parameter></methodparam>
<methodparam><type>object</type><parameter>object</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
The fetch mode must be one of the <literal>PDO::FETCH_*</literal> constants.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>colno</parameter></term>
<listitem>
<para>
Column number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>classname</parameter></term>
<listitem>
<para>
Class name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ctorargs</parameter></term>
<listitem>
<para>
Constructor arguments.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>object</parameter></term>
<listitem>
<para>
Object.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns <literal>1</literal> on success&return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Setting the fetch mode</title>
<para>
The following example demonstrates how
<function>PDOStatement::setFetchMode</function> changes the default fetch
mode for a PDOStatement object.
</para>
<programlisting role="php">
<![CDATA[
<?php
$sql = 'SELECT name, colour, calories FROM fruit';
try {
$stmt = $dbh->query($sql);
$result = $stmt->setFetchMode(PDO::FETCH_NUM);
while ($row = $stmt->fetch()) {
print $row[0] . "\t" . $row[1] . "\t" . $row[2] . "\n";
}
}
catch (PDOException $e) {
print $e->getMessage();
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
apple red 150
banana yellow 250
orange orange 300
kiwi brown 75
lemon yellow 25
pear green 150
watermelon pink 90
]]>
</screen>
</example>
</para>
</refsect1>
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></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
-->