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
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="MongoCursor" namespace="" name="MongoCursor">
<implements name="MongoCursorInterface" full="MongoCursorInterface"/>
<member name="slaveOkay" static="false">
<default>null</default>
<docblock>
<description compact="If the query should have the "slaveOkay" flag set, which allows reads on the secondary (secondaries are, by default, just for backup and not queried). Can be overridden with MongoCursor::slaveOkay.">If the query should have the "slaveOkay" flag set, which allows reads on the secondary (secondaries are, by default, just for backup and not queried). Can be overridden with MongoCursor::slaveOkay.</description>
<var type="boolean"/>
</docblock>
</member>
<member name="timeout" static="false">
<default>null</default>
<docblock>
<description compact="Set timeout in milliseconds for all database responses. Use -1 to wait forever. Can be overridden with MongoCursor::timeout. This does not cause the MongoDB server to cancel the operation; it only instructs the driver to stop waiting for a response and throw a MongoCursorTimeoutException after a set time."/>
<var type="integer"/>
</docblock>
</member>
<method name="addOption" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Adds a top-level key/value pair to a query">This is an advanced function and should not be used unless you know what you're doing.</description>
<return type="MongoCursor"/>
</docblock>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
</method>
<method name="awaitData" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Sets whether this cursor will wait for a while for a tailable cursor to return more data"/>
<return type="MongoCursor"/>
</docblock>
<parameter name="wait" optional="true" byreference="false" type="object" class="bool"/>
</method>
<method name="batchSize" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Limits the number of elements returned in one batch"/>
<return type="MongoCursor"/>
</docblock>
<parameter name="batchSize" optional="false" byreference="false" type="int"/>
</method>
<constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Create a new cursor"/>
<return type="void"/>
</docblock>
<parameter name="connection" optional="false" byreference="false" type="object" class="MongoClient"/>
<parameter name="ns" optional="false" byreference="false" type="string"/>
<parameter name="query" optional="true" byreference="false" type="object" class="array"/>
<parameter name="fields" optional="true" byreference="false" type="object" class="array"/>
</constructor>
<method name="count" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Counts the number of results for this query"/>
<return type="int"/>
</docblock>
<parameter name="foundOnly" optional="true" byreference="false" type="object" class="bool"/>
</method>
<method name="current" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns the current element"/>
<return type="array"/>
</docblock>
</method>
<method name="dead" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Checks if there are results that have not yet been sent from the database">The database sends responses in batches of documents, up to 4MB of documents per response. This method checks if the database has more batches or if the result set has been exhausted.</description>
<return type="bool"/>
</docblock>
</method>
<method name="doQuery" abstract="false" static="false" visibility="protected" final="false">
<docblock>
<description compact="Execute the query">Please do not use me.</description>
<return type="void"/>
</docblock>
</method>
<method name="explain" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Return an explanation of the query, often useful for optimization and debugging"/>
<return type="array"/>
</docblock>
</method>
<method name="fields" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Sets the fields for a query">Fields are specified by "fieldname" : bool. TRUE indicates that a field should be returned, FALSE indicates that it should not be returned. You can also use 1 and 0 instead of TRUE and FALSE.</description>
<return type="MongoCursor"/>
</docblock>
<parameter name="f" optional="false" byreference="false" type="object" class="array"/>
</method>
<method name="getNext" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Advances the cursor to the next result, and returns that result"/>
<return type="array"/>
</docblock>
</method>
<method name="getReadPreference" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get the read preference for this query"/>
<return type="array"/>
</docblock>
</method>
<method name="hasNext" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Checks if there are any more elements in this cursor"/>
<return type="bool"/>
</docblock>
</method>
<method name="hint" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Gives the database a hint about the query"/>
<return type="MongoCursor"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="object" class="mixed"/>
</method>
<method name="immortal" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Sets whether this cursor will timeout">After remaining idle on the server for some amount of time, cursors, by default, "die." This is generally the behavior one wants. The database cleans up a cursor once all of its results have been sent to the client, but if the client doesn't request all of the results, the cursor will languish there, taking up resources. Thus, after a few minutes, the cursor "times out" and the database assumes the client has gotten everything it needs and cleans up its the cursor's resources.</description>
<return type="MongoCursor"/>
</docblock>
<parameter name="liveForever" optional="true" byreference="false" type="object" class="bool"/>
</method>
<method name="info" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Gets information about the cursor's creation and iteration"/>
<return type="array"/>
</docblock>
</method>
<method name="key" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns the current result's _id, or its index within the result set"/>
<return type="string|int"/>
</docblock>
</method>
<method name="limit" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Limits the number of results returned"/>
<return type="MongoCursor"/>
</docblock>
<parameter name="num" optional="false" byreference="false" type="int"/>
</method>
<method name="maxTimeMS" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Sets a server-side timeout for this query"/>
<return type="MongoCursor"/>
</docblock>
<parameter name="ms" optional="false" byreference="false" type="int"/>
</method>
<method name="next" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Advances the cursor to the next result, and returns that result"/>
<return type="array"/>
</docblock>
</method>
<method name="partial" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="If this query should fetch partial results from mongos if a shard is down">This option allows mongos to send partial query results if a shard is unreachable. This is only applicable when running a sharded MongoDB cluster and connecting to a mongos.</description>
<return type="MongoCursor"/>
</docblock>
<parameter name="okay" optional="true" byreference="false" type="object" class="bool"/>
</method>
<method name="reset" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Clears the cursor"/>
<return type="void"/>
</docblock>
</method>
<method name="rewind" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns the cursor to the beginning of the result set"/>
<return type="void"/>
</docblock>
</method>
<method name="setFlag" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Sets arbitrary flags in case there is no method available the specific flag"/>
<return type="MongoCursor"/>
</docblock>
<parameter name="flag" optional="false" byreference="false" type="int"/>
<parameter name="set" optional="true" byreference="false" type="object" class="bool"/>
</method>
<method name="setReadPreference" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set the read preference for this query"/>
<return type="MongoCursor"/>
</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="skip" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Skips a number of results"/>
<return type="MongoCursor"/>
</docblock>
<parameter name="num" optional="false" byreference="false" type="int"/>
</method>
<method name="slaveOkay" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Sets whether this query can be done on a secondary [deprecated]">This method is deprecated since version 1.5.0. Instead, please use MongoCursor::setReadPreference and .</description>
<return type="MongoCursor"/>
</docblock>
<parameter name="okay" optional="true" byreference="false" type="object" class="bool"/>
</method>
<method name="snapshot" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Use snapshot mode for the query">Use snapshot mode for the query. Snapshot mode ensures that a document will not be returned more than once because an intervening write operation results in a move of the document. Documents inserted or deleted during the lifetime of the cursor may or may not be returned, irrespective of snapshot mode.</description>
<return type="MongoCursor"/>
</docblock>
</method>
<method name="sort" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Sorts the results by given fields"/>
<return type="MongoCursor"/>
</docblock>
<parameter name="fields" optional="false" byreference="false" type="object" class="array"/>
</method>
<method name="tailable" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Sets whether this cursor will be left open after fetching the last results">Mongo has a feature known as tailable cursors which are similar to the Unix "tail -f" command.</description>
<return type="MongoCursor"/>
</docblock>
<parameter name="tail" optional="true" byreference="false" type="object" class="bool"/>
</method>
<method name="timeout" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Sets a client-side timeout for this query"/>
<return type="MongoCursor"/>
</docblock>
<parameter name="ms" optional="false" byreference="false" type="int"/>
</method>
<method name="valid" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Checks if the cursor is reading a valid result"/>
<return type="bool"/>
</docblock>
</method>
</class>
|
