Zend_Translate-Additional.xml 35 KB

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