1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<refentry xml:id="numberformatter.parsecurrency" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>NumberFormatter::parseCurrency</refname>
<refname>numfmt_parse_currency</refname>
<refpurpose>Parse a currency number</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>
Object oriented style
</para>
<methodsynopsis>
<type>double</type>
<methodname>NumberFormatter::parseCurrency</methodname>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
<methodparam><type>string</type><parameter role="reference">currency</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter role="reference">position</parameter></methodparam>
</methodsynopsis>
<para>
Procedural style
</para>
<methodsynopsis>
<type>double</type>
<methodname>numfmt_parse_currency</methodname>
<methodparam><type>NumberFormatter</type><parameter>fmt</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
<methodparam><type>string</type><parameter role="reference">currency</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter role="reference">position</parameter></methodparam>
</methodsynopsis>
<para>
Parse a string into a double and a currency using the current formatter.
</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>position</parameter></term>
<listitem>
<para>
Parameter to receive the currency name (3-letter ISO 4217 currency
code).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>position</parameter></term>
<listitem>
<para>
Offset in the string at which to begin parsing. On return, this value
will hold the offset at which parsing ended.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The parsed numeric value or &false; on error.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>numfmt_parse_currency</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$fmt = numfmt_create( 'de_DE', NumberFormatter::CURRENCY );
$num = "1.234.567,89 $";
echo "We have ".numfmt_parse_currency($fmt, $num, $curr)." in $curr\n";
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
<?php
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::CURRENCY );
$num = "1.234.567,89 $";
echo "We have ".$fmt->parseCurrency($num, $curr)." in $curr\n";
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
We have 1234567.89 in USD
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>numfmt_get_error_code</function></member>
<member><function>numfmt_parse</function></member>
<member><function>numfmt_format_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:"../../../../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
-->
|