<!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>The MongoCursorInterface interface</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongocursor.valid.html">MongoCursor::valid</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongocursorinterface.batchsize.html">MongoCursorInterface::batchSize</a></div>
<div class="up"><a href="mongo.core.html">Core Classes</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.mongocursorinterface" class="reference">
<h1 class="title">The MongoCursorInterface interface</h1>
<div class="partintro"><p class="verinfo">(PECL mongo >=1.5.0)</p>
<div class="section" id="mongocursorinterface.intro">
<h2 class="title">Introduction</h2>
<p class="para">
Interface for cursors, which can be used to iterate through results of a
database query or command. This interface is implemented by the
<a href="class.mongocursor.html" class="classname">MongoCursor</a> and
<a href="class.mongocommandcursor.html" class="classname">MongoCommandCursor</a> classes.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="simpara">
Similar to <a href="class.traversable.html" class="classname">Traversable</a>, this interface cannot be
implemented in PHP scripts.
</span>
</p></blockquote>
</div>
<div class="section" id="mongocursorinterface.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">MongoCursorInterface</strong>
</span>
<span class="ooclass">
<span class="modifier">extends</span>
<a href="class.iterator.html" class="classname">Iterator</a>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">MongoCursorInterface</span> <span class="methodname"><a href="mongocursorinterface.batchsize.html" class="methodname">batchSize</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$batchSize</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="mongocursorinterface.dead.html" class="methodname">dead</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="mongocursorinterface.getreadpreference.html" class="methodname">getReadPreference</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="mongocursorinterface.info.html" class="methodname">info</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">MongoCursorInterface</span> <span class="methodname"><a href="mongocursorinterface.setreadpreference.html" class="methodname">setReadPreference</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$read_preference</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$tags</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">MongoCursorInterface</span> <span class="methodname"><a href="mongocursorinterface.timeout.html" class="methodname">timeout</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$ms</code></span>
)</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Inherited methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="iterator.current.html" class="methodname">Iterator::current</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">scalar</span> <span class="methodname"><a href="iterator.key.html" class="methodname">Iterator::key</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="iterator.next.html" class="methodname">Iterator::next</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="iterator.rewind.html" class="methodname">Iterator::rewind</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="iterator.valid.html" class="methodname">Iterator::valid</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="mongocursorinterface.batchsize.html">MongoCursorInterface::batchSize</a> — Limits the number of elements returned in one batch</li><li><a href="mongocursorinterface.dead.html">MongoCursorInterface::dead</a> — Checks if there are results that have not yet been sent from the database</li><li><a href="mongocursorinterface.getreadpreference.html">MongoCursorInterface::getReadPreference</a> — Get the read preference for this query</li><li><a href="mongocursorinterface.info.html">MongoCursorInterface::info</a> — Gets information about the cursor's creation and iteration</li><li><a href="mongocursorinterface.setreadpreference.html">MongoCursorInterface::setReadPreference</a> — Set the read preference for this query</li><li><a href="mongocursorinterface.timeout.html">MongoCursorInterface::timeout</a> — Sets a client-side timeout for this query</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongocursor.valid.html">MongoCursor::valid</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongocursorinterface.batchsize.html">MongoCursorInterface::batchSize</a></div>
<div class="up"><a href="mongo.core.html">Core Classes</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
