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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="MongoCollection" namespace="" name="MongoCollection">
<constant name="ASCENDING" value="1">
<docblock>
<var type="int"/>
</docblock>
</constant>
<constant name="DESCENDING" value="-1">
<docblock>
<var type="int"/>
</docblock>
</constant>
<member name="db" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="The "parent" database for this collection."/>
<var type="MongoDB"/>
</docblock>
</member>
<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. Value is inherited from the parent database. The MongoDB class has a more detailed description of how w works."/>
<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 $this->w replications to take place. Value is inherited from the parent database. The MongoDB class has a more detailed description of how wtimeout works."/>
<var type="integer"/>
</docblock>
</member>
<method name="aggregate" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Perform an aggregation using the aggregation framework">The MongoDB aggregation framework provides a means to calculate aggregated values without having to use MapReduce. While MapReduce is powerful, it is often more difficult than necessary for many simple aggregation tasks, such as totaling or averaging field values.</description>
<return type="array"/>
</docblock>
<parameter name="pipeline" optional="false" byreference="false" type="object" class="array"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="aggregateCursor" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Execute an aggregation pipeline command and retrieve results through a cursor"/>
<return type="MongoCommandCursor"/>
</docblock>
<parameter name="command" optional="false" byreference="false" type="object" class="array"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="batchInsert" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Inserts multiple documents into this collection"/>
<return type="mixed"/>
</docblock>
<parameter name="a" optional="false" byreference="false" type="object" class="array"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Creates a new collection"/>
<return type="void"/>
</docblock>
<parameter name="db" optional="false" byreference="false" type="object" class="MongoDB"/>
<parameter name="name" optional="false" byreference="false" type="string"/>
</constructor>
<method name="count" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Counts the number of documents in this collection"/>
<return type="int"/>
</docblock>
<parameter name="query" optional="true" byreference="false" type="object" class="array"/>
<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="document_or_id" optional="false" byreference="false" type="object" class="mixed"/>
</method>
<method name="createIndex" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Creates an index on the specified field(s) if it does not already exist ">Creates an index on the specified field(s) if it does not already exist. Fields may be indexed with a direction (e.g. ascending or descending) or a special type (e.g. text, geospatial, hashed).</description>
<return type="bool"/>
</docblock>
<parameter name="keys" optional="false" byreference="false" type="object" class="array"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="deleteIndex" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Deletes an index from this collection">This method is identical to:</description>
<return type="array"/>
</docblock>
<parameter name="keys" optional="false" byreference="false" type="object" class="string|array"/>
</method>
<method name="deleteIndexes" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Delete all indices for this collection"/>
<return type="array"/>
</docblock>
</method>
<method name="distinct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrieve a list of distinct values for the given key across a collection"/>
<return type="array"/>
</docblock>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="query" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="drop" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Drops this collection"/>
<return type="array"/>
</docblock>
</method>
<method name="ensureIndex" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Creates an index on the specified field(s) if it does not already exist ">This method is deprecated since version 1.5.0. Please use MongoCollection::createIndex instead.</description>
<return type="bool"/>
</docblock>
<parameter name="key|keys" optional="false" byreference="false" type="object" class="string|array"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="find" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Queries this collection, returning a MongoCursor for the result set"/>
<return type="MongoCursor"/>
</docblock>
<parameter name="query" optional="true" byreference="false" type="object" class="array"/>
<parameter name="fields" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="findAndModify" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Update a document and return it"/>
<return type="array"/>
</docblock>
<parameter name="query" optional="false" byreference="false" type="object" class="array"/>
<parameter name="update" optional="true" byreference="false" type="object" class="array"/>
<parameter name="fields" optional="true" byreference="false" type="object" class="array"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="findOne" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Queries this collection, returning a single element"/>
<return type="array"/>
</docblock>
<parameter name="query" optional="true" byreference="false" type="object" class="array"/>
<parameter name="fields" optional="true" byreference="false" type="object" class="array"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</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="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="getIndexInfo" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns information about indexes on this collection"/>
<return type="array"/>
</docblock>
</method>
<method name="getName" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns this collection's name"/>
<return type="string"/>
</docblock>
</method>
<method name="getReadPreference" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get the read preference for this collection"/>
<return type="array"/>
</docblock>
</method>
<method name="getSlaveOkay" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get slaveOkay setting for this collection"/>
<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 collection"/>
<return type="array"/>
</docblock>
</method>
<method name="group" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Performs an operation similar to SQL's GROUP BY command"/>
<return type="array"/>
</docblock>
<parameter name="keys" optional="false" byreference="false" type="object" class="mixed"/>
<parameter name="initial" optional="false" byreference="false" type="object" class="array"/>
<parameter name="reduce" optional="false" byreference="false" type="object" class="MongoCode"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="insert" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Inserts a document into the collection"/>
<return type="bool|array"/>
</docblock>
<parameter name="document" optional="false" byreference="false" type="object" class="array|object"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="parallelCollectionScan" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns an array of cursors to iterator over a full collection in parallel">This method returns an array of a maximum of num_cursors cursors. An iteration over one of the returned cursors results in a partial set of documents for a collection. Iteration over all the returned cursors results in getting every document back from the collection.</description>
<return type="array[MongoCommandCursor]"/>
</docblock>
<parameter name="num_cursors" optional="false" byreference="false" type="int"/>
</method>
<method name="remove" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Remove records from this collection"/>
<return type="bool|array"/>
</docblock>
<parameter name="criteria" optional="true" byreference="false" type="object" class="array"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="save" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Saves a document to this collection"/>
<return type="mixed"/>
</docblock>
<parameter name="document" optional="false" byreference="false" type="object" class="array|object"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="setReadPreference" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set the read preference for this collection"/>
<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 collection"/>
<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="toIndexString" abstract="false" static="false" final="false">
<docblock>
<description compact="Converts keys specifying an index to its identifying string"/>
<return type="string"/>
</docblock>
<parameter name="keys" optional="false" byreference="false" type="object" class="mixed"/>
</method>
<method name="__toString" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="String representation of this collection"/>
<return type="string"/>
</docblock>
</method>
<method name="update" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Update records based on a given criteria"/>
<return type="bool|array"/>
</docblock>
<parameter name="criteria" optional="false" byreference="false" type="object" class="array"/>
<parameter name="new_object" optional="false" byreference="false" type="object" class="array"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="validate" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Validates this collection"/>
<return type="array"/>
</docblock>
<parameter name="scan_data" optional="true" byreference="false" type="object" class="bool"/>
</method>
</class>
|
