File: MongoCursorInterface.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 (74 lines) | stat: -rw-r--r-- 3,056 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
<?xml version="1.0" encoding="UTF-8" ?>
<interface xmlns="http://xml.phpdox.net/src" full="MongoCursorInterface" namespace="" name="MongoCursorInterface">
  <extends name="Iterator" full="Iterator"/>
  <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="MongoCursorInterface"/>
    </docblock>
    <parameter name="batchSize" optional="false" byreference="false" type="int"/>
  </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"/>
      <return type="bool"/>
    </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="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="setReadPreference" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the read preference for this query"/>
      <return type="MongoCursorInterface"/>
    </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="timeout" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets a client-side timeout for this query"/>
      <return type="MongoCursorInterface"/>
    </docblock>
    <parameter name="ms" optional="false" byreference="false" type="int"/>
  </method>
  <method name="current" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="key" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="scalar"/>
    </docblock>
  </method>
  <method name="next" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="rewind" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="valid" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
  </method>
</interface>