<!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>Counts the number of results for this query</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongocursor.construct.html">MongoCursor::__construct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongocursor.current.html">MongoCursor::current</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.count" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoCursor::count</h1>
<p class="verinfo">(PECL mongo >=0.9.2)</p><p class="refpurpose"><span class="refname">MongoCursor::count</span> — <span class="dc-title">Counts the number of results for this query</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongocursor.count-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><strong>MongoCursor::count</strong></span>
([ <span class="methodparam"><span class="type">bool</span> <code class="parameter">$foundOnly</code><span class="initializer"> = <strong><code>FALSE</code></strong></span></span>
] )</div>
<p class="para rdfs-comment">
This method does not affect the state of the cursor: if you haven't queried
yet, you can still apply limits, skips, etc. If you have started iterating
through results, it will not move the current position of the cursor. If you
have exhasted the cursor, it will not reset it.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mongocursor.count-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term">
<em><code class="parameter">foundOnly</code></em>
</span>
<dd>
<p class="para">
Send cursor limit and skip information to the count function, if applicable.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongocursor.count-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The number of documents returned by this cursor's query.
</p>
</div>
<div class="refsect1 examples" id="refsect1-mongocursor.count-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1478">
<p><strong>Example #1 <span class="function"><strong>MongoCursor::count()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$collection</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'x'</span><span style="color: #007700">=></span><span style="color: #0000BB">1</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$collection</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'x'</span><span style="color: #007700">=></span><span style="color: #0000BB">2</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$collection</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'x'</span><span style="color: #007700">=></span><span style="color: #0000BB">3</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">$cursor </span><span style="color: #007700">= </span><span style="color: #0000BB">$collection</span><span style="color: #007700">-></span><span style="color: #0000BB">find</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$cursor</span><span style="color: #007700">-></span><span style="color: #0000BB">count</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$cursor</span><span style="color: #007700">-></span><span style="color: #0000BB">count</span><span style="color: #007700">(</span><span style="color: #0000BB">true</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">$cursor</span><span style="color: #007700">-></span><span style="color: #0000BB">limit</span><span style="color: #007700">(</span><span style="color: #0000BB">2</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$cursor</span><span style="color: #007700">-></span><span style="color: #0000BB">count</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$cursor</span><span style="color: #007700">-></span><span style="color: #0000BB">count</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>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
int(3)
int(3)
int(3)
int(2)
</pre></div>
</div>
</div>
</div>
<div class="refsect1 errors" id="refsect1-mongocursor.count-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws <a href="class.mongoconnectionexception.html" class="classname">MongoConnectionException</a> if it cannot reach the
database.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongocursor.construct.html">MongoCursor::__construct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongocursor.current.html">MongoCursor::current</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>
