PHP Manual
Prev |  | Next

# localeconv

(PHP 4 >= 4.0.5)

localeconv -- Get numeric formatting information

## Description

``array localeconv` (void)`

Returns an associative array containing localized numeric and monetary formatting information.

localeconv() returns data based upon the current locale as set by setlocale(). The associative array that is returned contains the following fields:

Array element | Description
--- | ---
decimal_point | Decimal point character
thousands_sep | Thousands separator
grouping | Array containing numeric groupings
int_curr_symbol | International currency symbol (i.e. USD)
currency_symbol | Local currency symbol (i.e. $)
mon_decimal_point | Monetary decimal point character
mon_thousands_sep | Monetary thousands separator
mon_grouping | Array containing monetary groupings
positive_sign | Sign for positive values
negative_sign | Sign for negative values
int_frac_digits | International fractional digits
frac_digits | Local fractional digits
p_cs_precedes | `TRUE` if currency_symbol precedes a positive value, `FALSE` if it succeeds one
p_sep_by_space | `TRUE` if a space separates currency_symbol from a positive value, `FALSE` otherwise
n_cs_precedes | `TRUE` if currency_symbol precedes a negative value, `FALSE` if it succeeds one
n_sep_by_space | `TRUE` if a space separates currency_symbol from a negative value, `FALSE` otherwise
p_sign_posn |
0 | Parentheses surround the quantity and currency_symbol
1 | The sign string precedes the quantity and currency_symbol
2 | The sign string succeeds the quantity and currency_symbol
3 | The sign string immediately precedes the currency_symbol
4 | The sign string immediately succeeds the currency_symbol
n_sign_posn |
0 | Parentheses surround the quantity and currency_symbol
1 | The sign string precedes the quantity and currency_symbol
2 | The sign string succeeds the quantity and currency_symbol
3 | The sign string immediately precedes the currency_symbol
4 | The sign string immediately succeeds the currency_symbol

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.

Example 1. localeconv() example
    setlocale(LC_ALL, "en_US");

    $locale_info = localeconv();

    echo "<PRE>\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 "</PRE>\n";

The constant CHAR_MAX is also defined for the use mentioned above.

> Note: Added in PHP 4.0.5

See also: setlocale().

Prev | Home | Next
levenshtein | Up | ltrim