File: MongoDB_BSON_Binary.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 (84 lines) | stat: -rw-r--r-- 2,886 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
75
76
77
78
79
80
81
82
83
84
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="MongoDB\BSON\Binary" namespace="MongoDB\BSON" name="Binary">
  <implements name="MongoDB\BSON\BinaryInterface" full="MongoDB\BSON\BinaryInterface"/>
  <constant name="TYPE_GENERIC" value="0">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="TYPE_FUNCTION" value="1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="TYPE_OLD_BINARY" value="2">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="TYPE_OLD_UUID" value="3">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="TYPE_UUID" value="4">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="TYPE_MD5" value="5">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="TYPE_USER_DEFINED" value="128">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Construct a new Binary"/>
      <return type="void"/>
    </docblock>
    <parameter name="data" optional="false" byreference="false" type="string"/>
    <parameter name="type" optional="false" byreference="false" type="int"/>
  </constructor>
  <method name="getData" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns the Binary's data"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getType" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns the Binary's type"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="jsonSerialize" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns a representation that can be converted to JSON"/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="serialize" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Serialize a Binary"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="__toString" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns the Binary's data"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="unserialize" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Unserialize a Binary"/>
      <return type="void"/>
    </docblock>
    <parameter name="serialized" optional="false" byreference="false" type="string"/>
  </method>
</class>