Der nächste Schritt besteht in der Erstellung der Übersetzungsdateien für die verschiedenen Sprachen welche zu übersetzen sind. Für jeden Adapter gibt es eine andere Art und Weise die hier beschrieben ist. Aber es gibt ein paar generelle Features die für alle Adaptoren relevant sind.

Zuerst muß überlegt werden wo die Übersetzung Dateien gespeichert werden. Mit Zend_Translate bestehen hierbei keinerlei Einschränkungen. Trotzdem sollten die folgenden Strukturen bevorzugt verwendet werden:

• Einzeln strukturierte Quellen

  /application
  /languages
    lang.en
    lang.de
  /library
  
                  

  Positiv: Alle Quell Dateien jeder Sprache sind in einem Verzeichnis zu finden. Keine Aufteilung der relevanten Dateien.

• Sprachlich stukturierte Quellen

  /application
  /languages
    /en
      lang.en
      other.en
    /de
      lang.de
      other.de
  /library
  
                  

  Positiv: Jede Sprache ist in einem einzelnen Verzeichnis zu finden. Jede Sprache hat sein eigenes Verzeichnis und kann durch ein eigenes Übersetzungsteam bearbeitet werden. Ausserdem ist die Verwendung von mehreren Dateien genauso transparent.

• Applikations strukturierte Quellen

  /application
    /languages
      lang.en
      lang.de
      other.en
      other.de
  
                  

  Positiv: Alle Quell Dateien für jede Sprache können in einem einzelnen Verzeichnis gefunden werden. Keine Aufteilung der relevanten Dateien.

  Negativ: Die Benutzung von mehreren Datein für die selbe Sprache ist problematisch.

• Gettext strukturierte Quellen

  /languages
    /de
      /LC_MESSAGES
        lang.mo
        other.mo
    /en
      /LC_MESSAGES
        lang.mo
        other.mo
  
                  

  Positiv: Alte Gettext Quellen können ohne Veränderung der Struktur benutzt werden.

  Negativ: Die Benutzung von Sub-Sub Verzeichnissen ist verwirrend für Personen die Gettext noch nie benutzt haben.

• Datei strukturierte Quellen

  /application
    /models
      mymodel.php
      mymodel.de
      mymodel.en
    /views
    /controllers
      mycontroller.de
  /document_root
    /images
    /styles
    .htaccess
    index.php
    index.de
  /library
    /Zend
  
                  

  Positiv: Jede Datei ist bei Ihrer Übersetzung zu finden source.

  Negativ: Mehrfache kleine Übersetzungs Quellen machen die Übersetzung sehr schwer. Ausserdem muß jede Datei als Übersetzung Quelle 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.

Array Quellen sind einfache Array. Aber sie müssen per Hand definiert werden da es hierfür keine Tools gibt. 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. Es 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, das Array die in externen Dateien vorhanden sind zu inkludieren. Es muß nur der Dateiname angegeben werden und Zend_Translate wird diesen automatisch inkludieren und nach dem Array schauen. Das folgende Beispiel zeigt 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.

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 Dateien haben die Endung *.mo und sind binäre Dateien. Ein kostenloses Programm für die Erstellung der Quellen ist » poEdit. Dieses Tool unterstützt auch beim Übersetzungs Prozess 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. Den Tausch 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 zum Beispiel eine Quell Datei 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 man also UTF-8 für alle Sprachen verwendet, 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 ein leerer String 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.

// Wie man Informationen des Adapters erhält
$translate = new Zend_Translate('gettext', 'path/to/english.mo', 'en');
print_r $translate->getAdapterInfo();

        

TMX Quellen sind der neue Industrie Standard. Sie haben den Vorteil das sie XML Dateien sind und deswegen mit jedem Texteditor und natürlich auch von Menschen direkt lesbar. Man kann TMX Dateien entweder per Hand erstellen oder man verwendet Tools dafür. Allerdings sind die meisten erhältlichen Tools die TMX Quellen erstellen können nicht kostenlos.

<?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 kann mehrere Sprachen in einer einzigen TMX Datei enthalten.

            

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.

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.

#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 das '; Zeichen. Aber es muß nicht dieses Zeichen sein. Mit der Option 'delimiter' kann ein anderes Trennzeichen ausgesucht werden.

Das Standardlimit für eine Zeile in einer CSV Datei ist '0'. Das bedeutet das das Ende der CSV Zeile automatisch gesucht wird. Wenn die 'limit' auf irgendeinen Wert gesetzt wird, dann wird die CSV Datei schneller gelesen, aber jede Zeile die dieses Limit überschreitet wird abgeschnitten.

The default enclosure to use for CSV files is '"'. You can set a different one with the option 'enclosure'.

# Example csv file
# original 'message,1'
"message,1",Nachricht1
# translation 'Nachricht,2'
message2,"Nachricht,2"
# original 'message3,'
"message3,",Nachricht3

            

$translate = new Zend_Translate('csv',
                                'path/to/mytranslation.csv',
                                'de',
                                array('delimiter' => ','));
$translate->addTranslation('path/to/other.csv', 'fr');

            

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 bearbeitet werden sollten können Sie auch den INI Adapter für diesen Zweck verwenden.

[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, no, true und false. Die Werte null, no und false führen zu "", yes und true resultieren in "1". Die Zeichen {}|&~![()" dürfen nirgendwo im Schlüssel verwendet werden und haben im Wert eine spezielle Bedeutung. Sie sollten nicht verwendet werden da sie sonst zu unerwartetem Verhlaten führen können.

Optionen können bei allen Adaptoren verwendet werden. Natürlich sind die Optionen für alle Adaptoren verschieden. Die Optionen können bei Erstellung des Objekts miterstellt werden. Zur Zeit gibt es nur eine Option die für alle Adaptoren verfügbar ist. 'clear' entscheidet ob die neuen Übersetzungsdaten zu den bestehenden hinzugefügt werden sollen oder ob Sie diese überschreiben. Das Standardverhalten ist das Hinzufügen von neuen Übersetzungsdaten zu bestehenden. Aber das wird immer nur für die aktuelle Sprache gemacht. Alle anderen Sprachen werden nicht verändert.

Man kann Optionen temporär setzen indem man die Funktion addTranslation($data, $locale, array $options = array()) als dritten und optionalen Parameter benutzt. Ausserdem kann die Funktion setOptions() benutzt werden um Optionen fix zu setzen.

// Definiere ':' als Trenner für die Quelldatei der Übersetzung
$options = array('separator' => ':');
$translate = new Zend_Translate('csv',
                                'path/to/mytranslation.csv',
                                'de',
                                $options);

...

// Lösche die definierte Sprache und verwende die neuen Übersetzungsdaten
$options = array('clear' => true);
$translate->addTranslation('path/to/new.csv', 'fr', $options);

            

Hier können alle vorhandenen Optionen für die verschiedenen Adapter gefunden werden mit einer Beschreibung Ihrer Verwendung:

Wenn man selbstdefinierte Optionen haben will, können diese auch in allen Adaptern verwendet werden. Die setOptions() Methode kann verwendet werden um die eigene Option zu definieren. setOptions() benötigt ein Array mit den Optionen die gesetzt werden sollen. Wenn eine angegebene Option bereits existiert wird diese überschrieben. Es können beliebig viele Optionen definiert werden da diese nicht vom Adapter geprüft werden. Es muß nur sichergestellt werden das keine bereits existierende Option überschrieben wird welche ein Adapter verwendet.

Um die gesetzte Option zurückzugeben kann die Methode getOptions() verwendet werden. Wenn getOptions() ohne einen Parameter aufgerufen wird, gibt Sie alle Optionen zurück. Wenn der optionale Parameter angegeben wird, wird nur diese spezielle Option zurückgegeben.

Wenn mit verschiedenen Sprachen gearbeitet wird gibt es ein paar Methoden die nützlich sind.

Die getLocale() Methode kann verwendet werden um die aktuell gesetzte Sprache zu erhalten. Sie kann entweder eine Instanz von Zend_Locale oder den Bezeichner des Gebietsschemas enthalten.

Die setLocale() Methode setzt eine neue Standardsprache für Übersetzungen. Das verhindert das der optionale Sprachparameter der translate() Methode mehr als einmal gesetzt werden muß. Wenn die angegebene Sprache nicht existiert, oder keine Übersetzten Daten für diese Sprache vorhanden sind, versucht setLocale() auf die Sprache ohne Region downzugraden wenn diese angegeben wurde. Die Sprache en_US würde zum Beispiel zu en downgegradet werden. Wenn auch nach dem Downgraden die Sprache nicht gefunden werden konnte, wird eine Ausnahme geworfen.

Die isAvailable() Methode prüft ob eine angegebene Sprache bereits vorhanden ist. Es wird true zurückgegeben wenn Daten für die angegebene Sprache existieren.

Und letztendlich kann die getList() Methode verwendet werden um alle aktuell gesetzten Sprachen für einen Adapter als Array zurückgegeben zu bekommen.

...
// gibt die aktuell gesetzte Sprache zurück
$actual = $translate->getLocale();

...
// der optionale Parameter kann wärend der Übersetzung verwendet werden
echo $translate->_("mein_Text", "fr");
// oder es wird eine neue Standardsprache gesetzt
$translate->setLocale("fr");
echo $translate->_("mein_Text");
// zur Basissprache referieren... fr_CH wird zu fr downgegradet und
// verwendet
$translate->setLocale("fr_CH");
echo $translate->_("mein_Text");

...
// Prüft ob die Sprache existiert
if ($translate->isAvailable("fr")) {
    // Sprache existiert
}

            

// Angenommen der Browser gibt folgende Spracheneinstellungen zurück
// HTTP_ACCEPT_LANGUAGE = "de_AT=1;fr=1;en_US=0.8";

// Beispiel 1:
$translate = new Zend_Translate('gettext',
                                '\my_it.mo',
                                'auto',
                                array('scan' => Zend_Translate::LOCALE_FILENAME));
// keine passende Sprache gefunden, die MessageID wird zurückgegeben

// Beispiel 2:
$translate = new Zend_Translate('gettext',
                                '\my_fr.mo',
                                'auto',
                                array('scan' => Zend_Translate::LOCALE_FILENAME);
// Die am besten passende Sprache ist 'fr'

// Beispiel 3:
$translate = new Zend_Translate('gettext',
                                '\my_de.mo',
                                'auto',
                                array('scan' => Zend_Translate::LOCALE_FILENAME);
// Die am besten passende Sprache ist 'de' weil 'de_AT' zu 'de'
// degradiert wird

// Beispiel 4:
$translate = new Zend_Translate('gettext',
                                '\my_it.mo',
                                'auto',
                                array('scan' => Zend_Translate::LOCALE_FILENAME);
$translate->addTranslation('\my_ru.mo', 'ru');
$translate->setLocale('it_IT');
// gibt 'it' als Übersetzungsquelle zurück und überschreibt die automatischen Eigenschaften

                

// In der Bootstrap Datei
$locale = new Zend_Locale();
Zend_Registry::set('Zend_Locale', $locale);

// Standardsprache wenn die angefragte Sprache nicht vorhanden ist
$defaultlanguage = 'en';

// Irgendwo in der Anwendung
$translate = new Zend_Translate('gettext', '\my_de.mo');
if (!$translate->isAvailable($locale->getLanguage())) {
    // Wenn der Benutzer eine nicht vorhandene Sprache anfragt auf den Standard umrouten
    $translate->setLocale($defaultlanguage);
}

$translate->getLocale();

            

Zend_Translate kann Übersetzungsquellen automatisch erkennen. Es muß also nicht jede Quelldatei manuell deklariert werden. Man kann diesen Job Zend_Translate überlassen welches die komplette Verzeichnisstruktur nach Quelldateien durchsucht.

Hinweis: Automatische Erkennung der Quellen ist seit Zend Framework Version 1.5 vorhanden.

Die Verwendung ist fast die selbe wie bei der Initiierung einer einzelnen Übersetzungsquelle mit einem Unterschied. Es darf nur ein Verzeichnis angegeben werden, statt einer Datei, welches gescannt werden soll.

// Angenommen wir haben die folgende Struktur
//  /language
//  /language/login/login.tmx
//  /language/logout/logout.tmx
//  /language/error/loginerror.tmx
//  /language/error/logouterror.tmx

$translate = new Zend_Translate('tmx', '/language');

            

Zend_Translate muß also nicht nur das angegebene Verzeichnis durchsuchen, sondern auch alle Unterverzeichnisse nach Dateien für Übersetzungen. Das macht die Verwendung sehr einfach. Aber Zend_Translate wird alle Dateien ignorieren, welche keine Quellen sind, oder wärend des Einlesens der Übersetzungsdaten Fehler produzieren. Man sollte also sicherstellen das alle Übersetzungsquellen korrekt sind und gelesen werden können weil man keinen Fehler erhält wenn eine Datei fehlerhaft ist oder nicht gelesen werden kann.

Hinweis: Abhängig davon wie tief die Verzeichnisstruktur ist und wieviele Dateien innerhalb dieser Struktur vorhanden sind, kann es eine sehr lange Zeit dauern bis Zend_Translate fertig ist.

In unserem Beispiel haben wir das TMX Format verwendet welches die Sprache enthält die innerhalb der Quelle verwendet wird. Aber viele der anderen Quellformate sind nicht dazu fähig die Sprache in der Datei selbst zu inkludieren. Aber auch diese quellen können mit der automatischen Erkennung verwendet werden wenn ein paar Dinge berücksichtigt werden die anbei beschrieben sind:

// Angenommen wir haben die folgende Struktur
//  /language
//  /language/de/login/login.mo
//  /language/de/error/loginerror.mo
//  /language/en/login/login.mo
//  /language/en/error/loginerror.mo

$translate = new Zend_Translate('gettext',
                                '/language',
                                null,
                                array('scan' =>
                                      Zend_Translate::LOCALE_DIRECTORY));

                

// Angenommen wir haben die folgende Struktur
//  /language
//  /language/login/login_en.mo
//  /language/login/login_de.mo
//  /language/error/loginerror_en.mo
//  /language/error/loginerror_de.mo

$translate = new Zend_Translate('gettext',
                                '/language',
                                null,
                                array('scan' =>
                                      Zend_Translate::LOCALE_FILENAME));

                

/languages
  en.mo
  de.mo
  es.mo

                

/languages
  view.en
  view.de
  view.es

                

/languages
  view_en.mo  -> erkennt englisch
  view_de.mo  -> erkennt deutsch
  view_it.mo  -> erkennt italienisch

                

/languages
  view_en_de.mo  -> erkennt englisch
  view_en_es.mo  -> erkennt englisch und überschreibt die erste Datei
  view_it_it.mo  -> erkennt italienisch

                

/languages
  view_en-it.mo  -> erkennt englisch weil '_' vor '-' verwendet wird
  view-en_it.mo  -> erkennt italienisch weil '_' vor '-' verwendet wird
  view_en.it.mo  -> erkennt italienisch weil '.' vor '_' verwendet wird

                

Normalerweise wird Text ohne irgendwelche Berechnungen übersetzt. Aber manchmal ist es notwendig zu wissen ob ein Text in der Quelle übersetzt ist oder nicht. Hierzu kann die Methode isTranslated() verwendet werden.

isTranslated($messageId, $original = false, $locale = null) nimmt als ersten Parameter den Text bzw die Id von der man wissen will ob sie Übersetzbar ist. Der optionale zweite Parameter definiert ob die Übersetzung fix für die definierte Sprache ist oder ob ein kleineres Set von Übersetzungen verwendet werden kann. Wenn ein Text, welcher mit 'en' übersetzt werden kann, aber nicht mit 'en_US', wird die Übersetzung normalerweise zurückgegeben, aber wenn $original auf true gesetzt ist, gibt die isTranslated() Methode in solche Fällen false zurück.

$english = array('message1' => 'Nachricht 1',
                 'message2' => 'Nachricht 2',
                 'message3' => 'Nachricht 3');
$translate = new Zend_Translate('array', $english, 'de_AT');

if ($translate->isTranslated('message1')) {
    print "'message1' kann übersetzt werden";
}
if (!($translate->isTranslated('message1', true, 'de'))) {
    print "'message1' kann nicht in 'de' übersetzt werden da es " .
    "nur in 'de_AT' vorhanden ist";
}
if ($translate->isTranslated('message1', false, 'de')) {
    print "'message1' kann in 'de_AT' übersetzt werden da es zu 'de' zurückfällt";
}

            

Natürlich ist es manchmal nützlich Zugang zu den übersetzten Quelldaten zu erhalten. Hierfür existieren zwei Methoden.

Die getMessageIds($locale = null) Methode gibt alle bekannten Ids für Übersetzungen als Array zurück.

Und die getMessages($locale = null) Methode gibt die komplette Übersetzungs-Quelle als Array zurück. Die Ids der Übersetzungen werden als Schlüssel und die Übersetzten Daten als Wert verwendet.

Beide Methoden akzeptieren einen optionalen Parameter $locale welcher, wenn er gesetzt wird, die Übersetzungsdaten für die spezifizierte Sprache, zurückgibt. Wenn dieser Parameter nicht angegeben wird, wird die aktuell gesetzte Sprache verwendet. Es ist zu beachten das normalerweise alle Übersetzungen in allen Sprachen vorhanden sein sollten. Das bedeutet das man in einer normalen Situation diesen Parameter nicht angeben muß.

Zusätzlich kann die getMessages() Methode das komplette Übersetzungsverzeichnis, mit dem Pseudo-Gebietsschema 'all', zurückgeben. Das gibt alle vorhandenen Übersetzungsdaten für jedes hinzugefügte Gebietsschema zurück.

Hinweis: Achtung: Das zurückgegebene Array kann sehr groß sein, abhängig von der Anzahl an hinzugefügten Gebietsschemata und der Anzahl an Übersetzungsdaten.

...
// gibt alle bekannten Übersetzungs Ids zurück
$messageids = $translate->getMessageIds();
print_r($messageids);

...
// oder nur die spezifizierte Sprache
$messageids = $translate->getMessageIds('en_US');
print_r($messageids);

...
// gibt die kompletten Übersetzungs Daten zurück
$source = $translate->getMessages();
print_r($source);