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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="MongoDB" namespace="" name="MongoDB">
<constant name="PROFILING_OFF" value="0">
<docblock>
<var type="int"/>
</docblock>
</constant>
<constant name="PROFILING_SLOW" value="1">
<docblock>
<var type="int"/>
</docblock>
</constant>
<constant name="PROFILING_ON" value="2">
<docblock>
<var type="int"/>
</docblock>
</constant>
<member name="w" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="The number of servers to replicate a change to before returning success. Inherited by instances of MongoCollection derived from this. w functionality is only available in version 1.5.1+ of the MongoDB server and 1.0.8+ of the driver.">The number of servers to replicate a change to before returning success. Inherited by instances of MongoCollection derived from this. w functionality is only available in version 1.5.1+ of the MongoDB server and 1.0.8+ of the driver.</description>
<var type="integer"/>
</docblock>
</member>
<member name="wtimeout" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="The number of milliseconds to wait for MongoDB::$w replications to take place. Inherited by instances of MongoCollection derived from this. w functionality is only available in version 1.5.1+ of the MongoDB server and 1.0.8+ of the driver.">The number of milliseconds to wait for MongoDB::$w replications to take place. Inherited by instances of MongoCollection derived from this. w functionality is only available in version 1.5.1+ of the MongoDB server and 1.0.8+ of the driver.</description>
<var type="integer"/>
</docblock>
</member>
<method name="authenticate" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Log in to this database">This method causes its connection to be authenticated. If authentication is enabled for the database server (it's not, by default), you need to log in before the database will allow you to do anything.</description>
<return type="array"/>
</docblock>
<parameter name="username" optional="false" byreference="false" type="string"/>
<parameter name="password" optional="false" byreference="false" type="string"/>
</method>
<method name="command" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Execute a database command">Almost everything that is not a CRUD operation can be done with a database command. Need to know the database version? There's a command for that. Need to do aggregation? There's a command for that. Need to turn up logging? You get the idea.</description>
<return type="array"/>
</docblock>
<parameter name="command" optional="false" byreference="false" type="object" class="array"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
<parameter name="hash" optional="true" byreference="false" type="string"/>
</method>
<constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Creates a new database">This method is not meant to be called directly. The preferred way to create an instance of MongoDB is through MongoClient::__get or MongoClient::selectDB.</description>
<return type="void"/>
</docblock>
<parameter name="conn" optional="false" byreference="false" type="object" class="MongoClient"/>
<parameter name="name" optional="false" byreference="false" type="string"/>
</constructor>
<method name="createCollection" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Creates a collection"/>
<return type="MongoCollection"/>
</docblock>
<parameter name="name" optional="false" byreference="false" type="string"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="createDBRef" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Creates a database reference"/>
<return type="array"/>
</docblock>
<parameter name="collection" optional="false" byreference="false" type="string"/>
<parameter name="document_or_id" optional="false" byreference="false" type="object" class="mixed"/>
</method>
<method name="drop" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Drops this database">This drops the database currently being used.</description>
<return type="array"/>
</docblock>
</method>
<method name="dropCollection" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Drops a collection [deprecated]">Use MongoCollection::drop instead.</description>
<return type="array"/>
</docblock>
<parameter name="coll" optional="false" byreference="false" type="object" class="mixed"/>
</method>
<method name="execute" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Runs JavaScript code on the database server [deprecated]">The eval command, which this method invokes, is deprecated in MongoDB 3.0+.</description>
<return type="array"/>
</docblock>
<parameter name="code" optional="false" byreference="false" type="object" class="mixed"/>
<parameter name="args" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="forceError" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Creates a database error">This method is not very useful for normal MongoDB use. It forces a database error to occur. This means that MongoDB::lastError will return a generic database error after running this command.</description>
<return type="bool"/>
</docblock>
</method>
<method name="__get" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Gets a collection"/>
<return type="MongoCollection"/>
</docblock>
<parameter name="name" optional="false" byreference="false" type="string"/>
</method>
<method name="getCollectionInfo" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns information about collections in this database"/>
<return type="array"/>
</docblock>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="getCollectionNames" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Gets an array of names for all collections in this database"/>
<return type="array"/>
</docblock>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="getDBRef" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Fetches the document pointed to by a database reference"/>
<return type="array"/>
</docblock>
<parameter name="ref" optional="false" byreference="false" type="object" class="array"/>
</method>
<method name="getGridFS" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Fetches toolkit for dealing with files stored in this database"/>
<return type="MongoGridFS"/>
</docblock>
<parameter name="prefix" optional="true" byreference="false" type="string"/>
</method>
<method name="getProfilingLevel" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Gets this database's profiling level">This returns the current database profiling level.</description>
<return type="int"/>
</docblock>
</method>
<method name="getReadPreference" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get the read preference for this database"/>
<return type="array"/>
</docblock>
</method>
<method name="getSlaveOkay" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get slaveOkay setting for this database"/>
<return type="bool"/>
</docblock>
</method>
<method name="getWriteConcern" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get the write concern for this database"/>
<return type="array"/>
</docblock>
</method>
<method name="lastError" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Check if there was an error on the most recent db operation performed"/>
<return type="array"/>
</docblock>
</method>
<method name="listCollections" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Gets an array of MongoCollection objects for all collections in this database"/>
<return type="array"/>
</docblock>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="prevError" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Checks for the last error thrown during a database operation"/>
<return type="array"/>
</docblock>
</method>
<method name="repair" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Repairs and compacts this database">This creates a fresh copy of all database data. It will remove any corrupt data and compact and large stretches of free space it finds. This is a very slow operation on a large database.</description>
<return type="array"/>
</docblock>
<parameter name="preserve_cloned_files" optional="true" byreference="false" type="object" class="bool"/>
<parameter name="backup_original_files" optional="true" byreference="false" type="object" class="bool"/>
</method>
<method name="resetError" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Clears any flagged errors on the database">This method is not used in normal operations. It resets the database error tracker (which can be incremented with MongoDB::forceError, also not normally used).</description>
<return type="array"/>
</docblock>
</method>
<method name="selectCollection" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Gets a collection"/>
<return type="MongoCollection"/>
</docblock>
<parameter name="name" optional="false" byreference="false" type="string"/>
</method>
<method name="setProfilingLevel" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Sets this database's profiling level">This changes the current database profiling level.</description>
<return type="int"/>
</docblock>
<parameter name="level" optional="false" byreference="false" type="int"/>
</method>
<method name="setReadPreference" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set the read preference for this database"/>
<return type="bool"/>
</docblock>
<parameter name="read_preference" optional="false" byreference="false" type="string"/>
<parameter name="tags" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="setSlaveOkay" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Change slaveOkay setting for this database"/>
<return type="bool"/>
</docblock>
<parameter name="ok" optional="true" byreference="false" type="object" class="bool"/>
</method>
<method name="setWriteConcern" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set the write concern for this database"/>
<return type="bool"/>
</docblock>
<parameter name="w" optional="false" byreference="false" type="object" class="mixed"/>
<parameter name="wtimeout" optional="true" byreference="false" type="int"/>
</method>
<method name="__toString" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="The name of this database"/>
<return type="string"/>
</docblock>
</method>
</class>
|
