Zusätzliche Features für ÜbersetzungenEs gibt verschiedene zusätzliche Features, welche von Zend_Translate unterstützt werden. Lesen Sie weiter für zusätzliche Informationen. Optionen für AdapterOptionen können bei allen Adaptern verwendet werden. Natürlich sind die Optionen für alle Adapter verschieden. Die Optionen können bei der Erstellung des Objekts gesetzt werden. Zur Zeit gibt es nur eine Option, die für alle Adaptoren verfügbar ist: 'clear' setzt, 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 den Bestehenden. Aber das wird immer nur für die aktuelle Sprache gemacht. Andere Sprachen bleiben davon unberührt. Man kann Optionen temporär setzen, indem man sie an die Funktion addTranslation() übergibt. Außerdem kann die Methode setOptions() benutzt werden, um Optionen permanent zu setzen. Example #1 Benutzen von Übersetzungsoptionen
Hier können alle vorhandenen Optionen für die verschiedenen Adapter mit einer Beschreibung ihrer Verwendung gefunden werden:
Wenn man selbstdefinierte Optionen haben will, können diese auch in allen Adaptern verwendet werden. Die Methode setOptions() 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. Man muss nur sicherstellen, dass keine existierende Option überschrieben wird, die von einem Adapter verwendet wird. Um die 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 ist, wird nur die dadurch bestimmte Option zurückgegeben. Mit Sprachen arbeitenWenn mit verschiedenen Sprachen gearbeitet wird, gibt es ein paar Methoden die nützlich sind. Die Methode getLocale() 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 Methode setLocale() setzt eine neue Standardsprache für Übersetzungen. Das verhindert, dass der optionale Sprachparameter der Methode translate() mehr als einmal gesetzt werden muss. 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 sogar nach dem Downgraden die Sprache nicht gefunden werden konnte, wird eine Ausnahme geworfen. Die Methode isAvailable() 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 Methode getList() verwendet werden, um alle aktuell gesetzten Sprachen für einen Adapter als Array zu erhalten. Example #2 Handhabung von Sprachen mit Adaptern
Automatische Handhabung von SprachenEs gilt zu beachten, dass solange man neue Sprachquellen mit der addTranslation() Methode hinzufügt, Zend_Translate automatisch die am besten passende Sprache für die eigene Umgebung auswählt, wenn man eine der automatischen Gebietsschemata verwendet, die 'auto' oder 'browser' sein können. Man muss normalerweise also setLocale() nicht aufrufen. Das sollte nur in Verbindung mit der automatischen Erkennung von Quellen verwendet werden. Der Algorithmus sucht nach dem am besten passenden Gebietsschema abhängig vom Browser des Benutzers und der eigenen Umgebung. Siehe das folgende Beispiel für Details: Example #3 Automatische Erkennen der Sprache
Nachdem eine Sprache von Hand mit der Methode setLocale() gesetzt wurde, wird die automatische Erkennung ausgeschaltet und übergangen. Wenn man sie wieder verwenden will, kann die Sprache auto mit setLocale() gesetzt werden, was die automatische Erkennung für Zend_Translate wieder reaktiviert. Seit dem Zend Framework 1.7.0 unterstützt Zend_Translate 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.
Ein Land als Sprache verwendenMan kann auch ein Land als "locale"-Parameter verwenden. Dass kann nützlich sein, wenn man seinem Benutzer Fahnen anbieten will, welche das Land repräsentieren in dem er lebt. Wenn er seine Fahne auswählt, würde er automatisch die Standardsprache für dieses Land erhalten. Wenn der Benutzer zum Beispiel US auswählt, dann würde er en_US als Gebietsschema erhalten, welches dann verwendet wird. Das führt automatisch zur Sprache en, welche die Standardsprache für das Land US ist.
Automatische Erkennung von QuellenZend_Translate kann Übersetzungsquellen automatisch erkennen. Es muss also nicht jede Quelldatei manuell deklariert werden. Man kann diesen Job Zend_Translate überlassen, welches die komplette Verzeichnisstruktur nach Quelldateien durchsucht.
Die Verwendung ist fast die gleiche wie beim Initiieren einer einzelnen Übersetzungsquelle mit einem Unterschied. Es darf statt einer Datei nur ein Verzeichnis angegeben werden, welches gescannt werden soll. Example #4 Scannen nach Quellen in einer Verzeichnisstruktur
Zend_Translate muss also nicht nur das angegebene Verzeichnis nach Dateien für Übersetzungen durchsuchen, sondern auch alle Unterverzeichnisse. Das macht die Verwendung sehr einfach. Aber Zend_Translate wird alle Dateien ignorieren, welche keine Quellen sind oder während des Einlesens der Übersetzungsdaten Fehler produzieren. Man sollte also sicherstellen, dass 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.
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, welche nachfolgend beschrieben werden: Sprachen durch die Benennung von VerzeichnissenEin Weg, die automatische Spracherkennung zu inkludieren, ist es die Verzeichnisse relativ zur Sprache zu benennen, welche in den Quellen des betreffenden Verzeichnisses verwendet wird. Das ist der einfachste Weg und wird zum Beispiel in Standard-Gettext-Implementationen verwendet. Zend_Translate benötigt die 'scan' Option um zu wissen, dass es die Namen aller Verzeichnisse nach Sprachen durchsuchen soll. Siehe das folgende Beispiel für Details: Example #5 Verzeichnisse nach Sprachen durchsuchen
Sprache durch DateinamenEin anderer Weg um die Sprache automatisch zu erkennen ist die Verwendung von speziellen Dateinamen. Man kann entweder die komplette Datei oder Teile der Datei nach der verwendeten Sprache benennen. Um diese Option zu Verwenden muss die 'scan' Option beim Initiieren gesetzt werden. Es gibt verschiedene Wege die Quelldateien zu benennen, welche im folgenden beschrieben werden: Example #6 Suchen nach Sprachen im Dateinamen
Komplette DateinamenDie komplette Datei nach der Sprache zu benennen, ist der einfachste Weg, aber nur praktikabel, wenn man nur eine Datei pro Verzeichnis verwendet.
DateierweiterungEin anderer einfacher Weg ist die Verwendung der Dateierweiterung für die Spracherkennung. Aber das kann verwirrend sein, weil man keine Idee mehr hat welche Erweiterung die Datei ursprünglich hatte.
Teile von DateinamenZend_Translate kann die Sprache auch erkennen, wenn sie im Dateinamen enthalten ist. Aber wenn man diesen Weg wählt, muss die Sprache mit einem Trennzeichen separiert werden. Es gibt drei unterstützte Trennzeichen, welche verwendet werden können. Ein Punkt '.', ein Unterstrich '_', oder ein Bindestrich '-'.
Das erste gefundene String, der von einem Trennzeichen getrennt wird, das als Gebietsschema interpretiert werden kann, wird verwendet. Siehe das folgende Beispiel für Details.
Alle drei Trennzeichen werden verwendet, um das Gebietsschema zu erkennen. Wenn der Dateiname mehrere Trennzeichen enthält, hängt das erste gefundene Trennzeichen von der Reihenfolge der Trennzeichen ab, die verwendet werden. Siehe das folgende Beispiel für Details.
Spezielle Dateien und Verzeichnisse ignorierenManchmal ist es nützlich, Dateien oder sogar Verzeichnisse davon auszunehmen, dass diese automatisch hinzugefügt werden. Hierfür kann man die Option ignore verwenden, welche drei mögliche Verwendungen anbietet. Ein spezielles Verzeichnis oder eine Datei ignorierenStandardmäßig ist Zend_Translate so gesetzt, dass alle Dateien und Verzeichnisse, welche mit '/.' beginnen ignoriert werden. Dies bedeutet, dass SVN-Dateien ignoriert werden. Man kann eine eigene Syntax setzen, indem ein String für die Option ignore angegeben wird. Der Verzeichnistrenner wird automatisch angehängt, wenn er nicht angegeben wurde.
Das obige Beispiel ignoriert alle Dateien und Verzeichnisse, welche mit test beginnen. Das bedeutet zum Beispiel /test/en.mo, /testing/en.mo und /dir/test_en.mo. Aber es würde trotzdem /mytest/en.mo oder /dir/atest.mo hinzufügen.
Verschiedene Verzeichnisse oder Dateien ignorierenMan kann auch verschiedene Dateien und Verzeichnisse ignorieren. Statt eines Strings muss man einfach ein Array mit den gewünschten Namen angeben, welche ignoriert werden sollen.
Im obigen Fall werden alle Dateien oder Verzeichnisse ignoriert, die auf eines der drei Muster passen. Aber sie müssen mit dem Muster beginnen, um erkannt und ignoriert zu werden. Spezifische Namen ignorierenUm Dateien und Verzeichnisse zu ignorieren, welche nicht mit einem definierten Muster beginnen, aber ein spezielles Muster irgendwo in ihrem Namen haben, kann man einen regulären Ausdruck verwenden. Um einen regulären Ausdruck zu verwenden, muss der Array-Schlüssel der Option ignore mit regex beginnen.
Im obigen Fall haben wir zwei reguläre Ausdrücke definiert. Die Dateien und Verzeichnisse werden immer mit allen angegebenen regulären Ausdrücken gesucht. In unserem Fall bedeutet dies, dass jede Datei welche irgendwo in ihrem Namen test enthält ignoriert wird. Zusätzlich werden alle Dateien und Verzeichnisse, welche mit deleted enden, nicht als Übersetzung hinzugefügt. Weiterleiten von ÜbersetzungenNicht jede Nachrichten ID kann übersetzt werden. Aber manchmal ist es sinnvoll die Ausgabe der Übersetzung von einer anderen Sprache durchzuführen statt die Nachrichten ID selbst zurückzugeben. Man kann dies durchführen indem man die Option route verwendet. Man kann eine Route für jede Sprache hinzufügen. Siehe das folgende Beispiel: Das oben stehende give eine englische Übersetzung für alle Nachrichten zurück welche nicht in französisch übersetzt werden können. Und es gibt eine französische Übersetzung für alle Nachrichten zurück welche nicht in deutsch übersetzt werden können. Es gibt sogar eine englische Übersetzung für alle Nachrichten zurück welche weder in deutsch noch in französisch übersetzt werden können. So kann man sogar eine komplette Übersetzung-Kette definieren. Dieses Feature kann für jedermann interessant sein. Aber man sollte darauf achten dass es problematisch sein kann Übersetzungen einer falsche oder anderen Sprache zurück zu geben wenn der Benutzer diese Sprache nicht versteht. Man sollte dieses Feature also sehr sparsam einsetzen. Mehrere Übersetzungsquellen kombinierenWenn man mit mehreren Übersetzungen arbeitet, kann es zu Situationen kommen, in denen man unterschiedliche Quell-Typen verwenden will. Zum Beispiel die Ressource-Dateien, welche vom Framework angeboten werden und eigene Übersetzungen, welche durch Verwendung des Gettext-Adapters vorhanden sind. Durch Kombination mehrerer Übersetzungsadapter kann man diese in einer Instanz verwenden. Siehe das folgende Beispiel:
Jetzt enthält die erste Instanz alle Übersetzungen der zweiten Instanz und man kann sie in der Anwendung sogar dann verwenden, wenn unterschiedliche Quell-Typen verwendet werden.
Wenn man Verzeichnisse scannt, kann es sein, dass man nur eine definierte Sprache verwenden will. Die vordefinierten Ressourcen sind zum Beispiel in mehr als 10 Sprachen vorhanden. Aber die eigene Sprache ist nicht in allen dieser Sprachen erhältlich. Deshalb kann man auch nur eine Sprache vom zweiten Adapter hinzufügen.
Das erlaubt es trotzdem durch die Verzeichnisse zu scannen und nur jene Sprachen hinzuzufügen, welche für die eigene Anwendung relevant sind. Prüfen von ÜbersetzungenNormalerweise wird Text ohne Berechnungen übersetzt. Aber manchmal ist es notwendig zu wissen, ob ein Text in der Quelle übersetzt ist oder nicht und hierfür kann die Methode isTranslated() verwendet werden. isTranslated($messageId, $original = false, $locale = null) nimmt den Text bzw. die Id von der man wissen will, ob sie übersetzbar ist, als ersten Parameter und als optionalen dritten Parameter das Gebietsschema, für das man die Prüfung durchführen will. Der optionale zweite Parameter definiert, ob die Übersetzung auf die definierte Sprache festgelegt ist oder ob eine kleinere Menge von Übersetzungen verwendet werden kann. Wenn ein Text, welcher für 'en' zurückgegeben werden kann, aber nicht für 'en_US', dann wird die Übersetzung normalerweise zurückgegeben, aber wenn $original auf TRUE gesetzt ist, gibt die isTranslated() Methode in solche Fällen FALSE zurück. Example #7 Prüfen ob ein Text übersetzbar ist
Wie können nicht gefundene Übersetzungen geloggt werdenWenn man eine größere Site hat oder man die Übersetzungsdateien manuell erstellt, hat man oft das Problem, dass einige Meldungen nicht übersetzt werden. Aber es gibt eine einfache Lösung, wenn man Zend_Translate verwendet. Man muss den folgenden zwei oder drei einfachen Schritten folgen. Zuerst muss man eine Instanz von Zend_Log erstellen. Anschließend muss man diese Instanz an Zend_Translate übergeben. Siehe das folgende Beispiel: Example #8 Übersetzungen loggen
Jetzt steht im Log eine neue Notiz: Untranslated message within 'de': unbekannter String.
Dieses Feature kann nicht nur verwendet werden um Nachrichten zu Loggen sondern auch um diese nicht übersetzen Nachrichten in eine leere Übersetzungsdatei zu schreiben. Um das zu ermöglichen, muss man seinen eigenen Log Writer erstellen, der das Format schreibt, das man haben will und das führende "Untranslated message" herausschneidet. Wenn man seine eigene Logmeldung haben will, kann man auch die Option 'logMessage' setzen. Das '%message%' Token ist für die Platzierung der messageId in der eigenen Logmeldung zu verwenden und das '%locale%' Token für das angefragte Gebietsschema. Siehe das folgende Beispiel für ein Beispiel einer selbst definierten Logmeldung: Example #9 Selbstdefinierte Logmeldungen
Zusätzlich kann man auch die Priorität ändern, welche verwendet wird, um eine Nachricht in das Log zu schreiben. Standardmäßig wird die Priorität Zend_Log::NOTICE verwendet. Sie ist identisch mit dem Wert 5. Wenn man die Priorität verändern will, kann man jede der Prioritäten von Zend_Log verwenden. Siehe das folgende Beispiel: Example #10 Selbst definierte Log Priorität
Zugang zu QuelldatenManchmal ist es nützlich, Zugang zu den übersetzten Quelldaten zu erhalten. Hierfür werden die folgenden zwei Methoden angeboten. Die getMessageIds($locale = null) Methode gibt alle bekannten Ids für Übersetzungen als Array zurück. Wenn man die Message ID für eine angegebene Übersetzung wissen will, dann kan man die Methode getMessageId() verwenden. Die getMessages($locale = null) Methode gibt die komplette Übersetzungsquelle 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, dass normalerweise alle Übersetzungen in allen Sprachen vorhanden sein sollten. Das bedeutet, dass man in einer normalen Situation diesen Parameter nicht angeben muss. Zusätzlich kann die getMessages() Methode verwendet werden, um das komplette Übersetzungsverzeichnis mit dem Pseudo-Gebietsschema 'all' zurückgeben. Das gibt alle vorhandenen Übersetzungsdaten für jedes hinzugefügte Gebietsschema zurück.
Example #11 Handhabung von Quelldaten
|