<!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 query</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mongocursorinterface.dead.html">MongoCursorInterface::dead</a></div> <div class="next" style="text-align: right; float: right;"><a href="mongocursorinterface.info.html">MongoCursorInterface::info</a></div> <div class="up"><a href="class.mongocursorinterface.html">MongoCursorInterface</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="mongocursorinterface.getreadpreference" class="refentry"> <div class="refnamediv"> <h1 class="refname">MongoCursorInterface::getReadPreference</h1> <p class="verinfo">(PECL mongo >=1.6.0)</p><p class="refpurpose"><span class="refname">MongoCursorInterface::getReadPreference</span> — <span class="dc-title">Get the read preference for this query</span></p> </div> <div class="refsect1 description" id="refsect1-mongocursorinterface.getreadpreference-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><strong>MongoCursorInterface::getReadPreference</strong></span> ( <span class="methodparam">void</span> )</div> </div> <div class="refsect1 parameters" id="refsect1-mongocursorinterface.getreadpreference-parameters"> <h3 class="title">Parameters</h3> <p class="para">This function has no parameters.</p> </div> <div class="refsect1 returnvalues" id="refsect1-mongocursorinterface.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 seealso" id="refsect1-mongocursorinterface.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="mongocursorinterface.setreadpreference.html" class="function" rel="rdfs-seeAlso">MongoCursorInterface::setReadPreference()</a> - Set 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="mongocursorinterface.dead.html">MongoCursorInterface::dead</a></div> <div class="next" style="text-align: right; float: right;"><a href="mongocursorinterface.info.html">MongoCursorInterface::info</a></div> <div class="up"><a href="class.mongocursorinterface.html">MongoCursorInterface</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>