1
0
mirror of https://github.com/php/doc-ja.git synced 2026-04-26 09:28:10 +02:00
Files
archived-doc-ja/reference/datetime/datetimezone/gettransitions.xml
T

236 lines
6.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1a9ee818e554e116b4721d432c6d671e14281ea0 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="datetimezone.gettransitions" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTimeZone::getTransitions</refname>
<refname>timezone_transitions_get</refname>
<refpurpose>タイムゾーンの変遷を返す</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>DateTimeZone::getTransitions</methodname>
<methodparam choice="opt"><type>int</type><parameter>timestampBegin</parameter><initializer><constant>PHP_INT_MIN</constant></initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timestampEnd</parameter><initializer><constant>PHP_INT_MAX</constant></initializer></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type class="union"><type>array</type><type>false</type></type><methodname>timezone_transitions_get</methodname>
<methodparam><type>DateTimeZone</type><parameter>object</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timestampBegin</parameter><initializer><constant>PHP_INT_MIN</constant></initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timestampEnd</parameter><initializer><constant>PHP_INT_MAX</constant></initializer></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&date.datetimezone.description;
<varlistentry>
<term><parameter>timestampBegin</parameter></term>
<listitem>
<para>
開始時のタイムスタンプ。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timestampEnd</parameter></term>
<listitem>
<para>
終了時のタイムスタンプ。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
成功した場合にタイムゾーンの遷移を表す、数値インデックスの配列を返します。
&return.falseforfailure;
DateTimeZone オブジェクト の type 1 (UTC オフセット)
と、type 2 (タイムゾーンの省略形) の場合は、
タイムゾーンの遷移情報は含まれません。
その場合にこのメソッドをコールしても &false; を返します。
</para>
<para>
<parameter>timestampBegin</parameter> を指定すると、
返される配列の最初のエントリに
<parameter>timestampBegin</parameter> の時点における遷移の情報が含まれるようになります。
</para>
<para>
<table>
<title>タイムゾーンの遷移を表す配列の構造</title>
<tgroup cols="2">
<thead>
<row>
<entry>キー</entry>
<entry></entry>
<entry>説明</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>ts</literal></entry>
<entry><type>int</type></entry>
<entry>Unixタイムスタンプ</entry>
</row>
<row>
<entry><literal>time</literal></entry>
<entry><type>string</type></entry>
<entry><constant>DateTimeInterface::ISO8601_EXPANDED</constant> (PHP
8.2 以降) または、<constant>DateTimeInterface::ISO8601</constant> (PHP 8.1 以前) 形式の文字列</entry>
</row>
<row>
<entry><literal>offset</literal></entry>
<entry><type>int</type></entry>
<entry>UTC からのオフセット(秒単位)</entry>
</row>
<row>
<entry><literal>isdst</literal></entry>
<entry><type>bool</type></entry>
<entry>夏時間が有効かどうか</entry>
</row>
<row>
<entry><literal>abbr</literal></entry>
<entry><type>string</type></entry>
<entry>タイムゾーンの省略形</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>timezone_transitions_get</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
$timezone = new DateTimeZone("Europe/London");
$transitions = $timezone->getTransitions();
print_r(array_slice($transitions, 0, 3));
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
[0] => Array
(
[ts] => -9223372036854775808
[time] => -292277022657-01-27T08:29:52+0000
[offset] => 3600
[isdst] => 1
[abbr] => BST
)
[1] => Array
(
[ts] => -1691964000
[time] => 1916-05-21T02:00:00+0000
[offset] => 3600
[isdst] => 1
[abbr] => BST
)
[2] => Array
(
[ts] => -1680472800
[time] => 1916-10-01T02:00:00+0000
[offset] => 0
[isdst] =>
[abbr] => GMT
)
)
]]>
</screen>
</example>
<example>
<title><parameter>timestampBegin</parameter> を設定して <function>timezone_transitions_get</function> を使う例</title>
<programlisting role="php">
<![CDATA[
<?php
$timezone = new DateTimeZone("Europe/London");
$transitions = $timezone->getTransitions(time());
print_r(array_slice($transitions, 0, 3));
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
[0] => Array
(
[ts] => 1654184161
[time] => 2022-06-02T15:36:01+0000
[offset] => 3600
[isdst] => 1
[abbr] => BST
)
[1] => Array
(
[ts] => 1667091600
[time] => 2022-10-30T01:00:00+0000
[offset] => 0
[isdst] =>
[abbr] => GMT
)
[2] => Array
(
[ts] => 1679792400
[time] => 2023-03-26T01:00:00+0000
[offset] => 3600
[isdst] => 1
[abbr] => BST
)
)
]]>
</screen>
</example>
</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
-->