<!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>Return the ReadPreference for the Manager</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-manager.getreadconcern.html">MongoDB\Driver\Manager::getReadConcern</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-manager.getservers.html">MongoDB\Driver\Manager::getServers</a></div>
<div class="up"><a href="class.mongodb-driver-manager.html">MongoDB\Driver\Manager</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongodb-driver-manager.getreadpreference" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoDB\Driver\Manager::getReadPreference</h1>
<p class="verinfo">(mongodb >=1.0.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\Manager::getReadPreference</span> — <span class="dc-title">Return the ReadPreference for the Manager</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongodb-driver-manager.getreadpreference-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\ReadPreference">MongoDB\Driver\ReadPreference</span></span> <span class="methodname"><strong>MongoDB\Driver\Manager::getReadPreference</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Returns the <a href="class.mongodb-driver-readpreference.html" class="classname">MongoDB\Driver\ReadPreference</a> for the
Manager, which is derived from its URI options. This is the default read
preference for queries and commands executed on the Manager.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mongodb-driver-manager.getreadpreference-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongodb-driver-manager.getreadpreference-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The <a href="class.mongodb-driver-readpreference.html" class="classname">MongoDB\Driver\ReadPreference</a> for the Manager.
</p>
</div>
<div class="refsect1 errors" id="refsect1-mongodb-driver-manager.getreadpreference-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-manager.getreadpreference-examples">
<h3 class="title">Examples</h3>
<div class="example" id="mongopool.setpoolsize.example.basic">
<p><strong>Example #1 <span class="function"><strong>MongoDB\Driver\Manager::getReadPreference()</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">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$manager</span><span style="color: #007700">-></span><span style="color: #0000BB">getReadPreference</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">$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/?readPreference=secondaryPreferred&readPreferenceTags=dc:ny,rack:1&readPreferenceTags=dc:ny&readPreferenceTags='</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$manager</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
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
object(MongoDB\Driver\ReadPreference)#2 (1) {
["mode"]=>
string(7) "primary"
}
object(MongoDB\Driver\ReadPreference)#1 (2) {
["mode"]=>
string(18) "secondaryPreferred"
["tags"]=>
array(3) {
[0]=>
object(stdClass)#3 (2) {
["dc"]=>
string(2) "ny"
["rack"]=>
string(1) "1"
}
[1]=>
object(stdClass)#4 (1) {
["dc"]=>
string(2) "ny"
}
[2]=>
object(stdClass)#5 (0) {
}
}
}
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-mongodb-driver-manager.getreadpreference-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><a href="class.mongodb-driver-readpreference.html" class="classname">MongoDB\Driver\ReadPreference</a></li>
<li class="member"><span class="function"><a href="mongodb-driver-manager.construct.html" class="function" rel="rdfs-seeAlso">MongoDB\Driver\Manager::__construct()</a> - Create new MongoDB Manager</span></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-manager.getreadconcern.html">MongoDB\Driver\Manager::getReadConcern</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-manager.getservers.html">MongoDB\Driver\Manager::getServers</a></div>
<div class="up"><a href="class.mongodb-driver-manager.html">MongoDB\Driver\Manager</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
