-
Notifications
You must be signed in to change notification settings - Fork 82
Expand file tree
/
Copy pathconstruct.xml
More file actions
281 lines (260 loc) · 7.95 KB
/
construct.xml
File metadata and controls
281 lines (260 loc) · 7.95 KB
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 3a8c3e77df070a046c9d5b56b68926ca2d7e5ee3 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="datetimeimmutable.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTimeImmutable::__construct</refname>
<refname>date_create_immutable</refname>
<refpurpose>新しい DateTimeImmutable オブジェクトを返す</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<constructorsynopsis role="DateTimeImmutable">
<modifier>public</modifier> <methodname>DateTimeImmutable::__construct</methodname>
<methodparam choice="opt"><type>string</type><parameter>datetime</parameter><initializer>"now"</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>DateTimeZone</type><type>null</type></type><parameter>timezone</parameter><initializer>&null;</initializer></methodparam>
</constructorsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<type class="union"><type>DateTimeImmutable</type><type>false</type></type><methodname>date_create_immutable</methodname>
<methodparam choice="opt"><type>string</type><parameter>datetime</parameter><initializer>"now"</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>DateTimeZone</type><type>null</type></type><parameter>timezone</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
新しい DateTimeImmutable オブジェクトを返します。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>datetime</parameter></term>
<listitem>
<para>&date.formats.parameter;</para>
<para>
ここに <literal>"now"</literal> を指定して
<parameter>$timezone</parameter> パラメータを使うと、現在時刻を取得できます。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timezone</parameter></term>
<listitem>
<para>
<parameter>$datetime</parameter> のタイムゾーンを表す
<classname>DateTimeZone</classname> オブジェクト。
</para>
<para>
<parameter>$timezone</parameter> を省略した場合、
または &null; の場合、
現在のタイムゾーンを使います。
</para>
<note>
<para>
<parameter>$datetime</parameter> パラメータが UNIX タイムスタンプ
(<literal>@946684800</literal> など)
であったりタイムゾーン付きで指定した場合
(<literal>2010-01-28T15:00:00+02:00</literal> や
<literal>2010-07-05T06:00:00Z</literal> など) は、
<parameter>$timezone</parameter> パラメータや現在のタイムゾーンは無視されます。
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
新しい DateTimeImmutable のインスタンスを返します。
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
無効な日付/時刻の文字列が渡された場合、
<exceptionname>DateMalformedStringException</exceptionname> がスローされます。
PHP 8.3 より前のバージョンでは、
<exceptionname>Exception</exceptionname> がスローされていました。
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.3.0</entry>
<entry>
無効な文字列が渡された場合、
<exceptionname>Exception</exceptionname> ではなく
<exceptionname>DateMalformedStringException</exceptionname>
がスローされるようになりました。
</entry>
</row>
<row>
<entry>7.1.0</entry>
<entry>
マイクロ秒が '00000' ではなく、実際の値で埋められるようになりました。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>DateTimeImmutable::__construct</function> の例</title>
<para>&style.oop;</para>
<programlisting role="php">
<![CDATA[
<?php
try {
$date = new DateTimeImmutable('2000-01-01');
} catch (Exception $e) {
echo $e->getMessage();
exit(1);
}
echo $date->format('Y-m-d');
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
2000-01-01
]]>
</screen>
<para>&style.procedural;</para>
<programlisting role="php">
<![CDATA[
<?php
$date = date_create('2000-01-01');
if (!$date) {
$e = date_get_last_errors();
foreach ($e['errors'] as $error) {
echo "$error\n";
}
exit(1);
}
echo date_format($date, 'Y-m-d');
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
2000-01-01
]]>
</screen>
</example>
<example>
<title><function>DateTimeImmutable::__construct</function> の複雑な例</title>
<programlisting role="php">
<![CDATA[
<?php
date_default_timezone_set('America/Jamaica');
// PHP のデフォルトのタイムゾーンでの日時の指定
$date = new DateTimeImmutable('2000-01-01');
echo $date->format('Y-m-d H:i:sP') . "\n";
// 指定したタイムゾーンでの日時の指定
$date = new DateTimeImmutable('2000-01-01', new DateTimeZone('Pacific/Nauru'));
echo $date->format('Y-m-d H:i:sP') . "\n";
// PHP のデフォルトのタイムゾーンでの現在日時
$date = new DateTimeImmutable();
echo $date->format('Y-m-d H:i:sP') . "\n";
// 指定したタイムゾーンでの現在日時
$date = new DateTimeImmutable('now', new DateTimeZone('Pacific/Nauru'));
echo $date->format('Y-m-d H:i:sP') . "\n";
// UNIX タイムスタンプの使用例。結果のタイムゾーンは UTC となることに注意しましょう。
$date = new DateTimeImmutable('@946684800');
echo $date->format('Y-m-d H:i:sP') . "\n";
// 存在しない値は繰り上がります
$date = new DateTimeImmutable('2000-02-30');
echo $date->format('Y-m-d H:i:sP') . "\n";
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
2000-01-01 00:00:00-05:00
2000-01-01 00:00:00+12:00
2010-04-24 10:24:16-04:00
2010-04-25 02:24:16+12:00
2000-01-01 00:00:00+00:00
2000-03-01 00:00:00-05:00
]]>
</screen>
<note>
<para>
繰り上がった日付は、
<function>DateTimeImmutable::getLastErrors</function>
の警告をチェックすることで検知できます。
</para>
</note>
</example>
<example>
<title>関連付けられたタイムゾーンを変更する</title>
<programlisting role="php">
<![CDATA[
<?php
$timeZone = new \DateTimeZone('Asia/Tokyo');
$time = new \DateTimeImmutable();
$time = $time->setTimezone($timeZone);
echo $time->format('Y/m/d H:i:s e'), "\n";
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
2022/08/12 23:49:23 Asia/Tokyo
]]>
</screen>
</example>
<example>
<title>相対日付/時刻 の文字列を使う</title>
<programlisting role="php">
<![CDATA[
<?php
$time = new \DateTimeImmutable("-1 year");
echo $time->format('Y/m/d H:i:s'), "\n";
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
2021/08/12 15:43:51
]]>
</screen>
</example>
</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
-->