php-doc-en/reference/intl/numberformatter/create.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="numberformatter.create" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>NumberFormatter::create</refname>
  <refname>numfmt_create</refname>
  <refname>NumberFormatter::__construct</refname>
  <refpurpose>Create a number formatter</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>
   &style.oop; (method)
  </para>
  <methodsynopsis>
   <modifier>public</modifier>
   <modifier>static</modifier>
   <type>NumberFormatter</type>
   <methodname>NumberFormatter::create</methodname>
   <methodparam><type>string</type><parameter>locale</parameter></methodparam>
   <methodparam><type>int</type><parameter>style</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>pattern</parameter></methodparam>
  </methodsynopsis>
  <para>
   &style.procedural;
  </para>
  <methodsynopsis>
   <type>NumberFormatter</type>
   <methodname>numfmt_create</methodname>
   <methodparam><type>string</type><parameter>locale</parameter></methodparam>
   <methodparam><type>int</type><parameter>style</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>pattern</parameter></methodparam>
  </methodsynopsis>
  <para>
   &style.oop; (constructor):
  </para>
   <constructorsynopsis>
    <modifier>public</modifier>
    <methodname>NumberFormatter::__construct</methodname>
    <methodparam><type>string</type><parameter>locale</parameter></methodparam>
    <methodparam><type>int</type><parameter>style</parameter></methodparam>
    <methodparam choice="opt"><type>string</type><parameter>pattern</parameter></methodparam>
   </constructorsynopsis>
  <para>
   Creates a number formatter.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>locale</parameter></term>
     <listitem>
      <para>
       Locale in which the number would be formatted (locale name, e.g. en_CA).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>style</parameter></term>
     <listitem>
      <para>
       Style of the formatting, one of the
       <link linkend="intl.numberformatter-constants.unumberformatstyle">
        format style</link> constants. If
       <constant>NumberFormatter::PATTERN_DECIMAL</constant>
       or <constant>NumberFormatter::PATTERN_RULEBASED</constant>
       is passed then the number format is opened using the given pattern,
       which must conform to the syntax described in
       <link xlink:href="&url.icu.decimalformat;">ICU DecimalFormat
       documentation</link> or
       <link xlink:href="&url.icu.ruleformat;">ICU RuleBasedNumberFormat
       documentation</link>, respectively.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>pattern</parameter></term>
     <listitem>
      <para>
       Pattern string if the chosen style requires a pattern.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>


 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns <classname>NumberFormatter</classname> object or &false; on error.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>numfmt_create</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php
$fmt = numfmt_create( 'de_DE', NumberFormatter::DECIMAL );
echo numfmt_format($fmt, 1234567.891234567890000)."\n";
$fmt = numfmt_create( 'it', NumberFormatter::SPELLOUT );
echo numfmt_format($fmt, 1142)."\n";
?>
]]>
   </programlisting>
  </example>
  <example>
   <title><function>NumberFormatter::create</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::DECIMAL );
echo $fmt->format(1234567.891234567890000)."\n";
$fmt = new NumberFormatter( 'it', NumberFormatter::SPELLOUT );
echo $fmt->format(1142)."\n";
?>
]]>
   </programlisting>
  </example>
  &example.outputs;
  <screen>
<![CDATA[
1.234.567,891
millicentoquarantadue
]]>
  </screen>
 </refsect1>

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