mirror of
https://github.com/php/doc-en.git
synced 2026-04-24 07:48:16 +02:00
Máté Kocsis
262 lines
8.1 KiB
XML
262 lines
8.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="datetimezone.listidentifiers" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>DateTimeZone::listIdentifiers</refname>
|
|
<refname>timezone_identifiers_list</refname>
|
|
<refpurpose>Returns a numerically indexed array containing all defined timezone identifiers</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<para>&style.oop;</para>
|
|
<methodsynopsis role="DateTimeZone">
|
|
<modifier>public</modifier> <modifier>static</modifier> <type>array</type><methodname>DateTimeZone::listIdentifiers</methodname>
|
|
<methodparam choice="opt"><type>int</type><parameter>timezoneGroup</parameter><initializer><constant>DateTimeZone::ALL</constant></initializer></methodparam>
|
|
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>countryCode</parameter><initializer>&null;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>&style.procedural;</para>
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>timezone_identifiers_list</methodname>
|
|
<methodparam choice="opt"><type>int</type><parameter>timezoneGroup</parameter><initializer><constant>DateTimeZone::ALL</constant></initializer></methodparam>
|
|
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>countryCode</parameter><initializer>&null;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<simpara>
|
|
Return the list of <link xlink:href="&url.wiki.tzdb.names;">IANA Time Zone identifiers</link>.
|
|
</simpara>
|
|
|
|
<note>
|
|
<simpara>
|
|
It's possible to detect the client (browser) timezone with JavaScript using
|
|
<link xlink:href="&url.js.intl-datetimeformat;">Intl.DateTimeFormat</link> or
|
|
<link xlink:href="&url.js.temporal-zoneddatetime;">Temporal.ZonedDateTime</link>.
|
|
</simpara>
|
|
</note>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>timezoneGroup</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
One of the <classname>DateTimeZone</classname> class constants (or a combination).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>countryCode</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A two-letter (uppercase) ISO 3166-1 compatible country code.
|
|
</para>
|
|
<note>
|
|
<simpara>
|
|
This option is only used when <parameter>timezoneGroup</parameter> is set to
|
|
<constant>DateTimeZone::PER_COUNTRY</constant>.
|
|
</simpara>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the array of timezone identifiers. Only non-outdated items are
|
|
returned. To get all, including outdated timezone identifiers, use the
|
|
<literal>DateTimeZone::ALL_WITH_BC</literal> as value for
|
|
<parameter>timezoneGroup</parameter>.
|
|
</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>
|
|
Prior to this version, &false; was returned on failure.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>7.1.0</entry>
|
|
<entry>
|
|
<parameter>countryCode</parameter> is nullable now.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>List identifiers with location comments</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$identifiers = DateTimeZone::listIdentifiers(DateTimeZone::ALL);
|
|
|
|
foreach ($identifiers as $tzid) {
|
|
$tz = new DateTimeZone($tzid);
|
|
$comments = $tz->getLocation()['comments'];
|
|
echo $tzid . " (" . ($comments ?: 'Whole region') . ")\n";
|
|
}
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
America/Antigua (Whole region)
|
|
America/Araguaina (Tocantins)
|
|
America/Argentina/Buenos_Aires (Buenos Aires (BA, CF))
|
|
America/Argentina/Catamarca (Catamarca (CT), Chubut (CH))
|
|
America/Argentina/Cordoba (Argentina (most areas: CB, CC, CN, ER, FM, MN, SE, SF))
|
|
// (Output trimmed due to length)
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
|
|
<para>
|
|
<example>
|
|
<title>Listing identifiers for a specific region</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$timezone_identifiers = DateTimeZone::listIdentifiers( DateTimeZone::ASIA );
|
|
for ($i=0; $i < 5; $i++) {
|
|
echo "$timezone_identifiers[$i]\n";
|
|
}
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
Asia/Aden
|
|
Asia/Almaty
|
|
Asia/Amman
|
|
Asia/Anadyr
|
|
Asia/Aqtau
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
|
|
<para>
|
|
<example>
|
|
<title>Listing identifiers for multiple regions</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$timezone_identifiers = DateTimeZone::listIdentifiers( DateTimeZone::ASIA | DateTimeZone::PACIFIC );
|
|
echo join( ', ', $timezone_identifiers );
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe,
|
|
Asia/Ashgabat, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku,
|
|
Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei,
|
|
Asia/Chita, Asia/Choibalsan, Asia/Colombo, Asia/Damascus, Asia/Dhaka,
|
|
Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Hebron,
|
|
Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Jakarta,
|
|
Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi,
|
|
Asia/Kathmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk,
|
|
Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macau, Asia/Magadan,
|
|
Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk,
|
|
Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak,
|
|
Asia/Pyongyang, Asia/Qatar, Asia/Qostanay, Asia/Qyzylorda, Asia/Riyadh,
|
|
Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore,
|
|
Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran,
|
|
Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ulaanbaatar, Asia/Urumqi,
|
|
Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon,
|
|
Asia/Yekaterinburg, Asia/Yerevan, Pacific/Apia, Pacific/Auckland,
|
|
Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter,
|
|
Pacific/Efate, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti,
|
|
Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam,
|
|
Pacific/Honolulu, Pacific/Kanton, Pacific/Kiritimati, Pacific/Kosrae,
|
|
Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway,
|
|
Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea,
|
|
Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei,
|
|
Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Tahiti,
|
|
Pacific/Tarawa, Pacific/Tongatapu, Pacific/Wake, Pacific/Wallis
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
|
|
<para>
|
|
<example>
|
|
<title>Listing identifiers for a single country</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$timezone_identifiers = DateTimeZone::listIdentifiers( DateTimeZone::PER_COUNTRY, "UA" );
|
|
foreach( $timezone_identifiers as $identifier ) {
|
|
echo "$identifier\n";
|
|
}
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
Europe/Kyiv
|
|
Europe/Simferopol
|
|
Europe/Uzhgorod
|
|
Europe/Zaporozhye
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>timezone_abbreviations_list</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
|
|
-->
|