File: MongoDB_Driver_WriteConcern.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (48 lines) | stat: -rw-r--r-- 2,424 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="MongoDB\Driver\WriteConcern" namespace="MongoDB\Driver" name="WriteConcern">
  <implements name="MongoDB\BSON\Serializable" full="MongoDB\BSON\Serializable"/>
  <constant name="MAJORITY" value="&quot;majority&quot;">
    <docblock>
      <var type="string"/>
    </docblock>
  </constant>
  <method name="bsonSerialize" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns an object for BSON serialization"/>
      <return type="object"/>
    </docblock>
  </method>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Create a new WriteConcern"/>
      <return type="void"/>
    </docblock>
    <parameter name="w" optional="false" byreference="false" type="object" class="string|integer"/>
    <parameter name="wtimeout" optional="true" byreference="false" type="int"/>
    <parameter name="journal" optional="true" byreference="false" type="object" class="bool"/>
  </constructor>
  <method name="getJournal" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns the WriteConcern's &quot;journal&quot; option"/>
      <return type="boolean|null"/>
    </docblock>
  </method>
  <method name="getW" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns the WriteConcern's &quot;w&quot; option"/>
      <return type="string|integer|null"/>
    </docblock>
  </method>
  <method name="getWtimeout" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns the WriteConcern's &quot;wtimeout&quot; option"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="isDefault" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Checks if this is the default write concern">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 MongoDB\Driver\Manager::getWriteConcern to determine whether the Manager has been constructed without any write concern options.</description>
      <return type="bool"/>
    </docblock>
  </method>
</class>