Zend_Translate-Additional.xml 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 20115 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.translate.additional">
  5. <title>Zusätzliche Features für Übersetzungen</title>
  6. <para>
  7. Es gibt verschiedene zusätzliche Features welche von <classname>Zend_Translate</classname>
  8. unterstützt werden. Lesen Sie hier für zusätzliche Informationen.
  9. </para>
  10. <sect2 id="zend.translate.additional.options">
  11. <title>Optionen für Adapter</title>
  12. <para>
  13. Optionen können bei allen Adaptern verwendet werden. Natürlich sind die Optionen für
  14. alle Adaptoren verschieden. Die Optionen können bei Erstellung des Objekts miterstellt
  15. werden. Zur Zeit gibt es nur eine Option die für alle Adaptoren verfügbar ist:
  16. '<code>clear</code>' setzt, ob die neuen Übersetzungsdaten zu den bestehenden
  17. hinzugefügt werden sollen oder ob Sie diese überschreiben. Das Standardverhalten ist
  18. das Hinzufügen von neuen Übersetzungsdaten zu den Bestehenden. Aber das wird immer nur
  19. für die aktuelle Sprache gemacht. Anderen Sprachen bleiben davon unberührt.
  20. </para>
  21. <para>
  22. Man kann Optionen temporär setzen indem man die Funktion
  23. <methodname>addTranslation($data, $locale, array $options = array())</methodname> als
  24. dritten und optionalen Parameter benutzt. Ausserdem kann die Methode
  25. <methodname>setOptions()</methodname> benutzt werden um Optionen permanent zu setzen.
  26. </para>
  27. <example id="zend.translate..additional.options.example">
  28. <title>Benutzen von Übersetzungsoptionen</title>
  29. <programlisting language="php"><![CDATA[
  30. // Definiere ':' als Trenner für die Quelldatei der Übersetzung
  31. $options = array('delimiter' => ':');
  32. $translate = new Zend_Translate(
  33. 'csv',
  34. '/path/to/mytranslation.csv',
  35. 'de',
  36. $options);
  37. ...
  38. // Lösche die definierte Sprache und verwende die neuen Übersetzungsdaten
  39. $options = array('clear' => true);
  40. $translate->addTranslation('/path/to/new.csv', 'fr', $options);
  41. ]]></programlisting>
  42. </example>
  43. <para>
  44. Hier können alle vorhandenen Optionen für die verschiedenen Adapter mit einer
  45. Beschreibung Ihrer Verwendung gefunden werden:
  46. </para>
  47. <table id="zend.translate.additional.options.alloptions">
  48. <title>Optionen für Übersetzungs-Adapter</title>
  49. <tgroup cols="4">
  50. <thead>
  51. <row>
  52. <entry>Option</entry>
  53. <entry>Adapter</entry>
  54. <entry>Beschreibung</entry>
  55. <entry>Standardwert</entry>
  56. </row>
  57. </thead>
  58. <tbody>
  59. <row>
  60. <entry>clear</entry>
  61. <entry>all</entry>
  62. <entry>
  63. Wenn <constant>TRUE</constant> gesetzt wird, werden bereits gelesene
  64. Übersetzungen entfernt. Das kann statt dem Erstellen einer neuen Instanz
  65. verwendet werden wenn neue Übersetzungsdaten gelesen werden
  66. </entry>
  67. <entry><emphasis><constant>FALSE</constant></emphasis></entry>
  68. </row>
  69. <row>
  70. <entry>disableNotices</entry>
  71. <entry>all</entry>
  72. <entry>
  73. Wenn es auf <constant>TRUE</constant> gesetzt wird, werden alle Notizen
  74. betreffend nicht vorhandenen Übersetzungen ausgeschaltet. Man sollte
  75. diese Option in einer Produktivumgebung auf <constant>TRUE</constant>
  76. setzen
  77. </entry>
  78. <entry><emphasis><constant>FALSE</constant></emphasis></entry>
  79. </row>
  80. <row>
  81. <entry>ignore</entry>
  82. <entry>all</entry>
  83. <entry>
  84. Alle Verzeichnisse und Dateien die mit diesem Präfix beginnen werden
  85. bei der Suche nach Dateien ignoriert. Der Standardwert ist
  86. <emphasis>'.'</emphasis> was zu dem Verhalten führt das
  87. alle versteckten Dateien ignoriert werden. Wenn dieser Wert auf
  88. <code>'tmp'</code> gesetzt wird, bedeutet das, Verzeichnisse und
  89. Dateien wie z.B. <code>'tmpImages'</code> und <code>'tmpFiles'</code>,
  90. sowie alle darunter liegenden Verzeichnisse, werden ignoriert.
  91. </entry>
  92. <entry><emphasis>.</emphasis></entry>
  93. </row>
  94. <row>
  95. <entry>log</entry>
  96. <entry>all</entry>
  97. <entry>
  98. Eine Instanz von <classname>Zend_Log</classname> wohin nicht
  99. übersetzbare Meldungen und Notizen geschrieben werden
  100. </entry>
  101. <entry><emphasis><constant>NULL</constant></emphasis></entry>
  102. </row>
  103. <row>
  104. <entry>logMessage</entry>
  105. <entry>all</entry>
  106. <entry>
  107. Die Nachricht die in das Log geschrieben werden soll
  108. </entry>
  109. <entry>
  110. <emphasis>Untranslated message within '%locale%': %message%</emphasis>
  111. </entry>
  112. </row>
  113. <row>
  114. <entry>logUntranslated</entry>
  115. <entry>all</entry>
  116. <entry>
  117. Wenn diese Option auf <constant>TRUE</constant> gesetzt wird, werden
  118. alle Nachrichten Id's die nicht übersetzt werden können in das
  119. angehängte Log geschrieben
  120. </entry>
  121. <entry><emphasis><constant>FALSE</constant></emphasis></entry>
  122. </row>
  123. <row>
  124. <entry>reload</entry>
  125. <entry>all</entry>
  126. <entry>
  127. Wenn diese Option auf <constant>TRUE</constant> gesetzt wird, werden die
  128. Dateien in den Cache nachgeladen. Diese Option kann verwendet werden um
  129. den Cache wieder herzustellen, oder Übersetzungen zu bereits gecachten
  130. Daten hinzuzufügen nachdem der Cache bereits erstellt wurde.
  131. </entry>
  132. <entry><emphasis><constant>FALSE</constant></emphasis></entry>
  133. </row>
  134. <row>
  135. <entry>scan</entry>
  136. <entry>all</entry>
  137. <entry>
  138. Wenn <constant>NULL</constant> gesetzt wird, wird die Verzechnisstruktur
  139. nicht gescannt. Wenn
  140. <constant>Zend_Translate::LOCALE_DIRECTORY</constant> gesetzt wird,
  141. wird das Gebietsschema im Verzeichnis gesucht. Wenn
  142. <constant>Zend_Translate::LOCALE_FILENAME</constant> gesetzt wird,
  143. wird das Gebietsschema im Dateinamen gesucht. Siehe
  144. <xref linkend="zend.translate.additional.detection" /> für Details
  145. </entry>
  146. <entry><emphasis><constant>NULL</constant></emphasis></entry>
  147. </row>
  148. <row>
  149. <entry>delimiter</entry>
  150. <entry>Csv</entry>
  151. <entry>
  152. Definiert welches Zeichen als Trenner für Quelle und Übersetzung
  153. verwendet wird
  154. </entry>
  155. <entry><emphasis>;</emphasis></entry>
  156. </row>
  157. <row>
  158. <entry>enclosure</entry>
  159. <entry>Csv</entry>
  160. <entry>
  161. Definiert die maximale Länge einer CSV Zeile. Auf 0 gesetzt wird sie
  162. automatisch erkannt
  163. </entry>
  164. <entry><emphasis>"</emphasis></entry>
  165. </row>
  166. <row>
  167. <entry>length</entry>
  168. <entry>Csv</entry>
  169. <entry>
  170. Definiert das zu verwendende Einschließungszeichen. Standard ist das
  171. doppelte Hochkomma
  172. </entry>
  173. <entry><emphasis>0</emphasis></entry>
  174. </row>
  175. <row>
  176. <entry>useId</entry>
  177. <entry>Xliff</entry>
  178. <entry>
  179. Wenn diese Option auf <constant>FALSE</constant> gesetzt wird, dann wird
  180. der Source String als Message Id verwendet. Der Standardwert dieser
  181. Option ist <constant>TRUE</constant>, was bedeutet dass die Id vom
  182. trans-unit Element als Message Id verwendet wird
  183. </entry>
  184. <entry><emphasis><constant>TRUE</constant></emphasis></entry>
  185. </row>
  186. </tbody>
  187. </tgroup>
  188. </table>
  189. <para>
  190. Wenn man selbstdefinierte Optionen haben will, können diese auch in allen Adaptern
  191. verwendet werden. Die <methodname>setOptions()</methodname> Methode kann verwendet
  192. werden um die eigene Option zu definieren. <methodname>setOptions()</methodname>
  193. benötigt ein Array mit den Optionen die gesetzt werden sollen. Wenn eine angegebene
  194. Option bereits existiert wird diese überschrieben. Es können beliebig viele Optionen
  195. definiert werden da diese nicht vom Adapter geprüft werden. Man muß nur Sicherstellen
  196. das keine existierende Option überschrieben werden die von einem Adapter verwendet wird.
  197. </para>
  198. <para>
  199. Um die Option zurückzugeben kann die Methode <methodname>getOptions()</methodname>
  200. verwendet werden. Wenn <methodname>getOptions()</methodname> ohne einen Parameter
  201. aufgerufen wird, gibt Sie alle Optionen zurück. Wenn der optionale Parameter angegeben
  202. wird, wird nur die spezifizierte Option zurückgegeben.
  203. </para>
  204. </sect2>
  205. <sect2 id="zend.translate.additional.languages">
  206. <title>Mit Sprachen arbeiten</title>
  207. <para>
  208. Wenn mit verschiedenen Sprachen gearbeitet wird gibt es ein paar Methoden die nützlich
  209. sind.
  210. </para>
  211. <para>
  212. Die <methodname>getLocale()</methodname> Methode kann verwendet werden um die aktuell
  213. gesetzte Sprache zu erhalten. Sie kann entweder eine Instanz von
  214. <classname>Zend_Locale</classname> oder den Bezeichner des Gebietsschemas enthalten.
  215. </para>
  216. <para>
  217. Die <methodname>setLocale()</methodname> Methode setzt eine neue Standardsprache für
  218. Übersetzungen. Das verhindert das der optionale Sprachparameter der
  219. <methodname>translate()</methodname> Methode mehr als einmal gesetzt werden muß. Wenn
  220. die angegebene Sprache nicht existiert, oder keine Übersetzten Daten für diese Sprache
  221. vorhanden sind, versucht <methodname>setLocale()</methodname> auf die Sprache ohne
  222. Region downzugraden wenn diese angegeben wurde. Die Sprache <code>en_US</code> würde zum
  223. Beispiel zu <code>en</code> downgegradet werden. Wenn sogar nach dem Downgraden die
  224. Sprache nicht gefunden werden konnte, wird eine Ausnahme geworfen.
  225. </para>
  226. <para>
  227. Die <methodname>isAvailable()</methodname> Methode prüft ob eine angegebene Sprache
  228. bereits vorhanden ist. Es wird <constant>TRUE</constant> zurückgegeben wenn Daten für
  229. die angegebene Sprache existieren.
  230. </para>
  231. <para>
  232. Und letztendlich kann die <methodname>getList()</methodname> Methode verwendet werden um
  233. alle aktuell gesetzten Sprachen für einen Adapter als Array zu erhalten.
  234. </para>
  235. <example id="zend.translate.additional.languages.example">
  236. <title>Handhabung von Sprachen mit Adaptern</title>
  237. <programlisting language="php"><![CDATA[
  238. // gibt die aktuell gesetzte Sprache zurück
  239. $actual = $translate->getLocale();
  240. // der optionale Parameter kann wärend der Übersetzung verwendet werden
  241. echo $translate->_("my_text", "fr");
  242. // oder setze eine neue Standardsprache
  243. $translate->setLocale("fr");
  244. echo $translate->_("my_text");
  245. // zur Basissprache referieren
  246. // fr_CH wird zu fr downgegradet
  247. $translate->setLocale("fr_CH");
  248. echo $translate->_("my_text");
  249. // Prüft ob die Sprache existiert
  250. if ($translate->isAvailable("fr")) {
  251. // Sprache existiert
  252. }
  253. ]]></programlisting>
  254. </example>
  255. <sect3 id="zend.translate.additional.languages.automatic">
  256. <title>Automatische Handhabung von Sprachen</title>
  257. <para>
  258. Es gilt zu beachten das, solange man neue Sprachquellen mit der
  259. <methodname>addTranslation()</methodname> Methode hinzufügt,
  260. <classname>Zend_Translate</classname> automatisch die am besten passende Sprache für
  261. die eigene Umgebung auswählt wenn man eine der automatischen Gebietsschemata
  262. verwendet die '<code>auto</code>' oder '<code>browser</code>' sein können. Man muß
  263. normalerweise also <methodname>setLocale()</methodname> nicht aufrufen. Das sollte
  264. nur in Verbindung mit der automatischen Erkennung von Quellen verwendet werden.
  265. </para>
  266. <para>
  267. Der Algorithmus sucht nach dem am besten passenden Gebietsschema abhängig vom
  268. Browser des Benutzers und der eigenen Umgebung. Siehe das folgende Beispiel für
  269. Details:
  270. </para>
  271. <example id="zend.translate.additional.languages.automatic.example">
  272. <title>Automatische Erkennen der Sprache</title>
  273. <programlisting language="php"><![CDATA[
  274. // Angenommen der Browser gibt folgende Spracheneinstellungen zurück:
  275. // HTTP_ACCEPT_LANGUAGE = "de_AT=1;fr=1;en_US=0.8";
  276. // Beispiel 1:
  277. // Wenn keine passende Sprache gefunden wird, wird die MessageID zurückgegeben
  278. $translate = new Zend_Translate(
  279. 'gettext',
  280. 'my_it.mo',
  281. 'auto',
  282. array('scan' => Zend_Translate::LOCALE_FILENAME));
  283. // Beispiel 2:
  284. // Die am besten passende Sprache ist 'fr'
  285. $translate = new Zend_Translate(
  286. 'gettext',
  287. 'my_fr.mo',
  288. 'auto',
  289. array('scan' => Zend_Translate::LOCALE_FILENAME));
  290. // Beispiel 3:
  291. // Die am besten passende Sprache ist 'de' ('de_AT' wird degradiert)
  292. $translate = new Zend_Translate(
  293. 'gettext',
  294. 'my_de.mo',
  295. 'auto',
  296. array('scan' => Zend_Translate::LOCALE_FILENAME));
  297. // Beispiel 4:
  298. // Gibt 'it' als Übersetzungsquelle zurück und überschreibt
  299. // die automatischen Eigenschaften
  300. $translate = new Zend_Translate(
  301. 'gettext',
  302. 'my_it.mo',
  303. 'auto',
  304. array('scan' => Zend_Translate::LOCALE_FILENAME));
  305. $translate->addTranslation('my_ru.mo', 'ru');
  306. $translate->setLocale('it_IT');
  307. ]]></programlisting>
  308. </example>
  309. <para>
  310. Nachdem eine Sprache per Hand mit der <methodname>setLocale()</methodname> Methode
  311. gesetzt wurde, wird die automatische Erkennung ausgeschaltet und übergangen.
  312. </para>
  313. <para>
  314. Wenn man Sie wieder verwenden will, kann die Sprache
  315. <emphasis>auto</emphasis> mit <methodname>setLocale()</methodname> gesetzt
  316. werden, was die automatische Erkennung für <classname>Zend_Translate</classname>
  317. wieder reaktiviert.
  318. </para>
  319. <para>
  320. Seit dem Zend Framework 1.7.0 unterstützt <classname>Zend_Translate</classname> auch
  321. die Verwendung eines Anwendungsweiten Gebietsschemas. Man kann einfach eine
  322. <classname>Zend_Locale</classname> Instanz in der Registry setzen wie unten gezeigt.
  323. Mit dieser Schreibweise kann man das manuelle Setzen eines Gebietsschemas mit jeder
  324. Instanz komplett vergessen wenn man das gleiche Gebietsschema mehrere Male
  325. verwenden will.
  326. </para>
  327. <programlisting language="php"><![CDATA[
  328. // In der Bootstrap Datei
  329. $locale = new Zend_Locale();
  330. Zend_Registry::set('Zend_Locale', $locale);
  331. // Standardsprache wenn die angefragte Sprache nicht vorhanden ist
  332. $defaultlanguage = 'en';
  333. // Irgendwo in der Anwendung
  334. $translate = new Zend_Translate('gettext', 'my_de.mo');
  335. if (!$translate->isAvailable($locale->getLanguage())) {
  336. // Nicht vorhandene Sprache werden auf eine andere Sprache geroutet
  337. $translate->setLocale($defaultlanguage);
  338. }
  339. $translate->getLocale();
  340. ]]></programlisting>
  341. </sect3>
  342. </sect2>
  343. <sect2 id="zend.translate.additional.detection">
  344. <title>Automatische Erkennung von Quellen</title>
  345. <para>
  346. <classname>Zend_Translate</classname> kann Übersetzungsquellen automatisch erkennen. Es
  347. muß also nicht jede Quelldatei manuell deklariert werden. Man kann diesen Job
  348. <classname>Zend_Translate</classname> überlassen welches die komplette
  349. Verzeichnisstruktur nach Quelldateien durchsucht.
  350. </para>
  351. <note>
  352. <para>
  353. Automatische Erkennung der Quellen ist seit Zend Framework Version 1.5 vorhanden.
  354. </para>
  355. </note>
  356. <para>
  357. Die Verwendung ist fast die selbe wie bei der Initiierung einer einzelnen
  358. Übersetzungsquelle mit einem Unterschied. Es darf nur ein Verzeichnis angegeben werden,
  359. statt einer Datei, welches gescannt werden soll.
  360. </para>
  361. <example id="zend.translate.additional.languages.directory.example">
  362. <title>Scannen nach Quellen in einer Verzeichnisstruktur</title>
  363. <programlisting language="php"><![CDATA[
  364. // Angenommen wir haben die folgende Struktur
  365. // /language/
  366. // /language/login/login.tmx
  367. // /language/logout/logout.tmx
  368. // /language/error/loginerror.tmx
  369. // /language/error/logouterror.tmx
  370. $translate = new Zend_Translate('tmx', '/language');
  371. ]]></programlisting>
  372. </example>
  373. <para>
  374. <classname>Zend_Translate</classname> muß also nicht nur das angegebene Verzeichnis
  375. durchsuchen, sondern auch alle Unterverzeichnisse nach Dateien für Übersetzungen. Das
  376. macht die Verwendung sehr einfach. Aber <classname>Zend_Translate</classname> wird alle
  377. Dateien ignorieren, welche keine Quellen sind, oder wärend des Einlesens der
  378. Übersetzungsdaten Fehler produzieren. Man sollte also sicherstellen das alle
  379. Übersetzungsquellen korrekt sind und gelesen werden können weil man keinen Fehler erhält
  380. wenn eine Datei fehlerhaft ist oder nicht gelesen werden kann.
  381. </para>
  382. <note>
  383. <para>
  384. Abhängig davon wie tief die Verzeichnisstruktur ist und wieviele Dateien innerhalb
  385. dieser Struktur vorhanden sind, kann es eine sehr lange Zeit dauern bis
  386. <classname>Zend_Translate</classname> fertig ist.
  387. </para>
  388. </note>
  389. <para>
  390. In unserem Beispiel haben wir das TMX Format verwendet welches die Sprache enthält die
  391. innerhalb der Quelle verwendet wird. Aber viele der anderen Quellformate sind nicht
  392. dazu fähig die Sprache in der Datei selbst zu inkludieren. Aber auch diese quellen
  393. können mit der automatischen Erkennung verwendet werden wenn ein paar Dinge
  394. berücksichtigt werden die anbei beschrieben sind:
  395. </para>
  396. <sect3 id="zend.translate.additional.detection.directory">
  397. <title>Sprachen durch die Benennung von Verzeichnissen</title>
  398. <para>
  399. Ein Weg, die automatische Spracherkennung zu inkludieren, ist es die Verzeichnisse
  400. relativ zur Sprache zu benennen, welche in den Quellen des betreffenden
  401. Verzeichnisses verwendet wird. Das ist der einfachste Weg und wird zum Beispiel in
  402. Standard Gettext Implementationen verwendet.
  403. </para>
  404. <para>
  405. <classname>Zend_Translate</classname> benötigt die '<code>scan</code>' Option um zu
  406. wissen das es die Namen aller Verzeichnisse nach Sprachen durchsuchen soll. Siehe
  407. das folgende Beispiel für Details:
  408. </para>
  409. <example id="zend.translate.additional.detection.directory.example">
  410. <title>Verzeichnisse nach Sprachen durchsuchen</title>
  411. <programlisting language="php"><![CDATA[
  412. // Angenommen wir haben die folgende Struktur
  413. // /language/
  414. // /language/de/login/login.mo
  415. // /language/de/error/loginerror.mo
  416. // /language/en/login/login.mo
  417. // /language/en/error/loginerror.mo
  418. $translate = new Zend_Translate(
  419. 'gettext',
  420. '/language',
  421. null,
  422. array('scan' => Zend_Translate::LOCALE_DIRECTORY));
  423. ]]></programlisting>
  424. </example>
  425. <note>
  426. <para>
  427. Das funktioniert nur für Adapter welche die Sprache nicht in der Quelldatei
  428. enthalten. Die Verwendung dieser Option wird zum Beispiel mit TMX ignoriert.
  429. Sprachdefinitionen im Dateinamen werden bei der Verwendung dieser Option
  430. ignoriert.
  431. </para>
  432. </note>
  433. <note>
  434. <para>
  435. Man sollte acht geben wenn man verschiedenen Unterverzeichnisse in der gleichen
  436. Struktur hat. Angenommen wir haben eine Struktur wie
  437. <code>/language/module/de/en/file.mo</code>. In diesem Fall enthält der Pfad
  438. mehrere Strings die als Gebietsschema erkannt werden würden. Das könnte
  439. entweder <code>de</code> oder <code>en</code> sein. In solch einem Fall ist das
  440. Verhalten nicht definiert und es wird empfohlen die Dateierkennung zu
  441. verwenden.
  442. </para>
  443. </note>
  444. </sect3>
  445. <sect3 id="zend.translate.additional.detection.filename">
  446. <title>Sprache durch Dateinamen</title>
  447. <para>
  448. Ein anderer Weg um die Sprache automatisch zu erkennen ist die Verwendung von
  449. speziellen Dateienamen. Man kann entweder die komplette Datei oder Teile der
  450. Datei nach der verwendeten Sprache benennen. Um diese Option zu Verwenden muß die
  451. '<code>scan</code>' Option bei der Initiierung gesetzt werden. Es gibt verschiedene
  452. Wege die Quelldateien zu benennen welche im folgenden beschrieben werden:
  453. </para>
  454. <example id="zend.translate.additional.detection.filename.example">
  455. <title>Suchen nach Sprachen im Dateinamen</title>
  456. <programlisting language="php"><![CDATA[
  457. // Angenommen wir haben die folgende Struktur
  458. // /language/
  459. // /language/login/login_en.mo
  460. // /language/login/login_de.mo
  461. // /language/error/loginerror_en.mo
  462. // /language/error/loginerror_de.mo
  463. $translate = new Zend_Translate(
  464. 'gettext',
  465. '/language',
  466. null,
  467. array('scan' => Zend_Translate::LOCALE_FILENAME));
  468. ]]></programlisting>
  469. </example>
  470. <sect4 id="zend.translate.additional.detection.filename.complete">
  471. <title>Komplette Dateinamen</title>
  472. <para>
  473. Die komplette Datei nach der Sprache zu benennen ist der einfachste Weg, aber
  474. nur praktikabel wenn man nur eine Datei pro Verzeichnis verwendet.
  475. </para>
  476. <programlisting><![CDATA[
  477. /languages/
  478. /languages/en.mo
  479. /languages/de.mo
  480. /languages/es.mo
  481. ]]></programlisting>
  482. </sect4>
  483. <sect4 id="zend.translate.additional.detection.filename.extension">
  484. <title>Erweiterung der Datei</title>
  485. <para>
  486. Ein anderer einfacher Weg ist die Verwendung der Dateiextension für die
  487. Spracherkennung. Aber das kann verwirrend sein weil man keine Idee mehr hat
  488. welche Erweiterung die Datei ursprünglich hatte.
  489. </para>
  490. <programlisting><![CDATA[
  491. /languages/
  492. /languages/view.en
  493. /languages/view.de
  494. /languages/view.es
  495. ]]></programlisting>
  496. </sect4>
  497. <sect4 id="zend.translate.additional.detection.filename.token">
  498. <title>Teile von Dateinamen</title>
  499. <para>
  500. <classname>Zend_Translate</classname> kann die Sprache auch erkennen wenn Sie im
  501. Dateinamen enthalten ist. Aber wenn man diesen Weg nimmt, muß die Sprache mit
  502. einem Trennzeichen seperiert werden. Es gibt drei unterstützte Trennzeichen
  503. welche verwendet werden können. Ein Punkt '.', ein Unterstrich '_', oder ein
  504. Bindestrich '-'.
  505. </para>
  506. <programlisting><![CDATA[
  507. /languages/
  508. /languages/view_en.mo -> erkennt englisch
  509. /languages/view_de.mo -> erkennt deutsch
  510. /languages/view_it.mo -> erkennt italienisch
  511. ]]></programlisting>
  512. <para>
  513. Das erste gefundene String der von einem Trennzeichen getrennt wird das als
  514. Gebietsschema interpretiert werden kann, wird verwendet. Siehe das folgende
  515. Beispiel für Details.
  516. </para>
  517. <programlisting><![CDATA[
  518. /languages/
  519. /languages/view_en_de.mo -> erkennt englisch
  520. /languages/view_en_es.mo -> erkennt englisch und überschreibt die erste Datei
  521. /languages/view_it_it.mo -> erkennt italienisch
  522. ]]></programlisting>
  523. <para>
  524. Alle drei Trennzeichen werden verwendet um das Gebietsschema zu erkennen. Wenn
  525. der Dateiname mehrere Trennzeichen enthält, hängt das erste gefundene
  526. Trennzeichen von der Reihenfolge der Trennzeichen ab die verwendet werden.
  527. Siehe das folgende Beispiel für Details.
  528. </para>
  529. <programlisting><![CDATA[
  530. /languages/
  531. /languages/view_en-it.mo -> erkennt englisch weil '_' vor '-' verwendet wird
  532. /languages/view-en_it.mo -> erkennt italienisch weil '_' vor '-' verwendet wird
  533. /languages/view_en.it.mo -> erkennt italienisch weil '.' vor '_' verwendet wird
  534. ]]></programlisting>
  535. </sect4>
  536. </sect3>
  537. </sect2>
  538. <sect2 id="zend.translate.additional.istranslated">
  539. <title>Prüfen von Übersetzungen</title>
  540. <para>
  541. Normalerweise wird Text ohne Berechnungen übersetzt. Aber manchmal ist es notwendig
  542. zu wissen, ob ein Text in der Quelle übersetzt ist oder nicht, und hierfür kann die
  543. Methode <methodname>isTranslated()</methodname> verwendet werden.
  544. </para>
  545. <para>
  546. <methodname>isTranslated($messageId, $original = false, $locale = null)</methodname>
  547. nimmt den Text bzw die Id von der man wissen will ob sie Übersetzbar ist, als ersten
  548. Parameter, und als optionalen dritten Parameter das Gebietsschema für das man die
  549. Prüfung durchführen will. Der optionale zweite Parameter definiert ob die Übersetzung
  550. fix für die definierte Sprache ist oder ob ein kleineres Set von Übersetzungen verwendet
  551. werden kann. Wenn ein Text, welcher für 'en' zurückgegeben werden kann, aber nicht für
  552. 'en_US', dann wird die Übersetzung normalerweise zurückgegeben, aber wenn
  553. <varname>$original</varname> auf <constant>TRUE</constant> gesetzt ist, gibt die
  554. <methodname>isTranslated()</methodname> Methode in solche Fällen
  555. <constant>FALSE</constant> zurück.
  556. </para>
  557. <example id="zend.translate.additional.istranslated.example">
  558. <title>Prüfen ob ein Text übersetzbar ist</title>
  559. <programlisting language="php"><![CDATA[
  560. $english = array(
  561. 'message1' => 'Nachricht 1',
  562. 'message2' => 'Nachricht 2',
  563. 'message3' => 'Nachricht 3');
  564. $translate = new Zend_Translate('array', $english, 'de_AT');
  565. if ($translate->isTranslated('message1')) {
  566. print "'message1' kann übersetzt werden";
  567. }
  568. if (!($translate->isTranslated('message1', true, 'de'))) {
  569. print "'message1' kann nicht in 'de' übersetzt werden da es "
  570. . "nur in 'de_AT' vorhanden ist";
  571. }
  572. if ($translate->isTranslated('message1', false, 'de')) {
  573. print "'message1' kann in 'de_AT' übersetzt werden "
  574. . "da es zu 'de' zurückfällt";
  575. }
  576. ]]></programlisting>
  577. </example>
  578. </sect2>
  579. <sect2 id="zend.translate.additional.logging">
  580. <title>Wie können nicht gefundene Übersetzungen geloggt werden</title>
  581. <para>
  582. Wenn man eine größere Site hat, oder man die Übersetzungsdateien manuell erstellt hat
  583. man oft das Problem das einige Meldungen nicht übersetzt werden. Aber es gibt eine
  584. einfache Lösung wenn man <classname>Zend_Translate</classname> verwendet.
  585. </para>
  586. <para>
  587. Man muß den folgenden zwei oder drei einfachen Schritten folgen. Erstens, muß man eine
  588. Instanz von <classname>Zend_Log</classname> erstellen. Und dann muß man diese Instanz an
  589. <classname>Zend_Translate</classname> übergeben. Siehe das folgende Beispiel:
  590. </para>
  591. <example id="zend.translate.additional.logging.example">
  592. <title>Übersetzungen loggen</title>
  593. <programlisting language="php"><![CDATA[
  594. $translate = new Zend_Translate('gettext', $path, 'de');
  595. // Eine Log Instanz erstellen
  596. $writer = new Zend_Log_Writer_Stream('/path/to/file.log');
  597. $log = new Zend_Log($writer);
  598. // Diese der Übersetzungs-Instanz hinzufügen
  599. $translate->setOptions(array(
  600. 'log' => $log,
  601. 'logUntranslated' => true));
  602. $translate->translate('unbekannter String');
  603. ]]></programlisting>
  604. </example>
  605. <para>
  606. Jetzt steht im Log eine neue Notiz:
  607. <code>Untranslated message within 'de': unbekannter String</code>.
  608. </para>
  609. <note>
  610. <para>
  611. Man sollte beachten das jede Übersetzung die nicht gefunden wird mitgeloggt wird.
  612. Das bedeutet alle Übersetzungen wenn ein Benutzer eine nicht unterstützte Sprache
  613. anfragt. Aber auch jede Anfrage für eine Nachricht die nicht übersetzt werden kann
  614. wird mitgeloggt. Es ist zu beachten das, 100 Personen welche die gleiche Übersetzung
  615. anfragen, auch zu 100 geloggten Notizen führen.
  616. </para>
  617. </note>
  618. <para>
  619. Dieses Feature kann nicht nur verwendet werden um Nachrichten zu Loggen sondern auch um
  620. diese nicht übersetzen Nachrichten in eine leere Übersetzungsdatei zu schreiben. Um das
  621. zu ermöglichen muß man seinen eigenen Log Writer erstellen der das Format schreibt das
  622. man haben will und das führende "Untranslated message" herausschneidet.
  623. </para>
  624. <para>
  625. Wenn man seine eigene Logmeldung haben will, kann man auch die Option
  626. '<code>logMessage</code>' setzen. Das '<code>%message%</code>' Token ist für die
  627. Platzierung der messageId in der eigenen Logmeldung zu verwenden, und das
  628. '<code>%locale%</code>' Token für das angefragte Gebietsschema. Siehe das folgende
  629. Beispiel für ein Beispiel einer selbst definierten Logmeldung:
  630. </para>
  631. <example id="zend.translate.additional.logging.example2">
  632. <title>Selbstdefinierte Logmeldungen</title>
  633. <programlisting language="php"><![CDATA[
  634. $translate = new Zend_Translate('gettext', $path, 'de');
  635. // Eine Loginstanz erstellen
  636. $writer = new Zend_Log_Writer_Stream('/path/to/file.log');
  637. $log = new Zend_Log($writer);
  638. // Diese der Übersetzungsinstanz hinzufügen
  639. $translate->setOptions(array(
  640. 'log' => $log,
  641. 'logMessage' => "Fehlende '%message%' im Gebietsschema '%locale%'",
  642. 'logUntranslated' => true));
  643. $translate->translate('unknown string');
  644. ]]></programlisting>
  645. </example>
  646. </sect2>
  647. <sect2 id="zend.translate.additional.sourcedata">
  648. <title>Zugang zu Quelldaten</title>
  649. <para>
  650. Manchmal ist es nützlich, Zugang zu den übersetzten Quelldaten zu erhalten. Hierfür
  651. werden die folgenden zwei Methoden angeboten.
  652. </para>
  653. <para>
  654. Die <methodname>getMessageIds($locale = null)</methodname> Methode gibt alle bekannten
  655. Ids für Übersetzungen als Array zurück.
  656. </para>
  657. <para>
  658. Die <methodname>getMessages($locale = null)</methodname> Methode gibt die komplette
  659. Übersetzungs-Quelle als Array zurück. Die Ids der Übersetzungen werden als Schlüssel
  660. und die Übersetzten Daten als Wert verwendet.
  661. </para>
  662. <para>
  663. Beide Methoden akzeptieren einen optionalen Parameter <varname>$locale</varname>
  664. welcher, wenn er gesetzt wird, die Übersetzungsdaten für die spezifizierte Sprache,
  665. zurückgibt. Wenn dieser Parameter nicht angegeben wird, wird die aktuell gesetzte
  666. Sprache verwendet. Es ist zu beachten das normalerweise alle Übersetzungen in allen
  667. Sprachen vorhanden sein sollten. Das bedeutet das man in einer normalen Situation diesen
  668. Parameter nicht angeben muß.
  669. </para>
  670. <para>
  671. Zusätzlich kann die <methodname>getMessages()</methodname> Methode verwendet werden um
  672. das komplette Übersetzungsverzeichnis, mit dem Pseudo-Gebietsschema 'all', zurückgeben.
  673. Das gibt alle vorhandenen Übersetzungsdaten für jedes hinzugefügte Gebietsschema
  674. zurück.
  675. </para>
  676. <note>
  677. <para>
  678. Achtung: Das zurückgegebene Array kann
  679. <emphasis>sehr groß</emphasis> sein, abhängig von der Anzahl an
  680. hinzugefügten Gebietsschemata und der Anzahl an Übersetzungsdaten.
  681. </para>
  682. </note>
  683. <example id="zend.translate.additional.sourcedata.example">
  684. <title>Handhabung von Quelldaten</title>
  685. <programlisting language="php"><![CDATA[
  686. // gibt alle bekannten Übersetzungs Ids zurück
  687. $messageIds = $translate->getMessageIds();
  688. print_r($messageIds);
  689. // oder nur die spezifizierte Sprache
  690. $messageIds = $translate->getMessageIds('en_US');
  691. print_r($messageIds);
  692. // gibt die kompletten Übersetzungs Daten zurück
  693. $source = $translate->getMessages();
  694. print_r($source);
  695. ]]></programlisting>
  696. </example>
  697. </sect2>
  698. </sect1>