Programmer's Reference Guide
| Adapter für Zend_Translate |
Benutzen von Übersetzungs Adaptoren
Der nächste Schritt ist die Benutzung des Adapters im eigenen Code.
Beispiel #1 Beispiel eines einsprachigen PHP Codes
print "Beispiel\n";
print "========\n";
print "Hier steht Zeile eins\n";
print "Heute ist der " . date("d.m.Y") . "\n";
print "\n";
print "Hier ist Zeile zwei\n";
Das obige Beispiel zeigt eine Ausgabe ohne Unterstützung für Übersetzungen. Der Code wird üblicherweise in der eigenen Muttersprache geschrieben. Üblicherweise muß nicht nur die Ausgabe übersetzt werden, sondern auch Fehler- und Logmeldungen.
Der nächste Schritt ist also die Integration von Zend_Translate in den eigenen Code. Natürlich ist das viel einfacher wenn der Code bereits so geschrieben wird das er übersetzbar ist, anstatt Ihn im Nachhinein dafür zu ändern.
Beispiel #2 Beispiel für mehrsprachigen PHP Code
$translate = new Zend_Translate(
'gettext',
'/path/to/translation/source-de.mo',
'de'
);
$translate->addTranslation('//my/path/fr-source.mo', 'fr');
print $translate->_("Beispiel") . "\n";
print "========\n";
print $translate->_("Hier steht Zeile eins") . "\n";
printf($translate->_("Heute ist der %1\$s") . "\n", date('d.m.Y'));
print "\n";
$translate->setLocale('fr');
print $translate->_("Hier ist Zeile zwei") . "\n";
Jetzt schauen wir uns genauer an, was getan wurde, und wie Zend_Translate in den eigenen Code integriert wird.
Erstelle ein neues Zend_Translate Objekt und definiere den Basis Adapter:
$translate = new Zend_Translate(
'gettext',
'/path/to/translation/source-de.mo',
'de'
);
Der nächste Schritt besteht darin alle Strings zu ummanteln die übersetzt werden sollen. Die einfachste Möglichkeit besteht wenn nur einfache Strings oder Sätze vorhanden sind wie zum Beispiel:
print $translate->_("Beispiel") . "\n";
print "========\n";
print $translate->_("Hier ist die Zeile Eins") . "\n";
Variable Werte in eine Übersetzung zu integrieren wird aber auch unterstützt durch die Verwendung von eingebetteten Parametern.
printf($translate->_("Today is the %1\$s") . "\n", date("d.m.Y"));
print() wird die printf() Funktion benutzt
und alle variablen Parameter mit %1\$s Blöcken ersetzt.
Der erste ist %1\$s, der zweite ist %2\$s, und so weiter.
Auf diesen Weg kann übersetzt werden ohne den exakten Wert zu wissen. In unserem
Beispiel ist das Datum immer der aktuelle Tag, aber der String kann übersetzt
werden ohne über den aktuellen Tag bescheid zu wissen.
Jeder String wird im Übersetzungsspeicher identifiziert durch seine Message ID. Man könnte diese Message IDs statt des Strings im Code wie folgt verwenden:
print $translate->_(1) . "\n"; print "=======\n"; print $translate->_(2) . "\n";
Es ist nicht erkennbar was der Code ausgeben sollte indem man ihn betrachtet.
Es werden auch Probleme auftreten wenn einige Strings nicht übersetzt worden sind. Man muß sich immer vor Augen halten wie Übersetzungen funktionieren. Zuerst prüft Zend_Translate ob in der gesetzten Sprache, für die angegebene Message ID oder den String, eine Übersetzung vorhanden ist. Wenn kein Übersetzung gefunden wurde, wird in der nächsten tiefer gelegenen Sprache gesucht wie in Zend_Locale definiert. "de_AT" wird also zu "de". Wenn auch hier keine Übersetzung in der Sprache "de" gefunden wurde, wird der Original String zurück gegeben. Das bedeutet also das immer eine Ausgabe existiert, selbst wenn für eine Message ID keine Übersetzung in der Quelle vorhanden ist. Zend_Translate wird niemals eine Exception oder einen Fehler ausgeben wenn ein String übersetzt werden soll.
Strukturen für Übersetzungdateien
Der nächste Schritt besteht in der Erstellung der Übersetzungsdateien für die verschiedenen Sprachen welche übersetzt werden sollen. Jeder Adapter wird auf seine eigene Weise, wie hier beschrieben, erstellt aber es gibt ein paar generelle Features die für alle Adapter relevant sind.
Zuerst muß entschieden werden wo die Übersetzung Dateien zu speichern sind. Bei der Verwendung von Zend_Translate gibt es keinerlei Einschränkungen. Aber die folgenden Strukturen bevorzugt verwendet werden:
-
Einzeln strukturierte Quellen
/application/ /languages/ /languages/lang.en /languages/lang.de /library/
Positiv: Alle Quell Dateien, für jede Sprache, werden in einem einzelnen Verzeichnis gespeichert. Keine Aufteilung der betreffenden Dateien.
-
Sprachlich stukturierte Quellen
/application/ /languages/ /languages/en/ /languages/en/first.en /languages/en/second.en /languages/de/ /languages/de/first.de /languages/de/second.de /library/
Positiv: Jede Sprache wird in Ihrem eigenen Verzeichnis gespeichert. Einfache Übersetzung, da jedes Übersetzungsteam nur ein einzelnes Verzeichnis zu übersetzen hat. Und die Verwendung Verwendung von mehreren Dateien genauso transparent.
-
Applikations strukturierte Quellen
/application/ /application/languages/ /application/languages/first.en /application/languages/first.de /application/languages/second.en /application/languages/second.de /library/
Positiv: Alle Quelldateien, für jede Sprache, werden in einem einzelnen Verzeichnis gespeichert. Keine Aufteilung der betreffenden Dateien.
Negativ: Die Benutzung von mehreren Datein für die selbe Sprache kann problematisch sein.
-
Gettext strukturierte Quellen
/application/ /languages/ /languages/de/ /languages/de/LC_MESSAGES/ /languages/de/LC_MESSAGES/first.mo /languages/de/LC_MESSAGES/second.mo /languages/en/ /languages/en/LC_MESSAGES/ /languages/en/LC_MESSAGES/first.mo /languages/en/LC_MESSAGES/second.mo /library/
Positiv: Bestehende Gettext Quellen können, ohne Veränderung der Struktur, benutzt werden.
Negativ: Die Benutzung von Sub-Sub Verzeichnissen ist für Personen, die Gettext noch nie benutzt haben, verwirrend.
-
Datei strukturierte Quellen
/application/ /application/models/ /application/models/MyModel.php /application/models/MyModel.de /application/models/MyModel.en /application/controllers/ /application/controllers/MyController.php /application/controllers/MyController.de /application/controllers/MyController.en /library/
Positiv: Übersetzungsdateien sind in der Nähr Ihrer Quelle zu finden.
Negativ: Zu viele und auch kleine Übersetzungsdateien führen zu einer schwierigen und langwierigen Übersetzung. Es muß auch jede Datei als Übersetzungsquelle hinzugefügt werden.
Einzeln strukturierte und sprachlich strukturierte Quell Dateien sind für Zend_Translate am besten benutzbar.
Also jetzt, da bekannt ist welche Struktur verwendet wird, müssen die einzelnen Übersetzungs Dateien erstellt werden.
Erstellung von Array Quelldateien
Array Quelldateien sind einfache Arrays. Sie müssen aber per Hand definiert werden, da es hierfür keine Tools gibt die helfen könnten. Weil Sie so einfach zu handhaben sind, ist Ihre Verwendung auch der schnellste Weg um zu testen ob Nachrichten innerhalb des Codes wie erwartet arbeiten. Er ist generell der beste Adapter um mit Mehrsprachigkeit zu beginnen wenn man keine diesbezüglichen Kenntnisse hat.
$english = array(
'message1' => 'message1',
'message2' => 'message2',
'message3' => 'message3');
$german = array(
'message1' => 'Nachricht1',
'message2' => 'Nachricht2',
'message3' => 'Nachricht3');
$translate = new Zend_Translate('array', $english, 'en');
$translate->addTranslation($deutsch, 'de');
Seit Release 1.5 wird es auch unterstützt, Arrays die in externen Dateien vorhanden sind einzubauen. Es ist der Dateiname anzugeben und Zend_Translate wird diesen automatisch einbauen und nach dem Array schauen. Siehe das folgende Beispiel für Details:
// myarray.php
<?php
return array(
'message1' => 'Nachricht1',
'message2' => 'Nachricht2',
'message3' => 'Nachricht3');
// controller
$translate = new Zend_Translate('array', '/path/to/myarray.php', 'de');
Hinweis: Bei Dateien die kein Array zurückgeben wird das inkludieren fehlschlagen. Auch jegliche Ausgabe innerhalb dieser Dateien wird ignoriert und unterdrückt.
Erstellung von Gettext Quellen
Gettext Quellen werden durch GNU's Gettext Bibliothek erstellt. Es gibt einige kostenlose Tools welche den Code parsen können und hierbei die gewünschten Gettext Quellen erstellen. Diese haben die Endung *.mo und sind binäre Dateien. Ein Open Source Tool für die Erstellung der Quellen ist » poEdit. Dieses Tool unterstützt auch beim Übersetzungs-Prozesses selbst.
// Wir nehmen an das die mo Datien erstellt und übersetzt wurden
$translate = new Zend_Translate('gettext', '/path/to/english.mo', 'en');
$translate->addTranslation('/path/to/german.mo', 'de');
Wie man sieht wird dieser Adapter auf exakt die gleiche Art und Weise verwendet mit einer kleinen Änderung: dem Wechsel von array zu gettext. Alle anderen Punkte werden in jedem anderen Adapter auf exakt die gleiche Weise verwendet. Mit diesem Gettext Adapter muß nicht mehr auf die geforderte Standard Verzeichnis Struktur von Gettext geachtet werden. Auch nicht auf bindtextdomain und textdomain. Nur der Pfad und der Dateiname muß dem Adapter übergeben werden.
Hinweis: Man sollte immer UTF-8 als Quell Encoding verwenden. Man könnte sonst Probleme bekommen wenn man zwei verschiedene Encodings verwendet. Wenn z.B. eine Quelldatei mit ISO-8815-11 und eine andere mit CP815 encoded ist. Man kann immer nur ein Encoding für alle Quell Dateien verwenden, und hierbei würde eine der gewünschten Sprachen nicht korrekt angezeigt werden.
UTF-8 ist ein portables Format welches alle Sprachen unterstützt. Wenn UTF-8 für alle Sprachen verwendet wird, eliminiert man die Probleme mit inkompatiblen Encodings.
Viele Gettext Editoren fügen Informationen über den Adapter als Übersetzung eines
leeren Strings hinzu. Das ist der Grund warum leere Strings nicht übersetzt werden wenn
der Gettext Adapter verwendet wird. Stattdessen wird er von der Übersetzungstabelle
gelöscht und von der getAdapterInfo() Methode angeboten. Sie gibt die
Adapterinformationen für alle hinzugefügten Gettextdateien als Array zurück wobei der
Dateiname als Schlüssel verwendet wird.
// Informationen des Adapters bekommen
$translate = new Zend_Translate('gettext', '/path/to/english.mo', 'en');
print_r($translate->getAdapterInfo());
Erstellung von TMX Quellen
TMX Quellen sind der neue Industrie Standard. Sie haben den Vorteil das sie XML Dateien sind und deswegen mit jedem Texteditor lesbar und natürlich auch von Menschen. Man kann TMX Dateien entweder per Hand erstellen oder man verwendet spezielle Tools dafür. Allerdings sind die meisten erhältlichen Tools die Erstellung von TMX Quellen nicht frei erhältlich.
Beispiel #3 Beispiel einer TMX Datei
<?xml version="1.0" ?>
<!DOCTYPE tmx SYSTEM "tmx14.dtd">
<tmx version="1.4">
<header creationtoolversion="1.0.0" datatype="winres" segtype="sentence"
adminlang="en-us" srclang="de-at" o-tmf="abc"
creationtool="XYZTool" >
</header>
<body>
<tu tuid='message1'>
<tuv xml:lang="de"><seg>Nachricht1</seg></tuv>
<tuv xml:lang="en"><seg>message1</seg></tuv>
</tu>
<tu tuid='message2'>
<tuv xml:lang="en"><seg>message2</seg></tuv>
<tuv xml:lang="de"><seg>Nachricht2</seg></tuv>
</tu>
$translate = new Zend_Translate('tmx', 'path/to/mytranslation.tmx', 'en');
TMX Dateien können mehrere Sprachen in der selben Datei enthalten. Alle anderen in der
Quelle enthaltenen Sprachen werden automatisch hinzugefügt und müssen nicht durch einen
extra Aufruf von addLanguage() ergänzt werden.
Wenn man nur spezielle Sprache aus der Quelle übersetzen will, kann die Option
'defined_language' auf true gesetzt werden. Mit dieser
Option können gewünschte Sprachen explizit mit addLanguage()
hinzugefügt werden. Der Standardwert für diese Option fügt alle Sprachen hinzu.
Erstellung von CSV Quellen
CSV Quellen sind sehr klein und von Menschen lesbar. Wenn ein Kunde selbst übersetzen will, ist die Verwendung des CSV Adapters warscheinlich die beste Wahl.
Beispiel #4 Beispiel CSV Datei
#Example csv file message1;Nachricht1 message2;Nachricht2
$translate = new Zend_Translate('csv', '/path/to/mytranslation.csv', 'de');
$translate->addTranslation('/path/to/other.csv', 'fr');
Es gibt drei verschiedene Optionen für den CSV Adapter. Es können
'delimiter', 'limit' und 'enclosure' gesetzt
werden.
Das Standard Trennzeichen für CSV Strings ist ';, aber es muß nicht dieses
Zeichen sein. Mit der Option 'delimiter' kann ein anderes verwendet
werden.
Das Standardlimit für eine Zeile in einer CSV Datei ist '0'. Das bedeutet
dass das Ende der CSV Zeile automatisch gesucht wird. Wenn 'limit' auf
irgendeinen Wert gesetzt wird, dann wird die CSV Datei schneller gelesen, aber jede
Zeile die dieses Limit überschreitet wird abgeschnitten.
Das standardmäßige Anführungszeichen für die Verwendung mit CSV Dateien ist
'"'. Man kann ein anderes Setzen indem die Option 'enclosure'
verwendet wird.
Beispiel #5 Zweites Beispiel für CSV Dateien
# Example CSV file "message,1",Nachricht1 message2,"Nachricht,2" "message3,",Nachricht3
$translate = new Zend_Translate(
'csv',
'/path/to/mytranslation.csv',
'de',
array('delimiter' => ','));
$translate->addTranslation('/path/to/other.csv', 'fr');
Erstellung von INI Quelldateien
INI Quelldateien sind menschlich lesbar aber normalerweise nicht sehr klein da Sie neben der Übersetzung auch andere Daten enthalten. Wenn Sie Daten haben die von Ihrem Kunden zu bearbeitet sind, verwenden Sie den INI Adapter.
Beispiel #6 Beispiel einer INI Datei
[Test] ;TestPage Comment Message_1="Nachricht 1 (de)" Message_2="Nachricht 2 (de)" Message_3="Nachricht :3 (de)"
$translate = new Zend_Translate('ini', '/path/to/mytranslation.ini', 'de');
$translate->addTranslation('/path/to/other.ini', 'it');
INI Dateien haben diverse Einschränkungen. Wenn ein Wert in einer INI Datei irgendein
nicht alphanummerisches Zeichen enthält, muß er in doppelte Anführungszeichen
(") eingeklammert werden. Es gibt auch reservierte Wörter welche nicht als
Schlüssel für INI Dateien verwendet werden dürfen. Diese enthalten: null,
yes, no, true und false. Die Werte
null, no und false führen zu "",
yes und true resultieren in 1. Die Zeichen
{}|&~