Zend Framework 1.9.9 Manual
|
|
Um Zend_Currency in einer Anwendung zu verwenden muß nur eine Instanz
davon erstellt werden ohne das Parameter angegeben werden. Das Erstellt eine Instanz von
Zend_Currency mit deinem Gebietsschema, und definiert die Währung die
aktuell in diesem Gebietsschema verwendet wird.
Example #1 Eine Instanz von Zend_Currency anhand des Gebietsschemas erstellen
Angenommen 'en_US' ist, durch die Umgebung des Benutzers, als aktuelles Gebietsschema
gesetzt. Durch das Angeben keines einzigen Parameters wärend der Erstellung der Instanz
kann Zend_Currency gesagt werden das es die aktuelle Währung des
Gebietsschemas 'en_US' verwenden soll. Das führt zu einer Instanz mit US Dollar als
aktueller Währung mit den Formatregeln von 'en_US'.
$currency = new Zend_Currency();
Zend_Currency unterstützt auch die Verwendung eines
Anwendungsweiten Gebietsschemas. Man kann eine Zend_Locale Instanz
in der Registry wie unten gezeigt setzen. Mit dieser Schreibweise kann man verhindern das
Gebietsschematas mit jeder Instanz gesetzt werden müssen wenn man das gleiche Gebietsschema
in der gesamten Anwendung verwenden will.
// In der Bootstrap Datei
$locale = new Zend_Locale('de_AT');
Zend_Registry::set('Zend_Locale', $locale);
// Irgendwo in der Anwendung
$currency = new Zend_Currency();
Note:
Wenn das eigene System kein standardmäßiges Gebietsschema hat, oder das Gebietsschema des eigenen Systems nicht automatisch eruiert werden kann, wird
Zend_Currencyeine Ausnahme werfen. Wenn dieses Verhalten auftritt sollte man daran denken das Gebietsschema per Hand zu setzen.
Abhängig von den eigenen Bedürfnissen, können verschiedene Parameter bei der Instanzierung angegeben werden. Jeder dieser Parameter ist optional und kann unterdrückt werden. Selbst die Reihenfolge dieser Parameter kann gewechselt werden. Die Bedeutung dieser Parmeter wird in der folgenden Liste beschrieben:
currency:
Ein Gebietsschema kann verschiedene Währungen beinhalten. Deshalb kann der erste Parameter 'currency' definieren welche Währung verwendet werden soll indem der Kurzname oder der komplette Name dieser Währung angegeben wird. Wenn die angegebene Währung in keinem Gebietsschema erkannt wird, wird eine Ausnahme geworfen. Kurznamen von Währungen bestehen immer aus 3 Buchstaben und sind groß geschrieben. Bekannte Kurznamen von Währungen sind zum Beispiel USD oder EUR.
locale:
Der 'locale' Parameter definiert welches Gebietsschema für die Formatierung der Währung verwendet werden soll. Das spezifizierte Gebietsschema wird auch verwendet um die Schreibweise und das Symbol für diese Währung zu erhalten wenn diese Parameter nicht angegeben werden.
Note:
Es gilt zu Beachten das Zend_Currency nur Gebietsschema akzeptiert die eine Region beinhalten. Das bedeutet das alle angegebenen Gebietsschemata die nur eine Sprache beinhalten zu einer Ausnahme führen. Zum Beispiel wird das Gebietsschema en zu einer Ausnahme führen, aber das Gebietsschema en_US wird als Währung USD zurückgeben.
Example #2 Andere Wege für die Erstellung einer Instanz von Zend_Currency
// Wir nehmen das Standardgebietsschema 'de_AT' an
// Erstellt eine Instanz von from 'en_US' und verwendet
// 'USD' welches die Standardwert von 'en_US' ist
$currency = new Zend_Currency('en_US');
// Erstellt eine Instanz vom aktuellen Gebietsschema
// ('de_AT') und verwendet 'EUR' als Währung
$currency = new Zend_Currency();
// Erstellt eine Instanz und verwendet 'EUR' als Währung,
// 'en_US' für die Formatierung der Ziffern
$currency = new Zend_Currency('en_US', 'EUR');
Es können also alle diese Parameter bei Zend_Currency's Constructor
unterdrückt werden wenn man die Standardwerte verwenden will. Das hat keine negativen
Effekte bei der Handhabung von Währungen. Es kann aber nützlich sein, wenn man zum Beispiel
die Standardwährung einer Region nicht weiß.
Note:
Für viele Länder gibt es verschiedene bekannt Währungen. Typishcerweise wird eine Währung immer gerade aktuell verwendet und es gibt eventuell noch alte Währungen. Wenn der 'currency' Parameter unterdrückt wird, wird immer die aktuelle Währung verwendet. Die Region 'de' zum Beispiel kennt die Währungen 'EUR' und 'DEM'... 'EUR' ist die aktuell verwendete Währung und wird verwendet wenn der Parameter unterdrückt wird.
Um einen nummerischen Wert in einen formatierten String für die aktuelle Währung zu konvertieren, muß man die Methode toCurrency() verwenden. Sie nimmt einen Wert der konvertiert werden soll. Der Wert selbst kann jede normalisierte Zahl sein.
Wenn man nur eine lokalisierte Zahl hat, muß diese zuerst mit Zend_Locale_Format::getNumber() in einen normalisierte Zahl konvertiert werden. Dann kann Sie mit toCurrency() verwendet werden um eine Ausgabe einer Währung zu erstellen.
toCurrency(array $options) akzeptiert ein Array mit Optionen welche gesetzt werden können um temporär ein Format oder eine Darstellung einer Währung zu setzen. Für Details darüber, welche Optionen gesetzt werden können, siehe Ändern des Formats einer Währung.
Example #3 Erstellung und Ausgabe eines Strings einer Währung
// Erstellt eine Instanz mit 'en_US' und verwendet 'USD'
// welches die Standardwert von 'en_US' sind
$currency = new Zend_Currency('en_US');
// Gibt '$ 1,000.00' aus
echo $currency->toCurrency(1000);
// Gibt '$ 1.000,00' aus
echo $currency->toCurrency(1000, array('format' => 'de_AT'));
// Gibt '$ ١٬٠٠٠٫٠٠' aus
echo $currency->toCurrency(1000, array('script' => 'Arab'));
Das Format das bei der Erstellung der Zend_Currency Instanz
angegeben wurde, ist natürlich das Standardformat. Aber manchmal ist es nützlich dieses
Format anzupassen.
Das Format einer Währung enthält die folgenden Teile:
Symbol, Kurzname oder Name der Währung:
Das Symbol der Währung wird normalerweise bei der Ausgabe eines Währungs Strings angezeigt. Es kann unterdrückt oder sogar überschrieben werden wenn das notwendig ist.
Position der Währung:
Die Position des Währungssymbols ist normalerweise automatisch durch das Gebietsschema definiert. Es kann geändert werden wenn das notwendig ist.
Script:
Die Schreibweise die verwendet werden soll um Ziffern anzuzeigen. Detailierte
Informationen über Schreibweisen und deren verwendung kann in der Dokumentation
von Zend_Locale im Kapitel
zend.locale.parsing.html#zend.locale.numbersystems gefunden werden.
Zahlenformat:
Der Wert der Währung (üblicherweise bekannt als Geldwert) wird durch die Verwendung der Formatierungsregeln des Gebietsschemas formatiert. Zum Beispiel wird im Englischen das ',' Zeichen als Separator für Tausender verwendet wärend im Deutschen das '.' Zeichen verwendet wird.
Wenn man also das Format ändern muß, kann die setFormat() Methode verwendet werden. Diese akzeptiert ein Array welches alle Optionen enthält die geändert werden sollen. Das $options Array unterstützt folgenden Einstellungen:
position: Definiert die Position an der die Beschreibung der Währung angezeigt werden soll. Die unterstützten Positionen können in dieser Tabelle gefunden werden.
script: Definiert welche Schreibweise für die Anzeige von Ziffern verwendet werden soll. Die Standardschreibweise der meisten Gebietsschemata ist 'Latn', welches die Ziffern 0 bis 9 enthält. Aber auch andere Schreibweisen wie 'Arab' (Arabisch) können verwendet werden.
format: Definiert das Format welches verwendet werden
soll um Nummern darzustellen. Dieses Nummern-Format enthält zum Beispiel das
Trennzeichen für Tausender. Man kann entweder ein Standardformat verwenden indem
ein Identifikator für ein Gebietsschema angegeben wird, oder das Nummern-Format
manuell definieren. Wenn kein Format gesetzt wurde, wird das Gebietsschema vom
Zend_Currency Objekt verwendet.
display: Definiert welcher Teil der Währung verwendet werden soll um die Währung darzustellen. Es gibt 4 Darstellungen welche verwendet werden können. Sie werden in dieser Tabelle beschrieben.
precision: Definiert die Genauigkeit welche für die Darstellung der Währung verwendet werden soll. Der Standardwert ist 2.
name: Definiert den kompletten Namen der Währung der
angezeigt werden soll. Diese Option überschreibt den Namen der Währung der durch
die Erstellung von Zend_Currency gesetzt wurde.
currency: Definiert die internationale Abkürzung die
angezeigt werden soll. Diese Option überschreibt die Abkürzung die durch die
Erstellung von Zend_Currency gesetzt wurde.
symbol: Definiert das Symbol der Währung welches
angezeigt werden soll. Diese Option überschreibt das Symbol das durch die
Erstellung von Zend_Currency gesetzt wurde.
| Konstante | Beschreibung |
|---|---|
| NO_SYMBOL | Keine Repräsentation der Währung anzeigen |
| USE_SYMBOL | Das Währungssymbol anzeigen |
| USE_SHORTNAME | Die internationale Abkürzung der Währung (3 Buchstaben) anzeigen |
| USE_NAME | Den kompletten Währungsnamen anzeigen |
| Konstante | Beschreibung |
|---|---|
| STANDARD | Setzt die Position auf den Standard wie im Gebietsschema definiert |
| RIGHT | Die Währung soll an der rechten Seite vom Wert anzeigen werden |
| LEFT | Die Währung soll an der linken Seite vom Wert anzeigen werden |
Example #4 Das Anzeigeformat der Währung ändern
// Erstellt eine Instanz mit 'en_US' und verwendet 'USD', 'Latin'
// und 'en_US' da das die Standardwerte von 'en_US' sind
$currency = new Zend_Currency('en_US');
// Gibt 'US$ 1,000.00' aus
echo $currency->toCurrency(1000);
$currency->setFormat(array('display' => Zend_Currency::USE_NAME,
'position' => Zend_Currency::RIGHT));
// Gibt '1.000,00 US Dollar' aus
echo $currency->toCurrency(1000);
$currency->setFormat(array('name' => 'Amerikanische Dollar'));
// Gibt '1.000,00 Amerikanische Dollar' aus
echo $currency->toCurrency(1000);
$currency->setFormat(array('format' => '##0.00'));
// Gibt '1000,00 Amerikanische Dollar' aus
echo $currency->toCurrency(1000);
Natürlich bietet Zend_Currency auch Methoden an um Informationen
über jede existierende und viele historische Währungen von
Zend_Locale zu bekommen. Die unterstützten Methoden sind:
getSymbol():
Gibt das bekannte Symbol der aktuellen oder einer angegebenen Währung zurück. Zum Beispiel $ für den US Dollar innerhalb des Gebietsschemas 'en_US'.
getShortName():
Gibt die Abkürzung der aktuellen oder einer angegebenen Währung zurück. Zum Beispiel USD für den US Dollar innerhalb des Gebietsschemas 'en_US'.
getName():
Gibt den kompletten Namen der aktuellen oder einer angegebenen Währung zurück. Zum Beispiel US Dollar für den US Dollar innerhalb des Gebietsschemas 'en_US'.
getRegionList():
Gibt eine Liste von Regionen zurück in denen die aktuelle oder eine angegebene Währung verwendet wird. Es ist möglich das eine Währung in mehreren Regionen Verwendung findet, deswegen ist der Rückgabewert immer ein Array.
getCurrencyList():
Gibt eine Liste von Währungen zurück die in einer angegebenen Region verwendet werden.
Die Funktion getSymbol(), getShortName() und getName() akzeptieren zwei optionale Parameter. Wenn kein Parameter angegeben wird, werden die Daten von der aktuell gesetzten Währung zurückgegeben. Der erste Parameter akzeptiert den Kurznamen der Währung. Kurznamen bestehen immer aus drei Buchstaben, zum Beispiel EUR für Euro oder USD für US Dollar. Der zweite Parameter definiert von welchem Gebietsschema die Daten gelesen werden sollen. Wenn kein Gebietsschema angegeben wird, wird das aktuelle Gebietsschema verwendet.
Example #5 Informationen von Währungen erhalten
// Erstellt eine Instanz mit 'en_US' und verwendet 'USD', 'Latin'
// und 'en_US' da das die Standardwerte von 'en_US' sind
$currency = new Zend_Currency('en_US');
// Gibt '$' aus
echo $currency->getSymbol();
// Gibt 'EUR' aus
echo $currency->getShortName('EUR');
// Gibt 'Österreichische Schilling' aus
echo $currency->getName('ATS', 'de_AT');
// Gibt ein Array aus mit allen Regionen in denen USD verwendet wird
print_r($currency->getRegionList();
// Gibt ein Array aus mit allen Währungen die jemals in dieser
// Region verwendet wurden
print_r($currency->getCurrencyList('de_AT');
Die Methode setLocale() erlaubt es ein neues Gebietsschema für
Zend_Currency zu setzen. Alle Standardwerte werden überschrieben
wenn diese Funktion aufgerufen wird. Das beinhaltet den Namen der Währung, die Abkürzung
und das Symbol.
Example #6 Ein neues Gebietsschema setzen
// Die Währung für US bekommen
$currency = new Zend_Currency('en_US');
print $currency->toCurrency(1000);
// Die Währung für AT erhalten
$currency->setLocale('de_AT');
print $currency->toCurrency(1000);
Zend_Currency's Geschwindigkeit kann optimiert werden indem
Zend_Cache verwendet wird. Die statischen Methode
Zend_Currency::setCache($cache) akzeptiert eine Option: Einen
Zend_Cache Adapter. Wenn der Cache Adapter gesetzt wird, werden
die Lokalisierungsdaten von Zend_Currency gecached. Es gibt einige statischen Methoden
für die Manipulation des Caches: Zend_Currency::getCache(),
hasCache(), clearCache() und
removeCache().
Example #7 Cachen von Währungen
// Ein Cache-Objekt erstellen
$cache = Zend_Cache::factory('Core',
'File',
array('lifetime' => 120,
'automatic_serialization' => true),
array('cache_dir'
=> dirname(__FILE__) . '/_files/'));
Zend_Currency::setCache($cache);
|
|
|