<!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>Get the write concern for this collection</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mongocollection.getslaveokay.html">MongoCollection::getSlaveOkay</a></div> <div class="next" style="text-align: right; float: right;"><a href="mongocollection.group.html">MongoCollection::group</a></div> <div class="up"><a href="class.mongocollection.html">MongoCollection</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="mongocollection.getwriteconcern" class="refentry"> <div class="refnamediv"> <h1 class="refname">MongoCollection::getWriteConcern</h1> <p class="verinfo">(PECL mongo >=1.5.0)</p><p class="refpurpose"><span class="refname">MongoCollection::getWriteConcern</span> — <span class="dc-title">Get the write concern for this collection</span></p> </div> <div class="refsect1 description" id="refsect1-mongocollection.getwriteconcern-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><strong>MongoCollection::getWriteConcern</strong></span> ( <span class="methodparam">void</span> )</div> </div> <div class="refsect1 parameters" id="refsect1-mongocollection.getwriteconcern-parameters"> <h3 class="title">Parameters</h3> <p class="para">This function has no parameters.</p> </div> <div class="refsect1 returnvalues" id="refsect1-mongocollection.getwriteconcern-returnvalues"> <h3 class="title">Return Values</h3> <p class="para">This function returns an array describing the write concern. The array contains the values <em>w</em> for an integer acknowledgement level or string mode, and <em>wtimeout</em> denoting the maximum number of milliseconds to wait for the server to satisfy the write concern.</p> </div> <div class="refsect1 examples" id="refsect1-mongocollection.getwriteconcern-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-1597"> <p><strong>Example #1 <span class="methodname"><strong>MongoCollection::getWriteConcern()</strong></span> return value example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br />$mc </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoClient</span><span style="color: #007700">(</span><span style="color: #DD0000">'mongodb://localhost:27017'</span><span style="color: #007700">, array(</span><span style="color: #DD0000">'wTimeoutMS' </span><span style="color: #007700">=> </span><span style="color: #0000BB">500</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$coll </span><span style="color: #007700">= </span><span style="color: #0000BB">$mc</span><span style="color: #007700">-></span><span style="color: #0000BB">selectCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">'test'</span><span style="color: #007700">, </span><span style="color: #DD0000">'foo'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$coll</span><span style="color: #007700">-></span><span style="color: #0000BB">getWriteConcern</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">$coll</span><span style="color: #007700">-></span><span style="color: #0000BB">setWriteConcern</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">1000</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$coll</span><span style="color: #007700">-></span><span style="color: #0000BB">getWriteConcern</span><span style="color: #007700">());<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> array(2) { ["w"]=> int(1) ["wtimeout"]=> int(500) } array(2) { ["w"]=> int(1) ["wtimeout"]=> int(1000) } </pre></div> </div> </div> </div> <div class="refsect1 seealso" id="refsect1-mongocollection.getwriteconcern-seealso"> <h3 class="title">See Also</h3> <ul class="simplelist"> <li class="member">The <a href="mongo.writeconcerns.html" class="link">write concern</a> documentation.</li> <li class="member"><span class="function"><a href="mongocollection.setwriteconcern.html" class="function" rel="rdfs-seeAlso">MongoCollection::setWriteConcern()</a> - Set the write concern for this database</span></li> </ul> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mongocollection.getslaveokay.html">MongoCollection::getSlaveOkay</a></div> <div class="next" style="text-align: right; float: right;"><a href="mongocollection.group.html">MongoCollection::group</a></div> <div class="up"><a href="class.mongocollection.html">MongoCollection</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>