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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mongodb-bson-utcdatetime.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDB\BSON\UTCDateTime::__construct</refname>
<refpurpose>Construct a new UTCDateTime</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <methodname>MongoDB\BSON\UTCDateTime::__construct</methodname>
<methodparam choice="opt"><type class="union"><type>int</type><type>float</type><type>string</type><type>MongoDB\BSON\Int64</type><type>DateTimeInterface</type><type>null</type></type><parameter>milliseconds</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>milliseconds</parameter> (<type class="union"><type>int</type><type>float</type><type>string</type><type>DateTimeInterface</type><type>null</type></type>)</term>
<listitem>
<para>
Number of milliseconds since the Unix epoch (Jan 1, 1970). Negative values
represent dates before 1970. This value may be provided as a 64-bit
<type>int</type>. For compatibility on 32-bit systems, this parameter
may also be provided as a <classname>MongoDB\BSON\Int64</classname>.
</para>
<para>
If the argument is a <classname>DateTimeInterface</classname>, the number
of milliseconds since the Unix epoch will be derived from that value.
</para>
<para>
If this argument is &null;, the current time will be used by default.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simplelist>
&mongodb.throws.argumentparsing;
</simplelist>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL mongodb 1.20.0</entry>
<entry>
<para>
The <parameter>milliseconds</parameter> argument now accepts a
<classname>MongoDB\BSON\Int64</classname> object (for compatibility on
32-bit platforms). Specifying a <type>string</type> or
<type>float</type> is deprecated.
</para>
</entry>
</row>
<row>
<entry>PECL mongodb 1.2.0</entry>
<entry>
<para>
The <parameter>milliseconds</parameter> argument is optional and
defaults to &null; (i.e. current time). The argument also accepts a
<classname>DateTimeInterface</classname>, which may be used to derive
the number of milliseconds since the Unix epoch. Previously, only
<type>int</type>, <type>float</type>, and <type>string</type> types
were accepted.
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>MongoDB\BSON\UTCDateTime::__construct</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
var_dump(new MongoDB\BSON\UTCDateTime);
var_dump(new MongoDB\BSON\UTCDateTime(new DateTime));
var_dump(new MongoDB\BSON\UTCDateTime(1416445411987));
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
object(MongoDB\BSON\UTCDateTime)#1 (1) {
["milliseconds"]=>
string(13) "1484852905560"
}
object(MongoDB\BSON\UTCDateTime)#1 (1) {
["milliseconds"]=>
string(13) "1484852905560"
}
object(MongoDB\BSON\UTCDateTime)#1 (1) {
["milliseconds"]=>
string(13) "1416445411987"
}
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><link xlink:href="&url.mongodb.docs.bson;#date">BSON Types: Date</link></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
