<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Sets the fields for a query</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongocursor.explain.html">MongoCursor::explain</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongocursor.getnext.html">MongoCursor::getNext</a></div>
<div class="up"><a href="class.mongocursor.html">MongoCursor</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongocursor.fields" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoCursor::fields</h1>
<p class="verinfo">(PECL mongo >=1.0.6)</p><p class="refpurpose"><span class="refname">MongoCursor::fields</span> — <span class="dc-title">Sets the fields for a query</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongocursor.fields-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="class.mongocursor.html" class="type MongoCursor">MongoCursor</a></span> <span class="methodname"><strong>MongoCursor::fields</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$f</code></span>
)</div>
<p class="para rdfs-comment">
Fields are specified by <em>"fieldname" : bool</em>. <strong><code>TRUE</code></strong>
indicates that a field should be returned, <strong><code>FALSE</code></strong> indicates that it should
not be returned. You can also use 1 and 0 instead of <strong><code>TRUE</code></strong> and <strong><code>FALSE</code></strong>.
</p>
<p class="para">
Thus, to return only the "summary" field, one could say:
</p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$cursor</span><span style="color: #007700">-></span><span style="color: #0000BB">fields</span><span style="color: #007700">(array(</span><span style="color: #DD0000">"summary" </span><span style="color: #007700">=> </span><span style="color: #0000BB">true</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<p class="para">
To return all fields except the "hidden" field:
</p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$cursor</span><span style="color: #007700">-></span><span style="color: #0000BB">fields</span><span style="color: #007700">(array(</span><span style="color: #DD0000">"hidden" </span><span style="color: #007700">=> </span><span style="color: #0000BB">false</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="refsect1 parameters" id="refsect1-mongocursor.fields-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term">
<em><code class="parameter">f</code></em>
</span>
<dd>
<p class="para">
Fields to return (or not return).
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongocursor.fields-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns this cursor.
</p>
</div>
<div class="refsect1 errors" id="refsect1-mongocursor.fields-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws <a href="class.mongocursorexception.html" class="classname">MongoCursorException</a> if this cursor has started
iterating or a scalar argument is given.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongocursor.explain.html">MongoCursor::explain</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongocursor.getnext.html">MongoCursor::getNext</a></div>
<div class="up"><a href="class.mongocursor.html">MongoCursor</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
