File: MongoDB_Driver_BulkWrite.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 (41 lines) | stat: -rw-r--r-- 2,084 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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="MongoDB\Driver\BulkWrite" namespace="MongoDB\Driver" name="BulkWrite">
  <implements name="Countable" full="Countable"/>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Create a new BulkWrite"/>
      <return type="void"/>
    </docblock>
    <parameter name="options" optional="true" byreference="false" type="object" class="array"/>
  </constructor>
  <method name="count" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Count number of write operations in the bulk"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="delete" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Add a delete operation to the bulk"/>
      <return type="void"/>
    </docblock>
    <parameter name="filter" optional="false" byreference="false" type="object" class="array|object"/>
    <parameter name="deleteOptions" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="insert" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Add an insert operation to the bulk"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="document" optional="false" byreference="false" type="object" class="array|object"/>
  </method>
  <method name="update" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Add an update operation to the bulk"/>
      <return type="void"/>
    </docblock>
    <parameter name="filter" optional="false" byreference="false" type="object" class="array|object"/>
    <parameter name="newObj" optional="false" byreference="false" type="object" class="array|object"/>
    <parameter name="updateOptions" optional="true" byreference="false" type="object" class="array"/>
  </method>
</class>