File: MongoDB_BSON_ObjectId.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 (42 lines) | stat: -rw-r--r-- 1,842 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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="MongoDB\BSON\ObjectId" namespace="MongoDB\BSON" name="ObjectId">
  <implements name="MongoDB\BSON\ObjectIdInterface" full="MongoDB\BSON\ObjectIdInterface"/>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Construct a new ObjectId"/>
      <return type="void"/>
    </docblock>
    <parameter name="id" optional="true" byreference="false" type="string"/>
  </constructor>
  <method name="getTimestamp" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns the timestamp component of this ObjectId"/>
      <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 an ObjectId"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="__toString" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns the hexidecimal representation of this ObjectId"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="unserialize" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Unserialize an ObjectId"/>
      <return type="void"/>
    </docblock>
    <parameter name="serialized" optional="false" byreference="false" type="string"/>
  </method>
</class>