<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/mongodb.mongodb.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'class.mongodb-driver-cursorinterface.php',
    1 => 'MongoDB\\Driver\\CursorInterface',
    2 => 'The MongoDB\\Driver\\CursorInterface interface',
  ),
  'up' => 
  array (
    0 => 'mongodb.mongodb.php',
    1 => 'MongoDB\\Driver',
  ),
  'prev' => 
  array (
    0 => 'mongodb-driver-cursorid.tostring.php',
    1 => 'MongoDB\\Driver\\CursorId::__toString',
  ),
  'next' => 
  array (
    0 => 'mongodb-driver-cursorinterface.getid.php',
    1 => 'MongoDB\\Driver\\CursorInterface::getId',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/mongodb/mongodb/driver/cursorinterface.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.mongodb-driver-cursorinterface.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.mongodb-driver-cursorinterface" class="reference">

 <h1 class="title">The MongoDB\Driver\CursorInterface interface</h1>
 

 <div class="partintro"><p class="verinfo">(mongodb &gt;=1.6.0)</p>

  
  <div class="section" id="mongodb-driver-cursorinterface.intro">
   <h2 class="title">Introduction</h2>
   <p class="para">
    This interface is implemented by
    <span class="classname"><a href="class.mongodb-driver-cursor.php" class="classname">MongoDB\Driver\Cursor</a></span> to be used as
    a parameter, return, or property type in userland classes.
   </p>
  </div>


  <div class="section" id="mongodb-driver-cursorinterface.synopsis">
   <h2 class="title">Class synopsis</h2>


   <div class="classsynopsis">
    <span class="ooclass"><strong class="classname"></strong></span>


    <div class="classsynopsisinfo">
     <span class="ooclass">
      <span class="modifier">class</span> <strong class="classname">MongoDB\Driver\CursorInterface</strong>
     </span>

     <span class="oointerface"><span class="modifier">implements</span> 
       <a href="class.iterator.php" class="interfacename">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="methodname"><a href="mongodb-driver-cursorinterface.getid.php" class="methodname">getId</a></span>(): <span class="type"><a href="class.mongodb-bson-int64.php" class="type MongoDB\BSON\Int64">MongoDB\BSON\Int64</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">abstract</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-driver-cursorinterface.getserver.php" class="methodname">getServer</a></span>(): <span class="type"><a href="class.mongodb-driver-server.php" class="type MongoDB\Driver\Server">MongoDB\Driver\Server</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">abstract</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-driver-cursorinterface.isdead.php" class="methodname">isDead</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">abstract</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-driver-cursorinterface.settypemap.php" class="methodname">setTypeMap</a></span>(<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$typemap</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">abstract</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-driver-cursorinterface.toarray.php" class="methodname">toArray</a></span>(): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>

   }</div>


  </div>

  <div class="section">
   <h2 class="title">Changelog</h2>
   <p class="para">
    <table class="doctable informaltable">
     
      <thead>
       <tr>
        <th>Version</th>
        <th>Description</th>
       </tr>

      </thead>

      <tbody class="tbody">
       <tr>
        <td>PECL mongodb 2.0.0</td>
        <td>
         <p class="para">
          This interface now extends <span class="interfacename"><a href="class.iterator.php" class="interfacename">Iterator</a></span>.
         </p>
         <p class="para">
          Return types previously declared as tentative are now enforced.
         </p>
        </td>
       </tr>

       
       <tr>
        <td>PECL mongodb 1.15.0</td>
        <td>
         Return types for methods are declared as tentative on PHP 8.0 and newer,
         triggering deprecation notices in code that implements this interface
         without declaring the appropriate return types. The <code class="code">#[ReturnTypeWillChange]</code>
         attribute can be added to silence the deprecation notice.
        </td>
       </tr>


      </tbody>
     
    </table>

   </p>
  </div>

 </div>

 
 






 






 






 






 






<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="mongodb-driver-cursorinterface.getid.php">MongoDB\Driver\CursorInterface::getId</a> — Returns the ID for this cursor</li><li><a href="mongodb-driver-cursorinterface.getserver.php">MongoDB\Driver\CursorInterface::getServer</a> — Returns the server associated with this cursor</li><li><a href="mongodb-driver-cursorinterface.isdead.php">MongoDB\Driver\CursorInterface::isDead</a> — Checks if the cursor may have additional results</li><li><a href="mongodb-driver-cursorinterface.settypemap.php">MongoDB\Driver\CursorInterface::setTypeMap</a> — Sets a type map to use for BSON unserialization</li><li><a href="mongodb-driver-cursorinterface.toarray.php">MongoDB\Driver\CursorInterface::toArray</a> — Returns an array containing all results for this cursor</li></ul>
</div>
<?php manual_footer($setup); ?>