isdefault.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="mongodb-driver-writeconcern.isdefault" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>MongoDB\Driver\WriteConcern::isDefault</refname>
  <refpurpose>Checks if this is the default write concern</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>final</modifier> <modifier>public</modifier> <type>bool</type><methodname>MongoDB\Driver\WriteConcern::isDefault</methodname>
   <void />
  </methodsynopsis>
  <para>
   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
   <methodname>MongoDB\Driver\Manager::getWriteConcern</methodname> to determine
   whether the Manager has been constructed without any write concern options.
  </para>
  <para>
   The driver will not include a default write concern in its write operations
   (e.g. <methodname>MongoDB\Driver\Manager::executeBulkWrite</methodname>) in
   order to allow the server to apply its own default, which may have been
   <link xlink:href="&url.mongodb.docs;core/replica-set-write-concern/#modify-default-write-concern">modified</link>.
   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.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns &true; if this is the default write concern and &false; otherwise.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <simplelist>
   &mongodb.throws.argumentparsing;
  </simplelist>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>MongoDB\Driver\WriteConcern::isDefault</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php

$wc = new MongoDB\Driver\WriteConcern(1);
var_dump($wc->isDefault());

$manager = new MongoDB\Driver\Manager('mongodb://127.0.0.1/?w=majority');
$wc = $manager->getWriteConcern();
var_dump($wc->isDefault());

$manager = new MongoDB\Driver\Manager('mongodb://127.0.0.1/');
$wc = $manager->getWriteConcern();
var_dump($wc->isDefault());

?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
bool(false)
bool(false)
bool(true)
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>MongoDB\Driver\Manager::getWriteConcern</methodname></member>
   <member><link xlink:href="&url.mongodb.docs;core/replica-set-write-concern/#modify-default-write-concern">Modify Default Write Concern</link> in the MongoDB manual</member>
   <member><link xlink:href="&url.mongodb.docs.writeconcern;">Write Concern reference</link></member>
   
  </simplelist>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->