<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<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>Returns all transitions for the timezone</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<para>&style.oop;</para>

<methodsynopsis role="DateTimeZone">

<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>2147483647</initializer></methodparam>

</methodsynopsis>

<para>&style.procedural;</para>

<methodsynopsis>

<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>2147483647</initializer></methodparam>

</methodsynopsis>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

&date.datetimezone.description;

<varlistentry>

<term><parameter>timestampBegin</parameter></term>

<listitem>

<para>

Begin timestamp.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>timestampEnd</parameter></term>

<listitem>

<para>

End timestamp.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Returns a numerically indexed array of

transition arrays on success, &return.falseforfailure;. DateTimeZone

objects wrapping type 1 (UTC offsets) and type 2 (abbreviations) do not

contain any transitions, and calling this method on them will return

&false;.

</para>

<para>

If <parameter>timestampBegin</parameter> is given, the first entry in the

returned array will contain a transition element at the time of

<parameter>timestampBegin</parameter>.

</para>

<para>

<table>

<title>Transition Array Structure</title>

<tgroup cols="2">

<thead>

<row>

<entry>Key</entry>

<entry>Type</entry>

<entry>Description</entry>

</row>

</thead>

<tbody>

<row>

<entry><literal>ts</literal></entry>

<entry><type>int</type></entry>

<entry>Unix timestamp</entry>

</row>

<row>

<entry><literal>time</literal></entry>

<entry><type>string</type></entry>

<entry><constant>DateTimeInterface::ISO8601_EXPANDED</constant> (PHP

8.2 and later), or <constant>DateTimeInterface::ISO8601</constant> (PHP

8.1 and lower) time string</entry>

</row>

<row>

<entry><literal>offset</literal></entry>

<entry><type>int</type></entry>

<entry>Offset to UTC in seconds</entry>

</row>

<row>

<entry><literal>isdst</literal></entry>

<entry><type>bool</type></entry>

<entry>Whether daylight saving time is active</entry>

</row>

<row>

<entry><literal>abbr</literal></entry>

<entry><type>string</type></entry>

<entry>Timezone abbreviation</entry>

</row>

</tbody>

</tgroup>

</table>

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.1.0</entry>

<entry>

The default value of <parameter>timestampEnd</parameter> has been changed to 2147483647. Previously,

it was <constant>PHP_INT_MAX</constant>.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>A <function>timezone_transitions_get</function> example</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] => -2147483648

[time] => 1901-12-13T20:45:52+00:00

[offset] => -75

[isdst] =>

[abbr] => LMT

)

[1] => Array

(

[ts] => 442304971

[time] => 1847-12-01T00:01:15+00:00

[offset] => 0

[isdst] =>

[abbr] => GMT

)

[2] => Array

(

[ts] => -1691964000

[time] => 1916-05-21T02:00:00+00:00

[offset] => 3600

[isdst] => 1

[abbr] => BST

)

)

]]>

</screen>

</example>

<example>

<title>A <function>timezone_transitions_get</function> example with

<parameter>timestampBegin</parameter> set</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] => 1759058251

[time] => 2025-09-28T11:17:31+00:00

[offset] => 3600

[isdst] => 1

[abbr] => BST

)

[1] => Array

(

[ts] => 1761440400

[time] => 2025-10-26T01:00:00+00:00

[offset] => 0

[isdst] =>

[abbr] => GMT

)

[2] => Array

(

[ts] => 1774746000

[time] => 2026-03-29T01:00:00+00:00

[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

-->