php-doc-en/reference/intl/locale-constants.xml
Jakub Vrana 4de5cce5d8 Linkable reference constants
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@323624 c90b9560-bf6c-de11-be94-00142212c4b1
2012-02-28 13:22:09 +00:00

149 lines
4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="intl.locale-constants" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
<para>
<variablelist>
<varlistentry xml:id="locale.constants.default-locale">
<term>
<constant>Locale::DEFAULT_LOCALE</constant>
(<type>null</type>)
</term>
<listitem>
<simpara>
Used as locale parameter with the methods of the various locale affected classes,
such as NumberFormatter. This constant would make the methods to use default
locale.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
These constants describe the choice of the locale for getLocalte method of
different classes.
<variablelist>
<varlistentry xml:id="locale.constants.actual-locale">
<term>
<constant>Locale::ACTUAL_LOCALE</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>This is locale the data actually comes from.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="locale.constants.valid-locale">
<term>
<constant>Locale::VALID_LOCALE</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>This is the most specific locale supported by ICU.</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<section xml:id="intl.locale-constants.subtags">
<para>
These constants define how the Locales are parsed or composed. They should
be used as keys in the argument array to <function>locale_compose</function>
and are returned from <function>locale_parse</function>
as keys of the returned associative <type>array</type>.
<variablelist>
<varlistentry xml:id="locale.constants.lang-tag">
<term>
<constant>Locale::LANG_TAG</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>Language subtag</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="locale.constants.extlang-tag">
<term>
<constant>Locale::EXTLANG_TAG</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>Extended language subtag</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="locale.constants.script-tag">
<term>
<constant>Locale::SCRIPT_TAG</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>Script subtag</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="locale.constants.region-tag">
<term>
<constant>Locale::REGION_TAG</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>Region subtag</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="locale.constants.variant-tag">
<term>
<constant>Locale::VARIANT_TAG</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>Variant subtag</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="locale.constants.grandfathered-lang-tag">
<term>
<constant>Locale::GRANDFATHERED_LANG_TAG</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>Grandfathered Language subtag</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="locale.constants.private-tag">
<term>
<constant>Locale::PRIVATE_TAG</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>Private subtag</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
</section>
<!-- 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
-->