localeconv.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.localeconv">
 <refnamediv>
  <refname>localeconv</refname>
  <refpurpose>Get numeric formatting information</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>localeconv</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Returns an associative array containing localized numeric and
   monetary formatting information.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <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 separator</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 separates 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 separates currency_symbol from a negative
        value, &false; otherwise
       </entry>
      </row>
      <row valign="top">
       <entry>p_sign_posn</entry>
       <entry>
        <simplelist>
         <member>0 - Parentheses surround the quantity and currency_symbol</member>
         <member>1 - The sign string precedes the quantity and currency_symbol</member>
         <member>2 - The sign string succeeds the quantity and currency_symbol</member>
         <member>3 - The sign string immediately precedes the currency_symbol</member>
         <member>4 - The sign string immediately succeeds the currency_symbol</member>
        </simplelist>
       </entry>
      </row>
      <row valign="top">
       <entry>n_sign_posn</entry>
       <entry>
        <simplelist>
         <member>0 - Parentheses surround the quantity and currency_symbol</member>
         <member>1 - The sign string precedes the quantity and currency_symbol</member>
         <member>2 - The sign string succeeds the quantity and currency_symbol</member>
         <member>3 - The sign string immediately precedes the currency_symbol</member>
         <member>4 - The sign string immediately succeeds the currency_symbol</member>
        </simplelist>
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
  <para>
   The <literal>p_sign_posn</literal>, and <literal>n_sign_posn</literal> contain a string
   of formatting options. Each number representing one of the above listed conditions.
  </para>
  <para>
   The grouping fields contain arrays that define the way numbers should be
   grouped. For example, the monetary grouping field for the nl_NL locale (in
   UTF-8 mode with the euro sign), 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 <constant>CHAR_MAX</constant>,
   no further grouping is done. If an array element is equal to 0, the previous
   element should be used.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>localeconv</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
if (false !== setlocale(LC_ALL, 'nl_NL.UTF-8@euro')) {
    $locale_info = localeconv();
    print_r($locale_info);
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [decimal_point] => .
    [thousands_sep] =>
    [int_curr_symbol] => EUR
    [currency_symbol] => €
    [mon_decimal_point] => ,
    [mon_thousands_sep] =>
    [positive_sign] =>
    [negative_sign] => -
    [int_frac_digits] => 2
    [frac_digits] => 2
    [p_cs_precedes] => 1
    [p_sep_by_space] => 1
    [n_cs_precedes] => 1
    [n_sep_by_space] => 1
    [p_sign_posn] => 1
    [n_sign_posn] => 2
    [grouping] => Array
        (
        )

    [mon_grouping] => Array
        (
            [0] => 3
            [1] => 3
        )

)
]]>
    </screen>
   </example>   
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>setlocale</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
-->