php-doc-en/reference/datetime/datetimezone/gettransitions.xml
Philip Olson 086dc12715 Added missing refnames
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@312463 c90b9560-bf6c-de11-be94-00142212c4b1
2011-06-25 19:38:40 +00:00

159 lines
4 KiB
XML

<?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="oop">
<modifier>public</modifier> <type>array</type><methodname>DateTimeZone::getTransitions</methodname>
<methodparam choice="opt"><type>int</type><parameter>timestamp_begin</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timestamp_end</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type>array</type><methodname>timezone_transitions_get</methodname>
<methodparam><type>DateTimeZone</type><parameter>object</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timestamp_begin</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timestamp_end</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&date.datetimezone.description;
<varlistentry>
<term><parameter>timestamp_begin</parameter></term>
<listitem>
<para>
Begin timestamp.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timestamp_end</parameter></term>
<listitem>
<para>
End timestamp.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns numerically indexed array containing associative array with all
transitions on success&return.falseforfailure;.
</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>5.3.0</entry>
<entry>
The optional <parameter>timestamp_begin</parameter> and <parameter>timestamp_end</parameter>
were added.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</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] => -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>
</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
-->