mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 06:18:56 +00:00
af4410a7e1
still using this, after discussion on the phpdoc list. From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
150 lines
4.1 KiB
XML
150 lines
4.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<!-- $Revision$ -->
|
||
<refentry xml:id="numberformatter.formatcurrency" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||
<refnamediv>
|
||
<refname>NumberFormatter::formatCurrency</refname>
|
||
<refname>numfmt_format_currency</refname>
|
||
<refpurpose>Format a currency value</refpurpose>
|
||
</refnamediv>
|
||
|
||
<refsect1 role="description">
|
||
&reftitle.description;
|
||
<para>
|
||
Object oriented style
|
||
</para>
|
||
<methodsynopsis>
|
||
<type>string</type>
|
||
<methodname>NumberFormatter::formatCurrency</methodname>
|
||
<methodparam><type>float</type><parameter>value</parameter></methodparam>
|
||
<methodparam><type>string</type><parameter>currency</parameter></methodparam>
|
||
</methodsynopsis>
|
||
<para>
|
||
Procedural style
|
||
</para>
|
||
<methodsynopsis>
|
||
<type>string</type>
|
||
<methodname>numfmt_format_currency</methodname>
|
||
<methodparam><type>NumberFormatter</type><parameter>fmt</parameter></methodparam>
|
||
<methodparam><type>float</type><parameter>value</parameter></methodparam>
|
||
<methodparam><type>string</type><parameter>currency</parameter></methodparam>
|
||
</methodsynopsis>
|
||
<para>
|
||
Format the currency value according to the formatter rules.
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="parameters">
|
||
&reftitle.parameters;
|
||
<para>
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term><parameter>fmt</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
<classname>NumberFormatter</classname> object.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>value</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
The numeric currency value.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>currency</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
The 3-letter ISO 4217 currency code indicating the currency to use.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
</para>
|
||
</refsect1>
|
||
|
||
|
||
<refsect1 role="returnvalues">
|
||
&reftitle.returnvalues;
|
||
<para>
|
||
String representing the formatted currency value.
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="examples">
|
||
&reftitle.examples;
|
||
<example>
|
||
<title><function>numfmt_format_currency</function> example</title>
|
||
<programlisting role="php">
|
||
<![CDATA[
|
||
<?php
|
||
$fmt = numfmt_create( 'de_DE', NumberFormatter::CURRENCY );
|
||
echo numfmt_format_currency($fmt, 1234567.891234567890000, "EUR")."\n";
|
||
echo numfmt_format_currency($fmt, 1234567.891234567890000, "RUR")."\n";
|
||
$fmt = numfmt_create( 'ru_RU', NumberFormatter::CURRENCY );
|
||
echo numfmt_format_currency($fmt, 1234567.891234567890000, "EUR")."\n";
|
||
echo numfmt_format_currency($fmt, 1234567.891234567890000, "RUR")."\n";
|
||
?>
|
||
]]>
|
||
</programlisting>
|
||
</example>
|
||
<example>
|
||
<title>OO example</title>
|
||
<programlisting role="php">
|
||
<![CDATA[
|
||
<?php
|
||
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::CURRENCY );
|
||
echo $fmt->formatCurrency(1234567.891234567890000, "EUR")."\n";
|
||
echo $fmt->formatCurrency(1234567.891234567890000, "RUR")."\n";
|
||
$fmt = new NumberFormatter( 'ru_RU', NumberFormatter::CURRENCY );
|
||
echo $fmt->formatCurrency(1234567.891234567890000, "EUR")."\n";
|
||
echo $fmt->formatCurrency(1234567.891234567890000, "RUR")."\n";
|
||
?>
|
||
]]>
|
||
</programlisting>
|
||
</example>
|
||
&example.outputs;
|
||
<screen>
|
||
<![CDATA[
|
||
1.234.567,89 €
|
||
1.234.567,89 RUR
|
||
1 234 567,89€
|
||
1 234 567,89р.
|
||
]]>
|
||
</screen>
|
||
</refsect1>
|
||
|
||
<refsect1 role="seealso">
|
||
&reftitle.seealso;
|
||
<para>
|
||
<simplelist>
|
||
<member><function>numfmt_get_error_code</function></member>
|
||
<member><function>numfmt_format</function></member>
|
||
<member><function>numfmt_parse_currency</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
|
||
-->
|