forked from php/doc-ja
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgmmktime.xml
197 lines (191 loc) · 7.26 KB
/
gmmktime.xml
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 57e27d2a7615da2ee6de57ed27eb40b473d487cb Maintainer: takagi Status: ready -->
<!-- CREDITS: hirokawa,shimooka,mumumu -->
<refentry xml:id="function.gmmktime" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>gmmktime</refname>
<refpurpose>GMT 日付から Unix タイムスタンプを取得する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>gmmktime</methodname>
<methodparam><type>int</type><parameter>hour</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>minute</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>second</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>month</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>day</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>year</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
指定されるパラメータが GMT 日付を表すこと以外は
<function>mktime</function> と同じです。
<function>gmmktime</function> は内部で <function>mktime</function>
を使用しているので、ローカル時刻として有効な値のみが使用可能です。
</para>
<para>
<function>mktime</function> と同様に、
オプションの引数は右から順に省略することができます。
省略された引数は、GMT の日付と時刻に従って、現在の値にセットされます。
</para>
<simpara>
引数なしで <function>gmmktime</function> を呼び出すことはサポートされていません。
引数なしで呼び出すと、<classname>ArgumentCountError</classname> がスローされます。
現在のタイムスタンプを取得する目的には、<function>time</function> が使えます。
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>hour</parameter></term>
<listitem>
<para>
<parameter>month</parameter>、<parameter>day</parameter> と <parameter>year</parameter>
で決まる日付の 0 時から数えた「時」。負の値は、その日の 0 時から前にさかのぼった時間を表します。
23 より大きい値は、その翌日以降の該当する時間を表します。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>minute</parameter></term>
<listitem>
<para>
<parameter>hour</parameter> 時 0 分から数えた「分」。
負の値は、その前の時刻を表します。
59 より大きい値は、その次の時間以降の該当する時間を表します。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>second</parameter></term>
<listitem>
<para>
<parameter>minute</parameter> 分 0 秒から数えた「秒」。
負の値は、その前の時刻を表します。
59 より大きい値は、その次の分以降の該当する時間を表します。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>month</parameter></term>
<listitem>
<para>
前年末から数えた月数。1 から 12 までの場合は、カレンダーどおりのその年の「月」を表します。
(負の値を含めた) 1 より小さい値は、前年の月を逆順でたどります。
つまり 0 なら 12 月、-1 なら 11 月になるということです。
12 より大きい値は、その翌年以降の該当する月を表します。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>day</parameter></term>
<listitem>
<para>
前月末から数えた日数。1 から 28、29、30、31 (月によって異なる) までの場合は、その月の「日」を表します。
(負の値を含めた) 1 より小さい値は、前月の日を逆順でたどります。
つまり 0 なら前月の末日、-1 ならそのさらに前日になるということです。
その月の日数より大きい値は、翌月以降の該当する日を表します。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>year</parameter></term>
<listitem>
<para>
年
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
成功時に、Unix タイムスタンプを <type>int</type> で返します。
タイムスタンプの値が PHP の整数型に合わない場合は、&false; を返します。
</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.0.0</entry>
<entry>
<parameter>hour</parameter> はオプションではなくなりました。
Unixタイムスタンプ が必要な場合、<function>time</function>
関数を使います。
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>minute</parameter>, <parameter>second</parameter>, <parameter>month</parameter>,
<parameter>day</parameter>, <parameter>year</parameter> は、nullable になりました。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>gmmktime</function> の基本的な例</title>
<programlisting role="php">
<![CDATA[
<?php
// 出力: July 1, 2000 is on a Saturday
echo "July 1, 2000 is on a " . date("l", gmmktime(0, 0, 0, 7, 1, 2000));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><classname>DateTimeImmutable</classname></member>
<member><function>mktime</function></member>
<member><function>date</function></member>
<member><function>time</function></member>
</simplelist>
</para>
</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
-->