File: MongoDBRef.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 (27 lines) | stat: -rw-r--r-- 1,378 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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="MongoDBRef" namespace="" name="MongoDBRef">
  <method name="create" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Creates a new database reference"/>
      <return type="array"/>
    </docblock>
    <parameter name="collection" optional="false" byreference="false" type="string"/>
    <parameter name="id" optional="false" byreference="false" type="object" class="mixed"/>
    <parameter name="database" optional="true" byreference="false" type="string"/>
  </method>
  <method name="get" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Fetches the object pointed to by a reference"/>
      <return type="array"/>
    </docblock>
    <parameter name="db" optional="false" byreference="false" type="object" class="MongoDB"/>
    <parameter name="ref" optional="false" byreference="false" type="object" class="array"/>
  </method>
  <method name="isRef" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if an array is a database reference"/>
      <return type="bool"/>
    </docblock>
    <parameter name="ref" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
</class>