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

<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>すべてのタイムゾーン識別子を含む配列を返す</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>

<link xlink:href="&url.wiki.tzdb.names;">IANA Time Zone identifiers</link> の一覧を返します。

</simpara>

<note>

<simpara>

<link xlink:href="&url.js.intl-datetimeformat;">Intl.DateTimeFormat</link>

や

<link xlink:href="&url.js.temporal-zoneddatetime;">Temporal.ZonedDateTime</link>

を使うと、

JavaScript でクライアント(ブラウザ) のタイムゾーンを検知することができます。

</simpara>

</note>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>timezoneGroup</parameter></term>

<listitem>

<para>

<classname>DateTimeZone</classname> のクラス定数のいずれか (または定数の組み合わせ)。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>countryCode</parameter></term>

<listitem>

<para>

2 文字の (大文字の) ISO 3166-1 互換の国コード。

</para>

<note>

<simpara>

このオプションを使用するのは、<parameter>timezoneGroup</parameter> に

<constant>DateTimeZone::PER_COUNTRY</constant> を設定した場合のみです。

</simpara>

</note>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

成功した場合に、タイムゾーンの識別子を含んだ配列を返します。

期限切れになっていない識別子のみを返します。

期限切れになったものも含めて、全ての識別子を取得するには、

<parameter>timezoneGroup</parameter> の値に

<literal>DateTimeZone::ALL_WITH_BC</literal> を指定します。

</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>

これより前のバージョンでは、失敗時に &false; を返していました。

</entry>

</row>

<row>

<entry>7.1.0</entry>

<entry>

<parameter>countryCode</parameter> は、nullable になりました。

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>地域のコメントを付けて、識別子の一覧を取得する</title>

<programlisting role="php">

</programlisting>

&example.outputs.similar;

<screen>

</screen>

</example>

</para>

<para>

<example>

<title>特定の地域を指定して、識別子の一覧を取得する</title>

<programlisting role="php">

</programlisting>

&example.outputs.similar;

<screen>

</screen>

</example>

</para>

<para>

<example>

<title>複数の地域を指定して、識別子の一覧を取得する</title>

<programlisting role="php">

</programlisting>

&example.outputs.similar;

<screen>

</screen>

</example>

</para>

<para>

<example>

<title>特定の国をひとつ指定して、識別子の一覧を取得する</title>

<programlisting role="php">

</programlisting>

&example.outputs.similar;

<screen>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>timezone_abbreviations_list</function></member>

</simplelist>

</para>

</refsect1>

</refentry>