<!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>Checks if this is the default write concern</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-writeconcern.getwtimeout.html">MongoDB\Driver\WriteConcern::getWtimeout</a></div> <div class="next" style="text-align: right; float: right;"><a href="class.mongodb-driver-readpreference.html">MongoDB\Driver\ReadPreference</a></div> <div class="up"><a href="class.mongodb-driver-writeconcern.html">MongoDB\Driver\WriteConcern</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="mongodb-driver-writeconcern.isdefault" class="refentry"> <div class="refnamediv"> <h1 class="refname">MongoDB\Driver\WriteConcern::isDefault</h1> <p class="verinfo">(mongodb >=1.3.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\WriteConcern::isDefault</span> — <span class="dc-title">Checks if this is the default write concern</span></p> </div> <div class="refsect1 description" id="refsect1-mongodb-driver-writeconcern.isdefault-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>MongoDB\Driver\WriteConcern::isDefault</strong></span> ( <span class="methodparam">void</span> )</div> <p class="para rdfs-comment"> Returns whether this is the default write concern (i.e. no options are specified). This method is primarily intended to be used in conjunction with <span class="methodname"><a href="mongodb-driver-manager.getwriteconcern.html" class="methodname">MongoDB\Driver\Manager::getWriteConcern()</a></span> to determine whether the Manager has been constructed without any write concern options. </p> <p class="para"> The driver will not include a default write concern in its write operations (e.g. <span class="methodname"><a href="mongodb-driver-manager.executebulkwrite.html" class="methodname">MongoDB\Driver\Manager::executeBulkWrite()</a></span>) in order to allow the server to apply its own default, which may have been <a href="https://docs.mongodb.com/manual/core/replica-set-write-concern/#modify-default-write-concern" class="link external">» modified</a>. Libraries that access the Manager's write concern to include it in their own write commands should use this method to ensure that default write concerns are left unset. </p> </div> <div class="refsect1 parameters" id="refsect1-mongodb-driver-writeconcern.isdefault-parameters"> <h3 class="title">Parameters</h3> <p class="para">This function has no parameters.</p> </div> <div class="refsect1 returnvalues" id="refsect1-mongodb-driver-writeconcern.isdefault-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> if this is the default write concern and <strong><code>FALSE</code></strong> otherwise. </p> </div> <div class="refsect1 errors" id="refsect1-mongodb-driver-writeconcern.isdefault-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-writeconcern.isdefault-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-1709"> <p><strong>Example #1 <span class="function"><strong>MongoDB\Driver\WriteConcern::isDefault()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br />$wc </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">WriteConcern</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$wc</span><span style="color: #007700">-></span><span style="color: #0000BB">isDefault</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://127.0.0.1/?w=majority'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$wc </span><span style="color: #007700">= </span><span style="color: #0000BB">$manager</span><span style="color: #007700">-></span><span style="color: #0000BB">getWriteConcern</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$wc</span><span style="color: #007700">-></span><span style="color: #0000BB">isDefault</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://127.0.0.1/'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$wc </span><span style="color: #007700">= </span><span style="color: #0000BB">$manager</span><span style="color: #007700">-></span><span style="color: #0000BB">getWriteConcern</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$wc</span><span style="color: #007700">-></span><span style="color: #0000BB">isDefault</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> bool(false) bool(false) bool(true) </pre></div> </div> </div> </div> <div class="refsect1 seealso" id="refsect1-mongodb-driver-writeconcern.isdefault-seealso"> <h3 class="title">See Also</h3> <ul class="simplelist"> <li class="member"><span class="methodname"><a href="mongodb-driver-manager.getwriteconcern.html" class="methodname" rel="rdfs-seeAlso">MongoDB\Driver\Manager::getWriteConcern()</a> - Return the WriteConcern for the Manager</span></li> <li class="member"><a href="https://docs.mongodb.com/manual/core/replica-set-write-concern/#modify-default-write-concern" class="link external">» Modify Default Write Concern</a> in the MongoDB manual</li> <li class="member"><a href="https://docs.mongodb.com/manual/reference/write-concern/" class="link external">» Write Concern reference</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-writeconcern.getwtimeout.html">MongoDB\Driver\WriteConcern::getWtimeout</a></div> <div class="next" style="text-align: right; float: right;"><a href="class.mongodb-driver-readpreference.html">MongoDB\Driver\ReadPreference</a></div> <div class="up"><a href="class.mongodb-driver-writeconcern.html">MongoDB\Driver\WriteConcern</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>