<!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>Returns the server associated with this cursor</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-cursor.getid.html">MongoDB\Driver\Cursor::getId</a></div> <div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-cursor.isdead.html">MongoDB\Driver\Cursor::isDead</a></div> <div class="up"><a href="class.mongodb-driver-cursor.html">MongoDB\Driver\Cursor</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="mongodb-driver-cursor.getserver" class="refentry"> <div class="refnamediv"> <h1 class="refname">MongoDB\Driver\Cursor::getServer</h1> <p class="verinfo">(mongodb >=1.0.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\Cursor::getServer</span> — <span class="dc-title">Returns the server associated with this cursor</span></p> </div> <div class="refsect1 description" id="refsect1-mongodb-driver-cursor.getserver-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">final</span> <span class="modifier">public</span> <span class="type"><span class="type MongoDB\Driver\Server">MongoDB\Driver\Server</span></span> <span class="methodname"><strong>MongoDB\Driver\Cursor::getServer</strong></span> ( <span class="methodparam">void</span> )</div> <p class="para rdfs-comment"> Returns the <a href="class.mongodb-driver-server.html" class="classname">MongoDB\Driver\Server</a> associated with this cursor. This is the server that executed the <a href="class.mongodb-driver-query.html" class="classname">MongoDB\Driver\Query</a> or <a href="class.mongodb-driver-command.html" class="classname">MongoDB\Driver\Command</a>. </p> </div> <div class="refsect1 parameters" id="refsect1-mongodb-driver-cursor.getserver-parameters"> <h3 class="title">Parameters</h3> <p class="para">This function has no parameters.</p> </div> <div class="refsect1 returnvalues" id="refsect1-mongodb-driver-cursor.getserver-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns the <a href="class.mongodb-driver-server.html" class="classname">MongoDB\Driver\Server</a> associated with this cursor. </p> </div> <div class="refsect1 errors" id="refsect1-mongodb-driver-cursor.getserver-errors"> <h3 class="title">Errors/Exceptions</h3> <ul class="simplelist"> <li class="member">Throws <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> on argument parsing errors.</li> </ul> </div> <div class="refsect1 examples" id="refsect1-mongodb-driver-cursor.getserver-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-1725"> <p><strong>Example #1 <span class="function"><strong>MongoDB\Driver\Cursor::getServer()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br />$manager </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">Manager</span><span style="color: #007700">(</span><span style="color: #DD0000">"mongodb://localhost:27017"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$query </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">Query</span><span style="color: #007700">([]);<br /><br /></span><span style="color: #0000BB">$bulk </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">BulkWrite</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$bulk</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">([</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">$manager</span><span style="color: #007700">-></span><span style="color: #0000BB">executeBulkWrite</span><span style="color: #007700">(</span><span style="color: #DD0000">'db.collection'</span><span style="color: #007700">, </span><span style="color: #0000BB">$bulk</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$cursor </span><span style="color: #007700">= </span><span style="color: #0000BB">$manager</span><span style="color: #007700">-></span><span style="color: #0000BB">executeQuery</span><span style="color: #007700">(</span><span style="color: #DD0000">'db.collection'</span><span style="color: #007700">, </span><span style="color: #0000BB">$query</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">getServer</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> object(MongoDB\Driver\Server)#5 (10) { ["host"]=> string(9) "localhost" ["port"]=> int(27017) ["type"]=> int(1) ["is_primary"]=> bool(false) ["is_secondary"]=> bool(false) ["is_arbiter"]=> bool(false) ["is_hidden"]=> bool(false) ["is_passive"]=> bool(false) ["last_is_master"]=> array(8) { ["ismaster"]=> bool(true) ["maxBsonObjectSize"]=> int(16777216) ["maxMessageSizeBytes"]=> int(48000000) ["maxWriteBatchSize"]=> int(1000) ["localTime"]=> object(MongoDB\BSON\UTCDateTime)#6 (1) { ["milliseconds"]=> int(1446505367907) } ["maxWireVersion"]=> int(3) ["minWireVersion"]=> int(0) ["ok"]=> float(1) } ["round_trip_time"]=> int(584) } </pre></div> </div> </div> </div> <div class="refsect1 seealso" id="refsect1-mongodb-driver-cursor.getserver-seealso"> <h3 class="title">See Also</h3> <ul class="simplelist"> <li class="member"><a href="class.mongodb-driver-server.html" class="classname">MongoDB\Driver\Server</a></li> </ul> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-cursor.getid.html">MongoDB\Driver\Cursor::getId</a></div> <div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-cursor.isdead.html">MongoDB\Driver\Cursor::isDead</a></div> <div class="up"><a href="class.mongodb-driver-cursor.html">MongoDB\Driver\Cursor</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>