php-doc-en/reference/datetime/datetimezone/listidentifiers.xml
2013-06-21 00:18:38 +00:00

147 lines
3.9 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="oop">
<modifier>public</modifier> <modifier>static</modifier> <type>array</type><methodname>DateTimeZone::listIdentifiers</methodname>
<methodparam choice="opt"><type>int</type><parameter>what</parameter><initializer>DateTimeZone::ALL</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>country</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type>array</type><methodname>timezone_identifiers_list</methodname>
<methodparam choice="opt"><type>int</type><parameter>what</parameter><initializer>DateTimeZone::ALL</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>country</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>what</parameter></term>
<listitem>
<para>
One of <classname>DateTimeZone</classname> class constants.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>country</parameter></term>
<listitem>
<para>
A two-letter ISO 3166-1 compatible country code.
</para>
<note>
<simpara>
This option is only used when <parameter>what</parameter> is set to
<constant>DateTimeZone::PER_COUNTRY</constant>.
</simpara>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns array 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>
Added the optional <parameter>what</parameter> and
<parameter>country</parameter> parameters.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>timezone_identifiers_list</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$timezone_identifiers = DateTimeZone::listIdentifiers();
for ($i=0; $i < 5; $i++) {
echo "$timezone_identifiers[$i]\n";
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Africa/Abidjan
Africa/Accra
Africa/Addis_Ababa
Africa/Algiers
Africa/Asmara
]]>
</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
-->