Verwendung der Übersetzungsadapter

Der nächste Schritt ist die Benutzung des Adapters im eigenen Code.

Example #1 Beispiel eines einsprachigen PHP Codes

  1. print "Beispiel\n";
  2. print "========\n";
  3. print "Hier steht Zeile eins\n";
  4. print "Heute ist der " . date("d.m.Y") . "\n";
  5. print "\n";
  6. 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 es viel einfacher, wenn bei der Erstellung des Codes bereits an die Übersetzung gedacht wurde, anstatt ihn im Nachhinein dafür zu ändern.

Example #2 Beispiel für mehrsprachigen PHP Code

  1. $translate = new Zend_Translate(
  2.     array(
  3.         'adapter' => 'gettext',
  4.         'content' => '/path/to/translation/source-de.mo',
  5.         'locale'  => 'de'
  6.     )
  7. );
  8. $translate->addTranslation(
  9.     array(
  10.         'content' => '//my/path/fr-source.mo',
  11.         'locale   => 'fr'
  12.     )
  13. );
  14.  
  15. print $translate->_("Beispiel") . "\n";
  16. print "========\n";
  17. print $translate->_("Hier steht Zeile eins") . "\n";
  18. printf($translate->_("Heute ist der %1\$s") . "\n", date('d.m.Y'));
  19. print "\n";
  20.  
  21. $translate->setLocale('fr');
  22. 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 Basisadapter:

  1. $translate = new Zend_Translate(
  2.     array(
  3.         'adapter' => 'gettext',
  4.         'content' => '/path/to/translation/source-de.mo',
  5.         'locale'  => 'de'
  6.     )
  7. );

In diesem Beispiel haben wir den Gettext-Adapter ausgewählt. Die Übersetzungsdatei source-de.mo wird im Verzeichnis /path/to/translation platziert. Diese Gettext-Datei beinhaltet eine deutsche Übersetzung und es steht auch eine zweite Sprachquelle für Französisch zur Verfügung.

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:

  1. print $translate->_("Beispiel") . "\n";
  2. print "========\n";
  3. print $translate->_("Hier ist die Zeile Eins") . "\n";

Einige Strings müssen nicht übersetzt werden. Die Trennlinie wird immer eine Trennlinie sein, auch in den anderen Sprachen.

Die Verwendung von variablen Werten in einer Übersetzung wird durch die Verwendung von eingebetteten Parametern auch unterstützt.

  1. printf($translate->_("Today is the %1\$s") . "\n", date("d.m.Y"));

Statt 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 durch seine Message ID identifiziert. Man könnte diese Message IDs statt des Strings im Code wie folgt verwenden:

  1. print $translate->_(1) . "\n";
  2. print "=======\n";
  3. print $translate->_(2) . "\n";

Allerdings hat dies mehrere Nachteile:

Es ist nicht erkennbar, was der Code ausgeben sollte, wenn 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 keine Ü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, dass 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, wie hier beschrieben, auf seine eigene Weise erstellt, aber es gibt ein paar allgemeine Features, die für alle Adapter relevant sind.

Zuerst muß entschieden werden, wo die Übersetzungsdateien zu speichern sind. Bei der Verwendung von Zend_Translate gibt es keinerlei Einschränkungen. Die folgenden Strukturen sind vorzuziehen:

  • Einzeln strukturierte Quellen

    1. /application/
    2. /languages/
    3. /languages/lang.en
    4. /languages/lang.de
    5. /library/

    Positiv: Alle Quelldateien, für jede Sprache, werden in einem einzelnen Verzeichnis gespeichert. Keine Aufteilung der betreffenden Dateien.

  • Sprachlich stukturierte Quellen

    1. /application/
    2. /languages/
    3. /languages/en/
    4. /languages/en/first.en
    5. /languages/en/second.en
    6. /languages/de/
    7. /languages/de/first.de
    8. /languages/de/second.de
    9. /library/

    Positiv: Jede Sprache wird in ihrem eigenen Verzeichnis gespeichert. Einfache Übersetzung, da jedes Übersetzungsteam nur ein einzelnes Verzeichnis zu übersetzen hat. Auch die Verwendung von mehreren Dateien ist transparent.

  • Anwendungsstrukturierte Quellen

    1. /application/
    2. /application/languages/
    3. /application/languages/first.en
    4. /application/languages/first.de
    5. /application/languages/second.en
    6. /application/languages/second.de
    7. /library/

    Positiv: Alle Quelldateien, für jede Sprache, werden in einem einzelnen Verzeichnis gespeichert. Keine Aufteilung der betreffenden Dateien.

    Negativ: Die Benutzung von mehreren Dateien für dieselbe Sprache kann problematisch sein.

  • Gettext strukturierte Quellen

    1. /application/
    2. /languages/
    3. /languages/de/
    4. /languages/de/LC_MESSAGES/
    5. /languages/de/LC_MESSAGES/first.mo
    6. /languages/de/LC_MESSAGES/second.mo
    7. /languages/en/
    8. /languages/en/LC_MESSAGES/
    9. /languages/en/LC_MESSAGES/first.mo
    10. /languages/en/LC_MESSAGES/second.mo
    11. /library/

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

    Negativ: Die Benutzung von Unterunterverzeichnissen ist für Personen verwirrend, die Gettext noch nie benutzt haben.

  • Datei strukturierte Quellen

    1. /application/
    2. /application/models/
    3. /application/models/MyModel.php
    4. /application/models/MyModel.de
    5. /application/models/MyModel.en
    6. /application/controllers/
    7. /application/controllers/MyController.php
    8. /application/controllers/MyController.de
    9. /application/controllers/MyController.en
    10. /library/

    Positiv: Übersetzungsdateien sind in der Nähe 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 Quelldateien sind für Zend_Translate am besten benutzbar.

Da jetzt bekannt ist, welche Struktur verwendet wird, sollten nun die einzelnen Übersetzungsdateien erstellt werden.

blog comments powered by Disqus