archived-doc-ja/reference/strings/functions/localeconv.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 715a125af5a86f0e6d6d5aa6cfa9c45257a433ac Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.localeconv">
 <refnamediv>
  <refname>localeconv</refname>
  <refpurpose>数値に関するフォーマット情報を得る</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>localeconv</methodname>
   <void/>
  </methodsynopsis>
  <para>
   ローカルな数値および通貨フォーマット情報を有する連想配列を返します。
  </para>
 </refsect1>

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

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>localeconv</function> は、
   <function>setlocale</function> で設定された現在のロケールに基づきデータを返します。
   返される連想配列は、次のフィールドを有します。
   <informaltable >
    <tgroup cols="2">
     <thead>
      <row>
       <entry>配列要素</entry>
       <entry>説明</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>decimal_point</entry>
       <entry>小数点文字</entry>
      </row>
      <row>
       <entry>thousands_sep</entry>
       <entry>千毎の区切り文字</entry>
      </row>
      <row>
       <entry>grouping</entry>
       <entry>数値集合を有する配列</entry>
      </row>
      <row>
       <entry>int_curr_symbol</entry>
       <entry>国際通貨記号 (すなわち、USD)</entry>
      </row>
      <row>
       <entry>currency_symbol</entry>
       <entry>ローカルな通貨記号 (すなわち、$)</entry>
      </row>
      <row>
       <entry>mon_decimal_point</entry>
       <entry>通貨用の小数点文字</entry>
      </row>
      <row>
       <entry>mon_thousands_sep</entry>
       <entry>通貨用の千毎の区切り文字</entry>
      </row>
      <row>
       <entry>mon_grouping</entry>
       <entry>通貨集合を有する配列</entry>
      </row>
      <row>
       <entry>positive_sign</entry>
       <entry>正の値を表す記号</entry>
      </row>
      <row>
       <entry>negative_sign</entry>
       <entry>負の値を表す記号</entry>
      </row>
      <row>
       <entry>int_frac_digits</entry>
       <entry>国際分割桁</entry>
      </row>
      <row>
       <entry>frac_digits</entry>
       <entry>ローカルな分割桁</entry>
      </row>
      <row>
       <entry>p_cs_precedes</entry>
       <entry>
        currency_symbol が正の値を前に置く場合に&true;、後に置く場合に
        &false;
       </entry>
      </row>
      <row>
       <entry>p_sep_by_space</entry>
       <entry>
        正の値から currency_symbol を1文字の空白で区切る場合に&true;、
        そうでない場合に&false;
       </entry>
      </row>
      <row>
       <entry>n_cs_precedes</entry>
       <entry>
        currency_symbol が負の値を前に置く場合に&true;、後に置く場合に
        &false;
       </entry>
      </row>
      <row>
       <entry>n_sep_by_space</entry>
       <entry>
        負の値から currency_symbol を1文字の空白で区切る場合に&true;、
        そうでない場合に&false;
       </entry>
      </row>
      <row valign="top">
       <entry>p_sign_posn</entry>
       <entry>
        <simplelist>
         <member>0 - 量および通貨記号を括る括弧</member>
         <member>1 - 量および通貨記号の前に置く符号文字列</member>
         <member>2 - 量および通貨記号の後に置く符号文字列</member>
         <member>3 - 通貨記号の直前に置く符号文字列</member>
         <member>4 - 通貨記号の直後に置く符号文字列</member>
        </simplelist>
       </entry>
      </row>
      <row valign="top">
       <entry>n_sign_posn</entry>
       <entry>
        <simplelist>
         <member>0 - 量および通貨記号を括る括弧</member>
         <member>1 - 量および通貨記号の前に置く符号文字列</member>
         <member>2 - 量および通貨記号の後に置く符号文字列</member>
         <member>3 - 通貨記号の直前に置く符号文字列</member>
         <member>4 - 通貨記号の直後に置く符号文字列</member>
        </simplelist>
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
  <para>
   <literal>n_sign_posn</literal> や <literal>n_sign_posn</literal>
   は、フォーマッタオプションの文字列を含みます。それぞれの数字は
   上に一覧されている条件の 1 つを表します。
  </para>
  <para>
   groupingフィールドには、グループ化する方法を表す数字を定義する配
   列が含まれます。例えば、nl_NL ロケール用の通貨 groupingフィールド
    (UTF-8 モードでのユーロ記号) には、
   3、3を値とする要素数2の配列が含まれます。この配列のより高い添字に
   は、より左側のグループに関するものが含まれます。
   ある配列要素が、<constant>CHAR_MAX</constant> に等しい場合、
   さらにグループは行われません。配列要素が0に等しい場合、
   前の要素が使用されています。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>localeconv</function> の例</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
-->