File: MongoDB_Driver_Cursor.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 (41 lines) | stat: -rw-r--r-- 1,764 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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="MongoDB\Driver\Cursor" namespace="MongoDB\Driver" name="Cursor">
  <implements name="Traversable" full="Traversable"/>
  <constructor name="__construct" abstract="false" static="false" final="true">
    <docblock>
      <description compact="Create a new Cursor (not used)"/>
      <return type="void"/>
    </docblock>
  </constructor>
  <method name="getId" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns the ID for this cursor"/>
      <return type="MongoDB\Driver\CursorId"/>
    </docblock>
  </method>
  <method name="getServer" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns the server associated with this cursor"/>
      <return type="MongoDB\Driver\Server"/>
    </docblock>
  </method>
  <method name="isDead" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Checks if the cursor may have additional results"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="setTypeMap" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Sets a type map to use for BSON unserialization"/>
      <return type="void"/>
    </docblock>
    <parameter name="typemap" optional="false" byreference="false" type="object" class="array"/>
  </method>
  <method name="toArray" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns an array containing all results for this cursor"/>
      <return type="array"/>
    </docblock>
  </method>
</class>