Zend_Currency-Description.xml 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.currency.description">
  5. <title>Was macht eine Währung aus?</title>
  6. <para>
  7. Eine Währung besteht aus verschiedenen Informationen. Einem Namen, einer Abkürzung und einem
  8. Zeichen. Jeder dieser Werte könnte relevant sein um dargestellt zu werden, aber immer nur
  9. einer zur selben Zeit. Es würde keine gute Praxis sein etwas wie "USD 1.000 $" anzuzeigen.
  10. </para>
  11. <para>
  12. Hierfür unterstützt <classname>Zend_Currency</classname> die Definition der
  13. Währungsinformation welche dargestellt werden soll. Die folgenden Konstanten können
  14. verwendet werden:
  15. </para>
  16. <table id="zend.currency.description.table-1">
  17. <title>Dargestellte Informationen für eine Währung</title>
  18. <tgroup cols="2" align="left">
  19. <thead>
  20. <row>
  21. <entry>Konstante</entry>
  22. <entry>Beschreibung</entry>
  23. </row>
  24. </thead>
  25. <tbody>
  26. <row>
  27. <entry><constant>NO_SYMBOL</constant></entry>
  28. <entry>Es wird gar keine Darstellung einer Währung angezeigt</entry>
  29. </row>
  30. <row>
  31. <entry><constant>USE_SYMBOL</constant></entry>
  32. <entry>
  33. Das Währungssymbol wird dargestellt. Für US Dollar wäre dies '$'
  34. </entry>
  35. </row>
  36. <row>
  37. <entry><constant>USE_SHORTNAME</constant></entry>
  38. <entry>
  39. Die Abkürzung für diese Währung wird dargestellt. Für US Dollar wäre dies
  40. 'USD'. Die meisten Abkürzungen bestehen aus 3 Zeichen.
  41. </entry>
  42. </row>
  43. <row>
  44. <entry><constant>USE_NAME</constant></entry>
  45. <entry>
  46. Der komplette Name für diese Währung wird dargestellt. Für US Dollar wäre
  47. der komplette Name "US Dollar"
  48. </entry>
  49. </row>
  50. </tbody>
  51. </tgroup>
  52. </table>
  53. <example id="zend.currency.description.example-1">
  54. <title>Auswahl der Währungsbeschreibung</title>
  55. <para>
  56. Angenommen unser Client setzt wieder "en_US" als Gebietsschema. Wenn keine Option
  57. verwendet wird könnte der zurückgegebene Wert wie folgt aussehen:
  58. </para>
  59. <programlisting language="php"><![CDATA[
  60. $currency = new Zend_Currency(
  61. array(
  62. 'value' => 100,
  63. )
  64. );
  65. print $currency; // Könnte '$ 100' zurückgeben
  66. ]]></programlisting>
  67. <para>
  68. Durch Angabe der richtigen Option kann definiert werden welche Information dargestellt
  69. werden soll.
  70. </para>
  71. <programlisting language="php"><![CDATA[
  72. $currency = new Zend_Currency(
  73. array(
  74. 'value' => 100,
  75. 'display' => Zend_Currency::USE_SHORTNAME,
  76. )
  77. );
  78. print $currency; // Könnte 'USD 100' zurückgeben
  79. ]]></programlisting>
  80. <para>
  81. Ohne Angabe von <property>display</property> wird das Währungssymbol für die Darstellung
  82. des Objekts verwendet. Wen die Währung kein Symbol hat wird die Abkürzung als Ersatz
  83. verwendet.
  84. </para>
  85. </example>
  86. <note>
  87. <title>Nicht alle Währungen haben Symbole</title>
  88. <para>
  89. Man sollte beachten das nicht alle Währungen standardmäßige Währungssymbole haben. Das
  90. bedeutet, wenn es kein Standardsymbol gibt, und das Symbol als dargestellt setzt, wird
  91. man überhaupt keine dargestellte Währung haben, da das Symbol ein leerer String ist.
  92. </para>
  93. </note>
  94. <para>
  95. Manchmal ist es notwendig die Standardinformationen zu ändern. Man kann jede der drei
  96. Währungsinformationen unabhängig setzen indem die richtige Option angegeben wird. Siehe
  97. das folgende Beispiel.
  98. </para>
  99. <example id="zend.currency.description.example-2">
  100. <title>Verändern der Beschreibung einer Währung</title>
  101. <para>
  102. Angenommen unser Client hat wieder mal "en_US" als Gebietsschema gesetzt. Aber jetzt
  103. wollen sie nicht die Standardeinstellungen verwenden sondern unsere eigene
  104. Beschreibung setzen. Das kann einfach durch Angabe der richtigen Option durchgeführt
  105. werden:
  106. </para>
  107. <programlisting language="php"><![CDATA[
  108. $currency = new Zend_Currency(
  109. array(
  110. 'value' => 100,
  111. 'name' => 'Dollar',
  112. )
  113. );
  114. print $currency; // Könnte 'Dollar 100' zurückgeben
  115. ]]></programlisting>
  116. <para>
  117. Man kann auch ein Symbol oder eine Abkürzung selbst setzen.
  118. </para>
  119. <programlisting language="php"><![CDATA[
  120. $currency = new Zend_Currency(
  121. array(
  122. 'value' => 100,
  123. 'symbol' => '$$$',
  124. )
  125. );
  126. print $currency; // Könnte '$$$ 100' zurückgeben
  127. ]]></programlisting>
  128. </example>
  129. <note>
  130. <title>Einstellungen für die automatische Anzeige</title>
  131. <para>
  132. Wenn man einen Namen, eine Abkürzung oder ein Symbol selbst setzt, dann werden diese
  133. neuen Informationen automatisch gesetzt und dargestellt. Diese Vereinfachung verhindert
  134. das man die richtige <property>display</property> Option angeben muss wenn eine
  135. Information gesetzt wird.
  136. </para>
  137. <para>
  138. Wenn man also die Option <property>sign</property> verwendet kann man
  139. <property>display</property> unterdrücken und muss diese nicht auf
  140. '<constant>USE_SYMBOL</constant>' setzen.
  141. </para>
  142. </note>
  143. </sect1>