Programmer's Reference Guide

Einführung in Zend_Currency

Arbeiten mit Währungen

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 dem aktuellen Gebietsschema, und definiert die Währung die aktuell in diesem Gebietsschema verwendet wird.

Beispiel #1 Eine Instanz von Zend_Currency anhand des aktuellen 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'. Expect you have 'en_US' set as actual locale through the users or your environment. By using no parameter while creating the instance you say Zend_Currency to use the actual currency from the locale 'en_US'. This leads to an instance with US Dollar set as actual currency with the formatting rules from 'en_US'.

$currency = new Zend_Currency();

        

Seit dem Zend Framework 1.7.0 unterstützt Zend_Currency auch die Verwendung eines Anwendungsweiten Gebietsschemas. Man kann einfach eine Zend_Locale Instanz in der Registry setzen wie unten gezeigt. Mit dieser Schreibweise kann man das manuelle Setzen eines Gebietsschemas mit jeder Instanz komplett vergessen wenn man das gleiche Gebietsschema mehrere Male 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();

    

Hinweis: Es ist zu beachten, das wenn das eigene System kein standardmäßiges Gebietsschema hat, oder das Gebietsschema des eigenen Systems nicht automatisch eruiert werden kann, wird Zend_Currency eine Ausnahme werfen. Wenn dieses Verhalten auftritt sollte das Gebietsschema per Hand gesezt werden.

Natürlich können, abhängig von den eigenen Bedürfnissen, verschiedene Parameter bei der Erstellung 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 bekannt ist, wird eine Ausnahme geworfen. Kurznamen von Währungen bestehen immer aus 3 Buchstaben und werden groß geschrieben. Bekannte Kurznamen von Währungen sind zum Beispiel USD oder EUR. Für eine Liste aller bekannten Währungen gibt es die Informativen Methoden von Zend_Currency.

  • locale:

    Der dritte Parameter 'locale' definiert welches Gebietsschema für die Formatierung der Währung verwendet werden soll. Das angegebene Gebietsschema wird auch verwendet um die Standardschreibweise und die Währung dieses Gebietsschemas zu erhalten wenn diese Parameter nicht angegeben werden.

    Hinweis: 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 eine Ausnahme werfen. Zum Beispiel wird das Gebietsschema en eine Ausnahme werfen, aber das Gebietsschema en_US wird als Währung USD zurückgeben.

Beispiel #2 Andere Beispiele 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 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 z.B. die Standardwährung einer Region nicht weiß.

Hinweis: Für viele Länder gibt es verschiedene bekannt Währungen. Eine Währung wird immer aktuell gerade 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.

Eine Ausgabe von einer Währung erstellen

Um einen bestehenden Wert in eine formatierte Ausgabe einer Währung zu konvertieren, muß die Methode toCurrency() verwendet werden. 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. Danach 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.

Beispiel #3 Eine Ausgabe für eine Währung erstellen

// 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 einer Währung ändern

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 für eigene Zwecke 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 einer Währung 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 unter unterstützte Schreibweisen für Ziffern 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.

So if you are in need to change the format, you can use the setFormat() method. It takes an array which includes all options which you want to change. The options array supports the following 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 folgendes

  • 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. Alle unterstützten Schreibweisen können in dieser Tabelle gefunden werden.

  • format: Definiert welches Gebietsschema verwendet werden soll um Nummern darzustellen. Dieses Nummern-Format enthält zum Beispiel das Trennzeichen für Tausender. 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.

Konstanten für die Auswahl der Beschreibung einer Währung
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
Konstanten für die Auswahl der Position der Währung
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

Beispiel #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('display' => Zend_Currency::USE_NAME,
                     'position' => Zend_Currency::RIGHT);
// Gibt '1.000,00 US Dollar' aus
echo $currency->toCurrency(1000);

$currency->setFormat('name' => 'Amerikanische Dollar');
// Gibt '1.000,00 Amerikanische Dollar' aus
echo $currency->toCurrency(1000);

            

Informative Methoden von Zend_Currency

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.

Beispiel #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');

            

Neue Standardwerte setzen

Die Methode setLocale erlaubt es ein neues Gebietsschema für Zend_Currency zu setzen. Wenn diese Funktion aufgerufen wird werden auch alle Standardwerte für die Währung überschrieben. Das beinhaltet den Namen der Währung, die Abkürzung und das Symbol.

Beispiel #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 schneller machen

Zend_Currency kann schneller gemacht werden indem Zend_Cache verwendet wird. Durch die Verwendung der statischen Methode Zend_Currency::setCache($cache) welche eine Option akzeptiert, nämlich einen Zend_Cache Adapter. Wenn dieser gesetzt wird, werden die Lokalisierungsdaten der Methoden von Zend_Currency gecached. Der Bequemlichkeit halber gibt es auch die statische Methode Zend_Currency::getCache().

Beispiel #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);

            

Einführung in Zend_Currency
blog comments powered by Disqus

Select a Version

Languages Available

Components

Search the Manual