<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.mongodb-driver-readpreference.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'mongodb-driver-readpreference.getmodestring.php',
    1 => 'MongoDB\\Driver\\ReadPreference::getModeString',
    2 => 'Retorna a op&ccedil;&atilde;o &quot;mode&quot; do ReadPreference',
  ),
  'up' => 
  array (
    0 => 'class.mongodb-driver-readpreference.php',
    1 => 'MongoDB\\Driver\\ReadPreference',
  ),
  'prev' => 
  array (
    0 => 'mongodb-driver-readpreference.getmode.php',
    1 => 'MongoDB\\Driver\\ReadPreference::getMode',
  ),
  'next' => 
  array (
    0 => 'mongodb-driver-readpreference.gettagsets.php',
    1 => 'MongoDB\\Driver\\ReadPreference::getTagSets',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/mongodb/mongodb/driver/readpreference/getmodestring.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="mongodb-driver-readpreference.getmodestring" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">MongoDB\Driver\ReadPreference::getModeString</h1>
  <p class="verinfo">(mongodb &gt;=1.7.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\ReadPreference::getModeString</span> &mdash; <span class="dc-title">Retorna a opção &quot;mode&quot; do ReadPreference</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-mongodb-driver-readpreference.getmodestring-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><strong>MongoDB\Driver\ReadPreference::getModeString</strong></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

 </div>


 <div class="refsect1 parameters" id="refsect1-mongodb-driver-readpreference.getmodestring-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">Esta função não possui parâmetros.</p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-mongodb-driver-readpreference.getmodestring-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Retorna a opção &quot;mode&quot; do ReadPreference como uma string.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-mongodb-driver-readpreference.getmodestring-errors">
  <h3 class="title">Erros/Exceções</h3>
  <ul class="simplelist">
   <li>Lança uma exceção <span class="classname"><a href="class.mongodb-driver-exception-invalidargumentexception.php" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a></span> em caso de erro ao analisar argumentos.</li>
  </ul>
 </div>



 <div class="refsect1 examples" id="refsect1-mongodb-driver-readpreference.getmodestring-examples">
  <h3 class="title">Exemplos</h3>
  <div class="example" id="example-1">
   <p><strong>Exemplo #1 Exemplo de <span class="function"><strong>MongoDB\Driver\ReadPreference::getModeString()</strong></span></strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />$rp </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB\Driver\ReadPreference</span><span style="color: #007700">(</span><span style="color: #0000BB">MongoDB\Driver\ReadPreference</span><span style="color: #007700">::</span><span style="color: #0000BB">PRIMARY</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$rp</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getModeString</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">$rp </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB\Driver\ReadPreference</span><span style="color: #007700">(</span><span style="color: #0000BB">MongoDB\Driver\ReadPreference</span><span style="color: #007700">::</span><span style="color: #0000BB">PRIMARY_PREFERRED</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$rp</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getModeString</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">$rp </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB\Driver\ReadPreference</span><span style="color: #007700">(</span><span style="color: #0000BB">MongoDB\Driver\ReadPreference</span><span style="color: #007700">::</span><span style="color: #0000BB">SECONDARY</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$rp</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getModeString</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">$rp </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB\Driver\ReadPreference</span><span style="color: #007700">(</span><span style="color: #0000BB">MongoDB\Driver\ReadPreference</span><span style="color: #007700">::</span><span style="color: #0000BB">SECONDARY_PREFERRED</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$rp</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getModeString</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">$rp </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB\Driver\ReadPreference</span><span style="color: #007700">(</span><span style="color: #0000BB">MongoDB\Driver\ReadPreference</span><span style="color: #007700">::</span><span style="color: #0000BB">NEAREST</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$rp</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getModeString</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>O exemplo acima produzirá:</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">string(7) &quot;primary&quot;
string(16) &quot;primaryPreferred&quot;
string(9) &quot;secondary&quot;
string(18) &quot;secondaryPreferred&quot;
string(7) &quot;nearest&quot;</pre>
</div>
   </div>
  </div>
 </div>



 <div class="refsect1 seealso" id="refsect1-mongodb-driver-readpreference.getmodestring-seealso">
  <h3 class="title">Veja Também</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="mongodb-driver-readpreference.getmode.php" class="methodname" rel="rdfs-seeAlso">MongoDB\Driver\ReadPreference::getMode()</a> - Retorna a op&ccedil;&atilde;o &quot;mode&quot; do ReadPreference</span></li>
   <li><a href="https://www.mongodb.com/docs/manual/core/read-preference/" class="link external">&raquo;&nbsp;Referência de Preferência de Leitura</a></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>