Source of: /manual/en/pdostatement.setfetchmode.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.pdostatement.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'pdostatement.setfetchmode.php',
1 => 'PDOStatement->setFetchMode',
),
'up' =>
array (
0 => 'class.pdostatement.php',
1 => 'The PDOStatement class',
),
'prev' =>
array (
0 => 'pdostatement.setattribute.php',
1 => 'PDOStatement->setAttribute',
),
'next' =>
array (
0 => 'class.pdoexception.php',
1 => 'PDOException',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="pdostatement.setfetchmode" class="refentry">
<div class="refnamediv">
<h1 class="refname">PDOStatement->setFetchMode</h1>
<p class="verinfo">(PHP 5 >= 5.1.0, PECL pdo >= 0.2.0)</p><p class="refpurpose"><span class="refname">PDOStatement->setFetchMode</span> — <span class="dc-title">
Set the default fetch mode for this statement
</span></p>
</div>
<a name="pdostatement.setfetchmode.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>PDOStatement::setFetchMode</b></span>
( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$mode</tt></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>PDOStatement::setFetchMode</b></span>
( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$PDO::FETCH_COLUMN</tt></span>
, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$colno</tt></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>PDOStatement::setFetchMode</b></span>
( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$PDO::FETCH_CLASS</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$classname</tt></span>
, <span class="methodparam"><span class="type">array</span> <tt class="parameter">$ctorargs</tt></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>PDOStatement::setFetchMode</b></span>
( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$PDO::FETCH_INTO</tt></span>
, <span class="methodparam"><span class="type">object</span> <tt class="parameter">$object</tt></span>
)</div>
</div>
<a name="pdostatement.setfetchmode.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">mode</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The fetch mode must be one of the <i>PDO::FETCH_*</i> constants.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">colno</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Column number.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">classname</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Class name.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">ctorargs</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Constructor arguments.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">object</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Object.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="pdostatement.setfetchmode.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <i>1</i> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="pdostatement.setfetchmode.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 Setting the fetch mode</b></p>
<div class="example-contents para"><p>
The following example demonstrates how
<b>PDOStatement::setFetchMode()</b> changes the default fetch
mode for a PDOStatement object.
</p></div>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$sql </span><span style="color: #007700">= </span><span style="color: #DD0000">'SELECT name, colour, calories FROM fruit'</span><span style="color: #007700">;<br />try {<br /> </span><span style="color: #0000BB">$stmt </span><span style="color: #007700">= </span><span style="color: #0000BB">$dbh</span><span style="color: #007700">-></span><span style="color: #0000BB">query</span><span style="color: #007700">(</span><span style="color: #0000BB">$sql</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$stmt</span><span style="color: #007700">-></span><span style="color: #0000BB">setFetchMode</span><span style="color: #007700">(</span><span style="color: #0000BB">PDO</span><span style="color: #007700">::</span><span style="color: #0000BB">FETCH_NUM</span><span style="color: #007700">);<br /> while (</span><span style="color: #0000BB">$row </span><span style="color: #007700">= </span><span style="color: #0000BB">$stmt</span><span style="color: #007700">-></span><span style="color: #0000BB">fetch</span><span style="color: #007700">()) {<br /> print </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #0000BB">0</span><span style="color: #007700">] . </span><span style="color: #DD0000">"\t" </span><span style="color: #007700">. </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #0000BB">1</span><span style="color: #007700">] . </span><span style="color: #DD0000">"\t" </span><span style="color: #007700">. </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #0000BB">2</span><span style="color: #007700">] . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> }<br />}<br />catch (</span><span style="color: #0000BB">PDOException $e</span><span style="color: #007700">) {<br /> print </span><span style="color: #0000BB">$e</span><span style="color: #007700">-></span><span style="color: #0000BB">getMessage</span><span style="color: #007700">();<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents para"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
apple red 150
banana yellow 250
orange orange 300
kiwi brown 75
lemon yellow 25
pear green 150
watermelon pink 90
</pre></div>
</div>
</div><p>
</p>
</div>
</div><?php manual_footer(); ?>
