File: MongoGridFSCursor.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 (39 lines) | stat: -rw-r--r-- 1,810 bytes parent folder | download | duplicates (3)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="MongoGridFSCursor" namespace="" name="MongoGridFSCursor">
  <extends name="MongoCursor" full="MongoCursor"/>
  <member name="gridfs" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <var type="MongoGridFS"/>
    </docblock>
  </member>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Create a new cursor"/>
      <return type="void"/>
    </docblock>
    <parameter name="gridfs" optional="false" byreference="false" type="object" class="MongoGridFS"/>
    <parameter name="connection" optional="false" byreference="false" type="object" class="resource"/>
    <parameter name="ns" optional="false" byreference="false" type="string"/>
    <parameter name="query" optional="false" byreference="false" type="object" class="array"/>
    <parameter name="fields" optional="false" byreference="false" type="object" class="array"/>
  </constructor>
  <method name="current" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the current file"/>
      <return type="MongoGridFSFile"/>
    </docblock>
  </method>
  <method name="getNext" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Return the next file to which this cursor points, and advance the cursor"/>
      <return type="MongoGridFSFile"/>
    </docblock>
  </method>
  <method name="key" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the current result's filename"/>
      <return type="string"/>
    </docblock>
  </method>
</class>