documentation/manual/en/module_specs/Zend_Currency-Number.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.currency.number">
   4     <title>How does the currency look like?</title>
   5
   6     <para>
   7         How the value of a currency will be rendered depends mainly on the used locale. There
   8         are several informations which are set by the locale. Each of them can manually be
   9         overridden by using the proper option.
  10     </para>
  11
  12     <para>
  13         For example, most locales are using the Latin script for rendering numbers. But there
  14         are languages like "Arabic" which are using other digits. And when you have an Arabic
  15         website you may also want to render other currencies by using the Arabic script. See
  16         the following example:
  17     </para>
  18
  19     <example id="zend.currency.number.example-1">
  20         <title>Using a custom script</title>
  21
  22         <para>
  23             Let's expect that we are again using our "Dollar" currency. But now we want to
  24             render our currency by using the Arabic script.
  25         </para>
  26
  27         <programlisting language="php"><![CDATA[
  28 $currency = new Zend_Currency(
  29     array(
  30         'value'  => 1000,
  31         'script' => 'Arab',
  32     )
  33 );
  34
  35 print $currency; // Could return '$ ١٬٠٠٠٫٠٠'
  36 ]]></programlisting>
  37     </example>
  38
  39     <para>
  40         For more informations about available scripts look into
  41         <classname>Zend_Locale</classname>'s <link linkend="zend.locale.numbersystems">chapter
  42             about numbering systems</link>.
  43     </para>
  44
  45     <para>
  46         But also the formatting of a currency number (money value) can be changed. Per default
  47         it depends on the used locale. It includes the separator which will be used between
  48         thousands, which sign will be used as decimal point, and also the used precision.
  49     </para>
  50
  51     <programlisting language="php"><![CDATA[
  52 $currency = new Zend_Currency(
  53     array(
  54         'value'    => 1000,
  55         'currency' => 'USD'
  56         'format'   => 'de',
  57     )
  58 );
  59
  60 print $currency; // Could return '$ 1.000'
  61 ]]></programlisting>
  62
  63     <para>
  64         There are two ways to define the format which will be used. You can either give a
  65         locale or define a format manually.
  66     </para>
  67
  68     <para>
  69         When you are using a locale for defining the format all is done automatically. The
  70         locale 'de', for example, defines '.' as separator for thousands and ',' as decimal
  71         point. Within English this is reversed.
  72     </para>
  73
  74     <programlisting language="php"><![CDATA[
  75 $currency_1 = new Zend_Currency(
  76     array(
  77         'value'    => 1000,
  78         'currency' => 'USD'
  79         'format'   => 'de',
  80     )
  81 );
  82
  83 $currency_2 = new Zend_Currency(
  84     array(
  85         'value'    => 1000,
  86         'currency' => 'USD'
  87         'format'   => 'en',
  88     )
  89 );
  90
  91 print $currency_1; // Could return '$ 1.000'
  92 print $currency_2; // Could return '$ 1,000'
  93 ]]></programlisting>
  94
  95     <para>
  96         When you define it manually then you must conform the format as described in
  97         <link linkend="zend.locale.number.localize.table-1">this chapter about
  98             localizing</link>. See the following:
  99     </para>
 100
 101     <programlisting language="php"><![CDATA[
 102 $currency = new Zend_Currency(
 103     array(
 104         'value'    => 1000,
 105         'currency' => 'USD'
 106         'format'   => '#0',
 107     )
 108 );
 109
 110 print $currency; // Could return '$ 1000'
 111 ]]></programlisting>
 112
 113     <para>
 114         In the above snippet we deleted the separator and also the precision.
 115     </para>
 116 </sect1>