Added localeconv() documentation

Updated setlocale() documentation to reference localeconv()


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@39604 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Sean Bright 2001-01-16 23:26:07 +00:00
parent b616d43b30
commit dc8da852af

View file

@ -1068,6 +1068,188 @@ $colon_separated = implode (":", $array);
</refsect1>
</refentry>
<refentry id="function.localeconv">
<refnamediv>
<refname>localeconv</refname>
<refpurpose>Get numeric formatting information</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>array <function>localeconv</function></funcdef>
<void/>
</funcprototype>
</funcsynopsis>
<para>
Returns an associative array containing localized numeric and monetary
formatting information.
</para>
<para>
<function>localeconv</function> returns data based upon the current locale
as set by <function>setlocale</function>. The associative array that is
returned contains the following fields:
<informaltable >
<tgroup cols="2">
<thead>
<row>
<entry>Array element</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>decimal_point</entry>
<entry>Decimal point character</entry>
</row>
<row>
<entry>thousands_sep</entry>
<entry>Thousands separator</entry>
</row>
<row>
<entry>grouping</entry>
<entry>Array containing numeric groupings</entry>
</row>
<row>
<entry>int_curr_symbol</entry>
<entry>International currency symbol (i.e. USD)</entry>
</row>
<row>
<entry>currency_symbol</entry>
<entry>Local currency symbol (i.e. $)</entry>
</row>
<row>
<entry>mon_decimal_point</entry>
<entry>Monetary decimal point character</entry>
</row>
<row>
<entry>mon_thousands_sep</entry>
<entry>Monetary thousands seperator</entry>
</row>
<row>
<entry>mon_grouping</entry>
<entry>Array containing monetary groupings</entry>
</row>
<row>
<entry>positive_sign</entry>
<entry>Sign for positive values</entry>
</row>
<row>
<entry>negative_sign</entry>
<entry>Sign for negative values</entry>
</row>
<row>
<entry>int_frac_digits</entry>
<entry>International fractional digits</entry>
</row>
<row>
<entry>frac_digits</entry>
<entry>Local fractional digits</entry>
</row>
<row>
<entry>p_cs_precedes</entry>
<entry>True if currency_symbol precedes a positive value, false if it succeeds one</entry>
</row>
<row>
<entry>p_sep_by_space</entry>
<entry>True if a space seperates currency_symbol from a positive value, false otherwise</entry>
</row>
<row>
<entry>n_cs_precedes</entry>
<entry>True if currency_symbol precedes a negative value, false if it succeeds one</entry>
</row>
<row>
<entry>n_sep_by_space</entry>
<entry>True if a space seperates currency_symbol from a negative value, false otherwise</entry>
</row>
<row valign="top">
<entry>p_sign_posn</entry>
<entry>
<simplelist columns="2" type="horiz">
<member>0</member>
<member>Parentheses surround the quantity and currency_symbol</member>
<member>1</member>
<member>The sign string precedes the quantity and currency_symbol</member>
<member>2</member>
<member>The sign string succeeds the quantity and currency_symbol</member>
<member>3</member>
<member>The sign string immediately precedes the currency_symbol</member>
<member>4</member>
<member>The sign string immediately succeeds the currency_symbol</member>
</simplelist>
</entry>
</row>
<row valign="top">
<entry>n_sign_posn</entry>
<entry>
<simplelist columns="2" type="horiz">
<member>0</member>
<member>Parentheses surround the quantity and currency_symbol</member>
<member>1</member>
<member>The sign string precedes the quantity and currency_symbol</member>
<member>2</member>
<member>The sign string succeeds the quantity and currency_symbol</member>
<member>3</member>
<member>The sign string immediately precedes the currency_symbol</member>
<member>4</member>
<member>The sign string immediately succeeds the currency_symbol</member>
</simplelist>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<para>
The grouping fields contain arrays that define the way numbers should be grouped.
For example, the grouping field for the en_US locale, would contain a 2 item array
with the values 3 and 3. The higher the index in the array, the farther left the
grouping is. If an array element is equal to CHAR_MAX, no further grouping is done.
If an array element is equal to 0, the previous element should be used.
</para>
<example>
<title><function>localeconv</function> example</title>
<programlisting role="php">
setlocale(LC_ALL, "en_US");
$locale_info = localeconv();
echo "&lt;PRE&gt;\n";
echo "--------------------------------------------\n";
echo " Monetary information for current locale: \n";
echo "--------------------------------------------\n\n";
echo "int_curr_symbol: {$locale_info["int_curr_symbol"]}\n";
echo "currency_symbol: {$locale_info["currency_symbol"]}\n";
echo "mon_decimal_point: {$locale_info["mon_decimal_point"]}\n";
echo "mon_thousands_sep: {$locale_info["mon_thousands_sep"]}\n";
echo "positive_sign: {$locale_info["positive_sign"]}\n";
echo "negative_sign: {$locale_info["negative_sign"]}\n";
echo "int_frac_digits: {$locale_info["int_frac_digits"]}\n";
echo "frac_digits: {$locale_info["frac_digits"]}\n";
echo "p_cs_precedes: {$locale_info["p_cs_precedes"]}\n";
echo "p_sep_by_space: {$locale_info["p_sep_by_space"]}\n";
echo "n_cs_precedes: {$locale_info["n_cs_precedes"]}\n";
echo "n_sep_by_space: {$locale_info["n_sep_by_space"]}\n";
echo "p_sign_posn: {$locale_info["p_sign_posn"]}\n";
echo "n_sign_posn: {$locale_info["n_sign_posn"]}\n";
echo "&lt;/PRE&gt;\n";
</programlisting>
</example>
<para>
The constant CHAR_MAX is also defined for the use mentioned above.
</para>
<note>
<para>
Added in PHP 4.0.5
</para>
</note>
<para>
See also: <function>setlocale</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.ltrim">
<refnamediv>
<refname>ltrim</refname>
@ -1474,13 +1656,12 @@ echo "&lt;author id='$id'&gt;
</listitem>
<listitem>
<simpara>
LC_MONETARY for localeconv() - not currently implemented in
PHP
LC_MONETARY for <function>localeconv</function>
</simpara>
</listitem>
<listitem>
<simpara>
LC_NUMERIC for decimal separator
LC_NUMERIC for decimal separator (See also: <function>localeconv</function>)
</simpara>
</listitem>
<listitem>