File: mysql_xdevapi_Collection.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (113 lines) | stat: -rw-r--r-- 4,631 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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="mysql_xdevapi\Collection" namespace="mysql_xdevapi" name="Collection">
  <implements name="mysql_xdevapi\SchemaObject" full="mysql_xdevapi\SchemaObject"/>
  <member name="name" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact=""/>
    </docblock>
  </member>
  <method name="add" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="mysql_xdevapi\CollectionAdd"/>
    </docblock>
    <parameter name="document" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="addOrReplaceOne" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="mysql_xdevapi\Result"/>
    </docblock>
    <parameter name="id" optional="false" byreference="false" type="string"/>
    <parameter name="doc" optional="false" byreference="false" type="string"/>
  </method>
  <method name="count" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="integer"/>
    </docblock>
  </method>
  <method name="createIndex" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
    <parameter name="index_name" optional="false" byreference="false" type="string"/>
    <parameter name="index_desc_json" optional="false" byreference="false" type="string"/>
  </method>
  <method name="dropIndex" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
    <parameter name="index_name" optional="false" byreference="false" type="string"/>
  </method>
  <method name="existsInDatabase" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="find" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="mysql_xdevapi\CollectionFind"/>
    </docblock>
    <parameter name="search_condition" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getOne" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="Document"/>
    </docblock>
    <parameter name="id" optional="false" byreference="false" type="string"/>
  </method>
  <method name="getSchema" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="Schema Object"/>
    </docblock>
  </method>
  <method name="getSession" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="Session"/>
    </docblock>
  </method>
  <method name="modify" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="mysql_xdevapi\CollectionModify"/>
    </docblock>
    <parameter name="search_condition" optional="false" byreference="false" type="string"/>
  </method>
  <method name="remove" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="mysql_xdevapi\CollectionRemove"/>
    </docblock>
    <parameter name="search_condition" optional="false" byreference="false" type="string"/>
  </method>
  <method name="removeOne" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="mysql_xdevapi\Result"/>
    </docblock>
    <parameter name="id" optional="false" byreference="false" type="string"/>
  </method>
  <method name="replaceOne" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="mysql_xdevapi\Result"/>
    </docblock>
    <parameter name="id" optional="false" byreference="false" type="string"/>
    <parameter name="doc" optional="false" byreference="false" type="string"/>
  </method>
</class>