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

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.currency.options">
   4     <title>Options for currencies</title>
   5
   6     <para>
   7         Depending on your needs, several options can be specified at instantiation. All of this
   8         options have default values. But sometimes it is necessary to define how your currencies
   9         will be rendered. This includes for example:
  10     </para>
  11
  12     <itemizedlist mark='opencircle'>
  13         <listitem>
  14             <para>
  15                 <emphasis>Currency symbol, shortname or name</emphasis>:
  16             </para>
  17
  18             <para>
  19                 <classname>Zend_Currency</classname> knows all currency names, abbreviations and
  20                 signs. But sometimes you could be in need to define the string which has to be
  21                 displayed as replacement for a currency.
  22             </para>
  23         </listitem>
  24
  25         <listitem>
  26             <para>
  27                 <emphasis>Currency position</emphasis>:
  28             </para>
  29
  30             <para>
  31                 The position of the currency symbol is automatically defined. But sometimes you
  32                 could be in need to define it manually.
  33             </para>
  34         </listitem>
  35
  36         <listitem>
  37             <para>
  38                 <emphasis>Script</emphasis>:
  39             </para>
  40
  41             <para>
  42                 You could define the script which shall be used to display digits. Detailed
  43                 information about scripts and their usage can be found in
  44                 <classname>Zend_Locale</classname>'s chapter <link
  45                     linkend="zend.locale.numbersystems">Numeral System Conversion</link>.
  46             </para>
  47         </listitem>
  48
  49         <listitem>
  50             <para>
  51                 <emphasis>Number formatting</emphasis>:
  52             </para>
  53
  54             <para>
  55                 The amount of currency (generally known as money value) is formatted by
  56                 using the formatting rules defined by the locale. For example is the ','
  57                 sign in English used as separator for thousands, but in German as precision
  58                 sign.
  59             </para>
  60         </listitem>
  61     </itemizedlist>
  62
  63     <para>
  64         The following list mentions all options which could be set. They can either be set at
  65         initiation or by using the <methodname>setFormat()</methodname> method. In any case
  66         you have to give this options as array.
  67     </para>
  68
  69     <itemizedlist mark='opencircle'>
  70         <listitem>
  71             <para>
  72                 <emphasis><property>currency</property></emphasis>: Defines the abbreviation
  73                 which can be displayed.
  74             </para>
  75         </listitem>
  76
  77         <listitem>
  78             <para>
  79                 <emphasis><property>display</property></emphasis>: Defines which part of the
  80                 currency should be used for displaying the currency representation. There are 4
  81                 representations which can be used and which are all described in <link
  82                     linkend="zend.currency.description">this
  83                     table</link>.
  84             </para>
  85         </listitem>
  86
  87         <listitem>
  88             <para>
  89                 <emphasis><property>format</property></emphasis>: Defines the format which
  90                 should be used for displaying numbers. This number-format includes for example
  91                 the thousand separator. You can either use a default format by giving a locale
  92                 identifier, or define the number-format manually. If no format is set the locale
  93                 from the <classname>Zend_Currency</classname> object will be used. See <link
  94                     linkend="zend.locale.number.localize.table-1">the chapter about number
  95                     formatting</link> for details.
  96             </para>
  97         </listitem>
  98
  99         <listitem>
 100             <para>
 101                 <emphasis><property>locale</property></emphasis>: Defines a locale for this
 102                 currency. It will be used for detecting the default values when other settings
 103                 are omitted. Note that when you don't set a locale yourself, it will be detected
 104                 automatically which could lead to problems.
 105             </para>
 106         </listitem>
 107
 108         <listitem>
 109             <para>
 110                 <emphasis><property>name</property></emphasis>: Defines the full currency name
 111                 which can be displayed.
 112             </para>
 113         </listitem>
 114
 115         <listitem>
 116             <para>
 117                 <emphasis><property>position</property></emphasis>: Defines the position at
 118                 which the currency description should be displayed. The supported positions are
 119                 described <link
 120                     linkend="zend.currency.position">this section</link>.
 121             </para>
 122         </listitem>
 123
 124         <listitem>
 125             <para>
 126                 <emphasis><property>precision</property></emphasis>: Defines the precision which
 127                 should be used for the currency representation. The default value depends on the
 128                 locale and is for most locales <emphasis>2</emphasis>.
 129             </para>
 130         </listitem>
 131
 132         <listitem>
 133             <para>
 134                 <emphasis><property>script</property></emphasis>: Defined which script should
 135                 be used for displaying digits. The default script for most locales is
 136                 <emphasis>'Latn'</emphasis>, which includes the digits 0 to 9. Other
 137                 scripts such as 'Arab' (Arabian) are using other digits. See <link
 138                     linkend="zend.locale.numbersystems">the chapter about numbering
 139                     systems</link> for details and available options.
 140             </para>
 141         </listitem>
 142
 143         <listitem>
 144             <para>
 145                 <emphasis><property>service</property></emphasis>: Defines the exchange service
 146                 which has to be used when calculating with different currencies.
 147             </para>
 148         </listitem>
 149
 150         <listitem>
 151             <para>
 152                 <emphasis><property>symbol</property></emphasis>: Defines the currency symbol
 153                 which can be displayed.
 154             </para>
 155         </listitem>
 156
 157         <listitem>
 158             <para>
 159                 <emphasis><property>value</property></emphasis>: Defines the currency amount
 160                 (money value). Using this option you should also set the
 161                 <property>service</property> option.
 162             </para>
 163         </listitem>
 164     </itemizedlist>
 165
 166     <para>
 167         As you can see there is much which could be changed. Still as already mentioned the
 168         default values for this settings conform the official standard for currency
 169         representation in every country.
 170     </para>
 171 </sect1>