<!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>Returns an object for BSON serialization</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.mongodb-driver-writeconcern.html">MongoDB\Driver\WriteConcern</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-writeconcern.construct.html">MongoDB\Driver\WriteConcern::__construct</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.bsonserialize" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoDB\Driver\WriteConcern::bsonSerialize</h1>
<p class="verinfo">(mongodb >=1.2.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\WriteConcern::bsonSerialize</span> — <span class="dc-title">Returns an object for BSON serialization</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongodb-driver-writeconcern.bsonserialize-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">object</span> <span class="methodname"><strong>MongoDB\Driver\WriteConcern::bsonSerialize</strong></span>
( <span class="methodparam">void</span>
)</div>
</div>
<div class="refsect1 parameters" id="refsect1-mongodb-driver-writeconcern.bsonserialize-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.bsonserialize-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an object for serializing the WriteConcern as BSON.
</p>
</div>
<div class="refsect1 errors" id="refsect1-mongodb-driver-writeconcern.bsonserialize-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.bsonserialize-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1703">
<p><strong>Example #1 <span class="function"><strong>MongoDB\Driver\WriteConcern::bsonSerialize()</strong></span> with majority write concern</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">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">MAJORITY</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">bsonSerialize</span><span style="color: #007700">());<br /><br />echo </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">toJSON</span><span style="color: #007700">(</span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">fromPHP</span><span style="color: #007700">(</span><span style="color: #0000BB">$wc</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(stdClass)#2 (1) {
["w"]=>
string(8) "majority"
}
{ "w" : "majority" }
</pre></div>
</div>
</div><div class="example" id="example-1704">
<p><strong>Example #2 <span class="function"><strong>MongoDB\Driver\WriteConcern::bsonSerialize()</strong></span> with wtimeout and journal</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">2</span><span style="color: #007700">, </span><span style="color: #0000BB">1000</span><span style="color: #007700">, </span><span style="color: #0000BB">true</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">bsonSerialize</span><span style="color: #007700">());<br /><br />echo </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">toJSON</span><span style="color: #007700">(</span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">fromPHP</span><span style="color: #007700">(</span><span style="color: #0000BB">$wc</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(stdClass)#2 (3) {
["w"]=>
int(2)
["j"]=>
bool(true)
["wtimeout"]=>
int(1000)
}
{ "w" : 2, "j" : true, "wtimeout" : 1000 }
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-mongodb-driver-writeconcern.bsonserialize-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><span class="methodname"><a href="mongodb-bson-serializable.bsonserialize.html" class="methodname" rel="rdfs-seeAlso">MongoDB\BSON\Serializable::bsonSerialize()</a> - Provides an array or document to serialize as BSON</span></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="class.mongodb-driver-writeconcern.html">MongoDB\Driver\WriteConcern</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-writeconcern.construct.html">MongoDB\Driver\WriteConcern::__construct</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>
