<!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>Get the read preference for this command</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongocommandcursor.dead.html">MongoCommandCursor::dead</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongocommandcursor.info.html">MongoCommandCursor::info</a></div>
<div class="up"><a href="class.mongocommandcursor.html">MongoCommandCursor</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongocommandcursor.getreadpreference" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoCommandCursor::getReadPreference</h1>
<p class="verinfo">(PECL mongo >=1.6.0)</p><p class="refpurpose"><span class="refname">MongoCommandCursor::getReadPreference</span> — <span class="dc-title">Get the read preference for this command</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongocommandcursor.getreadpreference-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><strong>MongoCommandCursor::getReadPreference</strong></span>
( <span class="methodparam">void</span>
)</div>
</div>
<div class="refsect1 parameters" id="refsect1-mongocommandcursor.getreadpreference-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongocommandcursor.getreadpreference-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">This function returns an array describing the read preference. The array contains the values <em>type</em> for the string read preference mode (corresponding to the <a href="class.mongoclient.html" class="classname">MongoClient</a> constants), and <em>tagsets</em> containing a list of all tag set criteria. If no tag sets were specified, <em>tagsets</em> will not be present in the array.</p>
</div>
<div class="refsect1 examples" id="refsect1-mongocommandcursor.getreadpreference-examples">
<h3 class="title">Examples</h3>
<div class="example" id="mongocursor.doquery.example.basic">
<p><strong>Example #1 <span class="methodname"><strong>MongoCommandCursor::getReadPreference()</strong></span> return value example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$m </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoClient</span><span style="color: #007700">(</span><span style="color: #DD0000">'mongodb://rs1.example.com:27017'</span><span style="color: #007700">, array(</span><span style="color: #DD0000">'replicaSet' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'myReplSetName'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$collection </span><span style="color: #007700">= </span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">selectCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">'test'</span><span style="color: #007700">, </span><span style="color: #DD0000">'people'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// If a MongoCommandCursor is constructed directly, it will inherit the read<br />// preference of the MongoClient instance passed to its constructor; however,<br />// MongoCollection::aggregateCursor() will have the MongoCommandCursor inherit<br />// the collection's read preference.<br /></span><span style="color: #0000BB">$collection</span><span style="color: #007700">-></span><span style="color: #0000BB">setReadPreference</span><span style="color: #007700">(</span><span style="color: #0000BB">MongoClient</span><span style="color: #007700">::</span><span style="color: #0000BB">RP_SECONDARY</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">aggregateCursor</span><span style="color: #007700">( [<br /> [ </span><span style="color: #DD0000">'$group' </span><span style="color: #007700">=> [ </span><span style="color: #DD0000">'_id' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'$name'</span><span style="color: #007700">, </span><span style="color: #DD0000">'points' </span><span style="color: #007700">=> [ </span><span style="color: #DD0000">'$sum' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'$points' </span><span style="color: #007700">] ] ],<br /> [ </span><span style="color: #DD0000">'$sort' </span><span style="color: #007700">=> [ </span><span style="color: #DD0000">'points' </span><span style="color: #007700">=> -</span><span style="color: #0000BB">1 </span><span style="color: #007700">] ],<br />] );<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">getReadPreference</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:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(1) {
["type"]=>
string(9) "secondary"
}
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-mongocommandcursor.getreadpreference-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member">The <a href="mongo.readpreferences.html" class="link">read preferences</a> documentation.</li>
<li class="member"><span class="function"><a href="mongocommandcursor.setreadpreference.html" class="function" rel="rdfs-seeAlso">MongoCommandCursor::setReadPreference()</a> - Set the read preference for this command</span></li>
<li class="member"><span class="function"><a href="mongocursorinterface.getreadpreference.html" class="function" rel="rdfs-seeAlso">MongoCursorInterface::getReadPreference()</a> - Get the read preference for this query</span></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongocommandcursor.dead.html">MongoCommandCursor::dead</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongocommandcursor.info.html">MongoCommandCursor::info</a></div>
<div class="up"><a href="class.mongocommandcursor.html">MongoCommandCursor</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
