Zend_Translate-Using.xml 54 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15157 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.translate.using">
  5. <title>Benutzen von Übersetzungs Adaptoren</title>
  6. <para>
  7. Der nächste Schritt ist die Benutzung des Adapters im eigenen Code.
  8. </para>
  9. <example id="zend.translate.using.example1">
  10. <title>Beispiel eines einsprachigen PHP Codes</title>
  11. <programlisting role="php"><![CDATA[
  12. print "Beispiel\n";
  13. print "========\n";
  14. print "Hier steht Zeile eins\n";
  15. print "Heute ist der " . date("d.m.Y") . "\n";
  16. print "\n";
  17. print "Hier ist Zeile zwei\n";
  18. ]]></programlisting>
  19. </example>
  20. <para>
  21. Das obige Beispiel zeigt eine Ausgabe ohne Unterstützung für Übersetzungen. Der Code wird
  22. üblicherweise in der eigenen Muttersprache geschrieben. Üblicherweise muß nicht nur die
  23. Ausgabe übersetzt werden, sondern auch Fehler- und Logmeldungen.
  24. </para>
  25. <para>
  26. Der nächste Schritt ist also die Integration von Zend_Translate in den eigenen Code.
  27. Natürlich ist das viel einfacher wenn der Code bereits so geschrieben wird das er
  28. übersetzbar ist, anstatt Ihn im Nachhinein dafür zu ändern.
  29. </para>
  30. <example id="zend.translate.using.example2">
  31. <title>Beispiel für mehrsprachigen PHP Code</title>
  32. <programlisting role="php"><![CDATA[
  33. $translate = new Zend_Translate(
  34. 'gettext',
  35. '/path/to/translation/source-de.mo',
  36. 'de'
  37. );
  38. $translate->addTranslation('//my/path/fr-source.mo', 'fr');
  39. print $translate->_("Beispiel") . "\n";
  40. print "========\n";
  41. print $translate->_("Hier steht Zeile eins") . "\n";
  42. printf($translate->_("Heute ist der %1\$s") . "\n", date('d.m.Y'));
  43. print "\n";
  44. $translate->setLocale('fr');
  45. print $translate->_("Hier ist Zeile zwei") . "\n";
  46. ]]></programlisting>
  47. </example>
  48. <para>
  49. Jetzt schauen wir uns genauer an, was getan wurde, und wie <classname>Zend_Translate</classname> in
  50. den eigenen Code integriert wird.
  51. </para>
  52. <para>
  53. Erstelle ein neues <classname>Zend_Translate</classname> Objekt und definiere den Basis Adapter:
  54. <programlisting role="php"><![CDATA[
  55. $translate = new Zend_Translate(
  56. 'gettext',
  57. '/path/to/translation/source-de.mo',
  58. 'de'
  59. );
  60. ]]></programlisting>
  61. In diesem Beispiel haben wir den <emphasis role="strong">Gettext Adapter</emphasis>
  62. ausgewählt. Die Übersetzungsdatei <emphasis role="strong">source-de.mo</emphasis> wird im
  63. Verzeichnis <emphasis role="strong">/path/to/translation</emphasis> platziert. Diese
  64. Gettext Datei beinhaltet eine deutsche Übersetzung und es steht auch eine zweite
  65. Sprachquelle für Französisch zur Verfügung.
  66. </para>
  67. <para>
  68. Der nächste Schritt besteht darin alle Strings zu ummanteln die übersetzt werden sollen.
  69. Die einfachste Möglichkeit besteht wenn nur einfache Strings oder Sätze vorhanden sind
  70. wie zum Beispiel:
  71. <programlisting role="php"><![CDATA[
  72. print $translate->_("Beispiel") . "\n";
  73. print "========\n";
  74. print $translate->_("Hier ist die Zeile Eins") . "\n";
  75. ]]></programlisting>
  76. Einige Strings müssen nicht übersetzt werden. Die Trennlinie wird immer eine Trennlinie sein,
  77. auch in den anderen Sprachen.
  78. </para>
  79. <para>
  80. Variable Werte in eine Übersetzung zu integrieren wird aber auch unterstützt durch die
  81. Verwendung von eingebetteten Parametern.
  82. <programlisting role="php"><![CDATA[
  83. printf($translate->_("Today is the %1\$s") . "\n", date("d.m.Y"));
  84. ]]></programlisting>
  85. Statt <code>print()</code> wird die <code>printf()</code> Funktion benutzt
  86. und alle variablen Parameter mit <code>%1\$s</code> Blöcken ersetzt.
  87. Der erste ist <code>%1\$s</code>, der zweite ist <code>%2\$s</code>, und so weiter.
  88. Auf diesen Weg kann übersetzt werden ohne den exakten Wert zu wissen. In unserem
  89. Beispiel ist das Datum immer der aktuelle Tag, aber der String kann übersetzt
  90. werden ohne über den aktuellen Tag bescheid zu wissen.
  91. </para>
  92. <para>
  93. Jeder String wird im Übersetzungsspeicher identifiziert durch seine Message ID.
  94. Man könnte diese Message IDs statt des Strings im Code wie folgt verwenden:
  95. <programlisting role="php"><![CDATA[
  96. print $translate->_(1) . "\n";
  97. print "=======\n";
  98. print $translate->_(2) . "\n";
  99. ]]></programlisting>
  100. Allerdings hat dies mehrere grobe Nachteile:
  101. </para>
  102. <para>
  103. Es ist nicht erkennbar was der Code ausgeben sollte indem man ihn betrachtet.
  104. </para>
  105. <para>
  106. Es werden auch Probleme auftreten wenn einige Strings nicht übersetzt worden sind. Man muß
  107. sich immer vor Augen halten wie Übersetzungen funktionieren. Zuerst prüft
  108. <classname>Zend_Translate</classname> ob in der gesetzten Sprache, für die angegebene Message ID oder
  109. den String, eine Übersetzung vorhanden ist. Wenn kein Übersetzung gefunden wurde, wird in
  110. der nächsten tiefer gelegenen Sprache gesucht wie in <classname>Zend_Locale</classname> definiert.
  111. "<emphasis role="strong">de_AT</emphasis>" wird also zu
  112. "<emphasis role="strong">de</emphasis>". Wenn auch hier keine Übersetzung in der Sprache
  113. "<emphasis role="strong">de</emphasis>" gefunden wurde, wird der Original String zurück
  114. gegeben. Das bedeutet also das immer eine Ausgabe existiert, selbst wenn für eine Message
  115. ID keine Übersetzung in der Quelle vorhanden ist. <classname>Zend_Translate</classname> wird niemals
  116. eine Exception oder einen Fehler ausgeben wenn ein String übersetzt werden soll.
  117. </para>
  118. <sect2 id="zend.translate.using.structure">
  119. <title>Strukturen für Übersetzungdateien</title>
  120. <para>
  121. Der nächste Schritt besteht in der Erstellung der Übersetzungsdateien für die
  122. verschiedenen Sprachen welche übersetzt werden sollen. Jeder Adapter wird auf seine
  123. eigene Weise, wie hier beschrieben, erstellt aber es gibt ein paar generelle Features
  124. die für alle Adapter relevant sind.
  125. </para>
  126. <para>
  127. Zuerst muß entschieden werden wo die Übersetzung Dateien zu speichern sind. Bei der
  128. Verwendung von <classname>Zend_Translate</classname> gibt es keinerlei Einschränkungen. Aber die
  129. folgenden Strukturen bevorzugt verwendet werden:
  130. </para>
  131. <itemizedlist>
  132. <listitem>
  133. <para>
  134. Einzeln strukturierte Quellen
  135. </para>
  136. <programlisting><![CDATA[
  137. /application/
  138. /languages/
  139. /languages/lang.en
  140. /languages/lang.de
  141. /library/
  142. ]]></programlisting>
  143. <para>
  144. Positiv: Alle Quell Dateien, für jede Sprache, werden in einem einzelnen
  145. Verzeichnis gespeichert. Keine Aufteilung der betreffenden Dateien.
  146. </para>
  147. </listitem>
  148. <listitem>
  149. <para>
  150. Sprachlich stukturierte Quellen
  151. </para>
  152. <programlisting><![CDATA[
  153. /application/
  154. /languages/
  155. /languages/en/
  156. /languages/en/first.en
  157. /languages/en/second.en
  158. /languages/de/
  159. /languages/de/first.de
  160. /languages/de/second.de
  161. /library/
  162. ]]></programlisting>
  163. <para>
  164. Positiv: Jede Sprache wird in Ihrem eigenen Verzeichnis gespeichert. Einfache
  165. Übersetzung, da jedes Übersetzungsteam nur ein einzelnes Verzeichnis zu
  166. übersetzen hat. Und die Verwendung Verwendung von mehreren Dateien genauso
  167. transparent.
  168. </para>
  169. </listitem>
  170. <listitem>
  171. <para>
  172. Applikations strukturierte Quellen
  173. </para>
  174. <programlisting><![CDATA[
  175. /application/
  176. /application/languages/
  177. /application/languages/first.en
  178. /application/languages/first.de
  179. /application/languages/second.en
  180. /application/languages/second.de
  181. /library/
  182. ]]></programlisting>
  183. <para>
  184. Positiv: Alle Quelldateien, für jede Sprache, werden in einem einzelnen
  185. Verzeichnis gespeichert. Keine Aufteilung der betreffenden Dateien.
  186. </para>
  187. <para>
  188. Negativ: Die Benutzung von mehreren Datein für die selbe Sprache kann
  189. problematisch sein.
  190. </para>
  191. </listitem>
  192. <listitem>
  193. <para>
  194. Gettext strukturierte Quellen
  195. </para>
  196. <programlisting><![CDATA[
  197. /application/
  198. /languages/
  199. /languages/de/
  200. /languages/de/LC_MESSAGES/
  201. /languages/de/LC_MESSAGES/first.mo
  202. /languages/de/LC_MESSAGES/second.mo
  203. /languages/en/
  204. /languages/en/LC_MESSAGES/
  205. /languages/en/LC_MESSAGES/first.mo
  206. /languages/en/LC_MESSAGES/second.mo
  207. /library/
  208. ]]></programlisting>
  209. <para>
  210. Positiv: Bestehende Gettext Quellen können, ohne Veränderung der Struktur,
  211. benutzt werden.
  212. </para>
  213. <para>
  214. Negativ: Die Benutzung von Sub-Sub Verzeichnissen ist für Personen, die Gettext
  215. noch nie benutzt haben, verwirrend.
  216. </para>
  217. </listitem>
  218. <listitem>
  219. <para>
  220. Datei strukturierte Quellen
  221. </para>
  222. <programlisting><![CDATA[
  223. /application/
  224. /application/models/
  225. /application/models/MyModel.php
  226. /application/models/MyModel.de
  227. /application/models/MyModel.en
  228. /application/controllers/
  229. /application/controllers/MyController.php
  230. /application/controllers/MyController.de
  231. /application/controllers/MyController.en
  232. /library/
  233. ]]></programlisting>
  234. <para>
  235. Positiv: Übersetzungsdateien sind in der Nähr Ihrer Quelle zu finden.
  236. </para>
  237. <para>
  238. Negativ: Zu viele und auch kleine Übersetzungsdateien führen zu einer
  239. schwierigen und langwierigen Übersetzung. Es muß auch jede Datei als
  240. Übersetzungsquelle hinzugefügt werden.
  241. </para>
  242. </listitem>
  243. </itemizedlist>
  244. <para>
  245. Einzeln strukturierte und sprachlich strukturierte Quell Dateien sind
  246. für <classname>Zend_Translate</classname> am besten benutzbar.
  247. </para>
  248. <para>
  249. Also jetzt, da bekannt ist welche Struktur verwendet wird,
  250. müssen die einzelnen Übersetzungs Dateien erstellt werden.
  251. </para>
  252. </sect2>
  253. <sect2 id="zend.translate.using.source.array">
  254. <title>Erstellung von Array Quelldateien</title>
  255. <para>
  256. Array Quelldateien sind einfache Arrays. Sie müssen aber per Hand definiert werden, da
  257. es hierfür keine Tools gibt die helfen könnten. Weil Sie so einfach zu handhaben sind,
  258. ist Ihre Verwendung auch der schnellste Weg um zu testen ob Nachrichten innerhalb des
  259. Codes wie erwartet arbeiten. Er ist generell der beste Adapter um mit Mehrsprachigkeit
  260. zu beginnen wenn man keine diesbezüglichen Kenntnisse hat.
  261. </para>
  262. <programlisting role="php"><![CDATA[
  263. $english = array(
  264. 'message1' => 'message1',
  265. 'message2' => 'message2',
  266. 'message3' => 'message3');
  267. $german = array(
  268. 'message1' => 'Nachricht1',
  269. 'message2' => 'Nachricht2',
  270. 'message3' => 'Nachricht3');
  271. $translate = new Zend_Translate('array', $english, 'en');
  272. $translate->addTranslation($deutsch, 'de');
  273. ]]></programlisting>
  274. <para>
  275. Seit Release 1.5 wird es auch unterstützt, Arrays die in externen Dateien vorhanden
  276. sind einzubauen. Es ist der Dateiname anzugeben und <classname>Zend_Translate</classname> wird
  277. diesen automatisch einbauen und nach dem Array schauen. Siehe das folgende Beispiel
  278. für Details:
  279. </para>
  280. <programlisting role="php"><![CDATA[
  281. // myarray.php
  282. <?php
  283. return array(
  284. 'message1' => 'Nachricht1',
  285. 'message2' => 'Nachricht2',
  286. 'message3' => 'Nachricht3');
  287. // controller
  288. $translate = new Zend_Translate('array', '/path/to/myarray.php', 'de');
  289. ]]></programlisting>
  290. <note>
  291. <para>
  292. Bei Dateien die kein Array zurückgeben wird das inkludieren fehlschlagen. Auch
  293. jegliche Ausgabe innerhalb dieser Dateien wird ignoriert und unterdrückt.
  294. </para>
  295. </note>
  296. </sect2>
  297. <sect2 id="zend.translate.using.source.gettext">
  298. <title>Erstellung von Gettext Quellen</title>
  299. <para>
  300. Gettext Quellen werden durch GNU's Gettext Bibliothek erstellt. Es gibt einige
  301. kostenlose Tools welche den Code parsen können und hierbei die gewünschten Gettext
  302. Quellen erstellen. Diese haben die Endung <emphasis role="strong">*.mo</emphasis> und
  303. sind binäre Dateien. Ein Open Source Tool für die Erstellung der Quellen ist
  304. <ulink url="http://sourceforge.net/projects/poedit/">poEdit</ulink>. Dieses Tool
  305. unterstützt auch beim Übersetzungs-Prozesses selbst.
  306. </para>
  307. <programlisting role="php"><![CDATA[
  308. // Wir nehmen an das die mo Datien erstellt und übersetzt wurden
  309. $translate = new Zend_Translate('gettext', '/path/to/english.mo', 'en');
  310. $translate->addTranslation('/path/to/german.mo', 'de');
  311. ]]></programlisting>
  312. <para>
  313. Wie man sieht wird dieser Adapter auf exakt die gleiche Art und Weise verwendet mit
  314. einer kleinen Änderung: dem Wechsel von <emphasis role="strong">array</emphasis> zu
  315. <emphasis role="strong">gettext</emphasis>. Alle anderen Punkte werden in jedem anderen
  316. Adapter auf exakt die gleiche Weise verwendet. Mit diesem Gettext Adapter muß nicht
  317. mehr auf die geforderte Standard Verzeichnis Struktur von Gettext geachtet werden. Auch
  318. nicht auf bindtextdomain und textdomain. Nur der Pfad und der Dateiname muß dem Adapter
  319. übergeben werden.
  320. </para>
  321. <note>
  322. <para>
  323. Man sollte immer UTF-8 als Quell Encoding verwenden. Man könnte sonst Probleme
  324. bekommen wenn man zwei verschiedene Encodings verwendet. Wenn z.B. eine Quelldatei
  325. mit ISO-8815-11 und eine andere mit CP815 encoded ist. Man kann immer nur ein
  326. Encoding für alle Quell Dateien verwenden, und hierbei würde eine der gewünschten
  327. Sprachen nicht korrekt angezeigt werden.
  328. </para>
  329. <para>
  330. UTF-8 ist ein portables Format welches alle Sprachen unterstützt. Wenn UTF-8 für
  331. alle Sprachen verwendet wird, eliminiert man die Probleme mit inkompatiblen
  332. Encodings.
  333. </para>
  334. </note>
  335. <para>
  336. Viele Gettext Editoren fügen Informationen über den Adapter als Übersetzung eines
  337. leeren Strings hinzu. Das ist der Grund warum leere Strings nicht übersetzt werden wenn
  338. der Gettext Adapter verwendet wird. Stattdessen wird er von der Übersetzungstabelle
  339. gelöscht und von der <code>getAdapterInfo()</code> Methode angeboten. Sie gibt die
  340. Adapterinformationen für alle hinzugefügten Gettextdateien als Array zurück wobei der
  341. Dateiname als Schlüssel verwendet wird.
  342. </para>
  343. <programlisting role="php"><![CDATA[
  344. // Informationen des Adapters bekommen
  345. $translate = new Zend_Translate('gettext', '/path/to/english.mo', 'en');
  346. print_r($translate->getAdapterInfo());
  347. ]]></programlisting>
  348. </sect2>
  349. <sect2 id="zend.translate.using.source.tmx">
  350. <title>Erstellung von TMX Quellen</title>
  351. <para>
  352. TMX Quellen sind der neue Industrie Standard. Sie haben den Vorteil das sie XML Dateien
  353. sind und deswegen mit jedem Texteditor lesbar und natürlich auch von Menschen. Man kann
  354. TMX Dateien entweder per Hand erstellen oder man verwendet spezielle Tools dafür.
  355. Allerdings sind die meisten erhältlichen Tools die Erstellung von TMX Quellen nicht
  356. frei erhältlich.
  357. </para>
  358. <example id="zend.translate.using.source.tmx.example">
  359. <title>Beispiel einer TMX Datei</title>
  360. <programlisting role="xml"><![CDATA[
  361. <?xml version="1.0" ?>
  362. <!DOCTYPE tmx SYSTEM "tmx14.dtd">
  363. <tmx version="1.4">
  364. <header creationtoolversion="1.0.0" datatype="winres" segtype="sentence"
  365. adminlang="en-us" srclang="de-at" o-tmf="abc"
  366. creationtool="XYZTool" >
  367. </header>
  368. <body>
  369. <tu tuid='message1'>
  370. <tuv xml:lang="de"><seg>Nachricht1</seg></tuv>
  371. <tuv xml:lang="en"><seg>message1</seg></tuv>
  372. </tu>
  373. <tu tuid='message2'>
  374. <tuv xml:lang="en"><seg>message2</seg></tuv>
  375. <tuv xml:lang="de"><seg>Nachricht2</seg></tuv>
  376. </tu>
  377. ]]></programlisting>
  378. <programlisting role="php"><![CDATA[
  379. $translate = new Zend_Translate('tmx', 'path/to/mytranslation.tmx', 'en');
  380. ]]></programlisting>
  381. </example>
  382. <para>
  383. TMX Dateien können mehrere Sprachen in der selben Datei enthalten. Alle anderen in der
  384. Quelle enthaltenen Sprachen werden automatisch hinzugefügt und müssen nicht durch einen
  385. extra Aufruf von <code>addLanguage()</code> ergänzt werden.
  386. </para>
  387. <para>
  388. Wenn man nur spezielle Sprache aus der Quelle übersetzen will, kann die Option
  389. '<code>defined_language</code>' auf <code>true</code> gesetzt werden. Mit dieser
  390. Option können gewünschte Sprachen explizit mit <code>addLanguage()</code>
  391. hinzugefügt werden. Der Standardwert für diese Option fügt alle Sprachen hinzu.
  392. </para>
  393. </sect2>
  394. <sect2 id="zend.translate.using.source.csv">
  395. <title>Erstellung von CSV Quellen</title>
  396. <para>
  397. CSV Quellen sind sehr klein und von Menschen lesbar. Wenn ein Kunde selbst übersetzen
  398. will, ist die Verwendung des CSV Adapters warscheinlich die beste Wahl.
  399. </para>
  400. <example id="zend.translate.using.source.csv.example">
  401. <title>Beispiel CSV Datei</title>
  402. <programlisting><![CDATA[
  403. #Example csv file
  404. message1;Nachricht1
  405. message2;Nachricht2
  406. ]]></programlisting>
  407. <programlisting role="php"><![CDATA[
  408. $translate = new Zend_Translate('csv', '/path/to/mytranslation.csv', 'de');
  409. $translate->addTranslation('/path/to/other.csv', 'fr');
  410. ]]></programlisting>
  411. </example>
  412. <para>
  413. Es gibt drei verschiedene Optionen für den CSV Adapter. Es können
  414. '<code>delimiter</code>', '<code>limit</code>' und '<code>enclosure</code>' gesetzt
  415. werden.
  416. </para>
  417. <para>
  418. Das Standard Trennzeichen für CSV Strings ist '<code>;</code>, aber es muß nicht dieses
  419. Zeichen sein. Mit der Option '<code>delimiter</code>' kann ein anderes verwendet
  420. werden.
  421. </para>
  422. <para>
  423. Das Standardlimit für eine Zeile in einer CSV Datei ist '<code>0</code>'. Das bedeutet
  424. dass das Ende der CSV Zeile automatisch gesucht wird. Wenn '<code>limit</code>' auf
  425. irgendeinen Wert gesetzt wird, dann wird die CSV Datei schneller gelesen, aber jede
  426. Zeile die dieses Limit überschreitet wird abgeschnitten.
  427. </para>
  428. <para>
  429. Das standardmäßige Anführungszeichen für die Verwendung mit CSV Dateien ist
  430. '<code>"</code>'. Man kann ein anderes Setzen indem die Option '<code>enclosure</code>'
  431. verwendet wird.
  432. </para>
  433. <example id="zend.translate.using.source.csv.example2">
  434. <title>Zweites Beispiel für CSV Dateien</title>
  435. <programlisting><![CDATA[
  436. # Example CSV file
  437. "message,1",Nachricht1
  438. message2,"Nachricht,2"
  439. "message3,",Nachricht3
  440. ]]></programlisting>
  441. <programlisting role="php"><![CDATA[
  442. $translate = new Zend_Translate(
  443. 'csv',
  444. '/path/to/mytranslation.csv',
  445. 'de',
  446. array('delimiter' => ','));
  447. $translate->addTranslation('/path/to/other.csv', 'fr');
  448. ]]></programlisting>
  449. </example>
  450. </sect2>
  451. <sect2 id="zend.translate.using.source.ini">
  452. <title>Erstellung von INI Quelldateien</title>
  453. <para>
  454. INI Quelldateien sind menschlich lesbar aber normalerweise nicht sehr klein da Sie
  455. neben der Übersetzung auch andere Daten enthalten. Wenn Sie Daten haben die von
  456. Ihrem Kunden zu bearbeitet sind, verwenden Sie den INI Adapter.
  457. </para>
  458. <example id="zend.translate.using.source.ini.example">
  459. <title>Beispiel einer INI Datei</title>
  460. <programlisting><![CDATA[
  461. [Test]
  462. ;TestPage Comment
  463. Message_1="Nachricht 1 (de)"
  464. Message_2="Nachricht 2 (de)"
  465. Message_3="Nachricht :3 (de)"
  466. ]]></programlisting>
  467. <programlisting role="php"><![CDATA[
  468. $translate = new Zend_Translate('ini', '/path/to/mytranslation.ini', 'de');
  469. $translate->addTranslation('/path/to/other.ini', 'it');
  470. ]]></programlisting>
  471. </example>
  472. <para>
  473. INI Dateien haben diverse Einschränkungen. Wenn ein Wert in einer INI Datei irgendein
  474. nicht alphanummerisches Zeichen enthält, muß er in doppelte Anführungszeichen
  475. (<code>"</code>) eingeklammert werden. Es gibt auch reservierte Wörter welche nicht als
  476. Schlüssel für INI Dateien verwendet werden dürfen. Diese enthalten: <code>null</code>,
  477. <code>yes</code>, <code>no</code>, <code>true</code> und <code>false</code>. Die Werte
  478. <code>null</code>, <code>no</code> und <code>false</code> führen zu <code>""</code>,
  479. <code>yes</code> und <code>true</code> resultieren in <code>1</code>. Die Zeichen
  480. <code>{}|&amp;~![()"</code> dürfen nirgendwo im Schlüssel verwendet werden und haben im
  481. Wert eine spezielle Bedeutung. Diese sollten nicht verwendet werden da Sie zu
  482. unerwartetem Verhalten führen.
  483. </para>
  484. </sect2>
  485. <sect2 id="zend.translate.using.options">
  486. <title>Optionen für Adapter</title>
  487. <para>
  488. Optionen können bei allen Adaptoren verwendet werden. Natürlich sind die Optionen für
  489. alle Adaptoren verschieden. Die Optionen können bei Erstellung des Objekts miterstellt
  490. werden. Zur Zeit gibt es nur eine Option die für alle Adaptoren verfügbar ist:
  491. '<code>clear</code>' setzt, ob die neuen Übersetzungsdaten zu den bestehenden
  492. hinzugefügt werden sollen oder ob Sie diese überschreiben. Das Standardverhalten ist
  493. das Hinzufügen von neuen Übersetzungsdaten zu den Bestehenden. Aber das wird immer nur
  494. für die aktuelle Sprache gemacht. Anderen Sprachen bleiben davon unberührt.
  495. </para>
  496. <para>
  497. Man kann Optionen temporär setzen indem man die Funktion
  498. <code>addTranslation($data, $locale, array $options = array())</code> als dritten und
  499. optionalen Parameter benutzt. Ausserdem kann die Methode <code>setOptions()</code>
  500. benutzt werden um Optionen permanent zu setzen.
  501. </para>
  502. <example id="zend.translate.using.options.example">
  503. <title>Benutzen von Übersetzungsoptionen</title>
  504. <programlisting role="php"><![CDATA[
  505. // Definiere ':' als Trenner für die Quelldatei der Übersetzung
  506. $options = array('delimiter' => ':');
  507. $translate = new Zend_Translate(
  508. 'csv',
  509. '/path/to/mytranslation.csv',
  510. 'de',
  511. $options);
  512. ...
  513. // Lösche die definierte Sprache und verwende die neuen Übersetzungsdaten
  514. $options = array('clear' => true);
  515. $translate->addTranslation('/path/to/new.csv', 'fr', $options);
  516. ]]></programlisting>
  517. </example>
  518. <para>
  519. Hier können alle vorhandenen Optionen für die verschiedenen Adapter gefunden werden mit einer
  520. Beschreibung Ihrer Verwendung:
  521. </para>
  522. <table id="zend.translate.using.options.alloptions">
  523. <title>Optionen für Übersetzungs-Adapter</title>
  524. <tgroup cols="4">
  525. <thead>
  526. <row>
  527. <entry>Option</entry>
  528. <entry>Adapter</entry>
  529. <entry>Beschreibung</entry>
  530. <entry>Standardwert</entry>
  531. </row>
  532. </thead>
  533. <tbody>
  534. <row>
  535. <entry>clear</entry>
  536. <entry>all</entry>
  537. <entry>
  538. Wenn true gesetzt wird, werden bereits gelesene Übersetzungen entfernt.
  539. Das kann statt dem Erstellen einer neuen Instanz verwendet werden wenn
  540. neue Übersetzungsdaten gelesen werden
  541. </entry>
  542. <entry><emphasis role="strong">false</emphasis></entry>
  543. </row>
  544. <row>
  545. <entry>disableNotices</entry>
  546. <entry>all</entry>
  547. <entry>
  548. Wenn es auf true gesetzt wird, werden alle Notizen betreffend nicht
  549. vorhandenen Übersetzungen ausgeschaltet. Man sollte diese Option in
  550. einer Produktionsumgebung auf true setzen
  551. </entry>
  552. <entry><emphasis role="strong">false</emphasis></entry>
  553. </row>
  554. <row>
  555. <entry>ignore</entry>
  556. <entry>all</entry>
  557. <entry>
  558. Alle Verzeichnisse und Dateien die mit diesem Präfix beginnen werden
  559. bei der Suche nach Dateien ignoriert. Der Standardwert ist
  560. <emphasis role="strong">'.'</emphasis> was zu dem Verhalten führt das
  561. alle versteckten Dateien ignoriert werden. Wenn dieser Wert auf
  562. <code>'tmp'</code> gesetzt wird, bedeutet das, Verzeichnisse und
  563. Dateien wie z.B. <code>'tmpImages'</code> und <code>'tmpFiles'</code>,
  564. sowie alle darunter liegenden Verzeichnisse, werden ignoriert.
  565. </entry>
  566. <entry><emphasis role="strong">.</emphasis></entry>
  567. </row>
  568. <row>
  569. <entry>log</entry>
  570. <entry>all</entry>
  571. <entry>
  572. Eine Instanz von <classname>Zend_Log</classname> wohin nicht übersetzbare Meldungen und
  573. Notizen geschrieben werden
  574. </entry>
  575. <entry><emphasis role="strong">null</emphasis></entry>
  576. </row>
  577. <row>
  578. <entry>logMessage</entry>
  579. <entry>all</entry>
  580. <entry>
  581. Die Nachricht die in das Log geschrieben werden soll
  582. </entry>
  583. <entry><emphasis role="strong">Untranslated message within '%locale%': %message%</emphasis></entry>
  584. </row>
  585. <row>
  586. <entry>logUntranslated</entry>
  587. <entry>all</entry>
  588. <entry>
  589. Wenn diese Option auf true gesetzt wird, werden alle Nachrichten Id's
  590. die nicht übersetzt werden können in das angehängte Log geschrieben
  591. </entry>
  592. <entry><emphasis role="strong">false</emphasis></entry>
  593. </row>
  594. <row>
  595. <entry>scan</entry>
  596. <entry>all</entry>
  597. <entry>
  598. Wenn null gesetzt wird, wird die Verzechnisstruktur nicht gescannt.
  599. Wenn <classname>Zend_Translate::LOCALE_DIRECTORY</classname> gesetzt wird, wird
  600. das Gebietsschema im Verzeichnis gesucht. Wenn
  601. <classname>Zend_Translate::LOCALE_FILENAME</classname> gesetzt wird, wird das
  602. Gebietsschema im Dateinamen gesucht. Siehe
  603. <xref linkend="zend.translate.using.detection" /> für Details
  604. </entry>
  605. <entry><emphasis role="strong">null</emphasis></entry>
  606. </row>
  607. <row>
  608. <entry>delimiter</entry>
  609. <entry>Csv</entry>
  610. <entry>Definiert welches Zeichen als Trenner für Quelle und Übersetzung verwendet wird</entry>
  611. <entry><emphasis role="strong">;</emphasis></entry>
  612. </row>
  613. <row>
  614. <entry>length</entry>
  615. <entry>Csv</entry>
  616. <entry>Definiert die maximale Länge einer CSV Zeile. Auf 0 gesetzt wird sie automatisch erkannt</entry>
  617. <entry><emphasis role="strong">0</emphasis></entry>
  618. </row>
  619. <row>
  620. <entry>enclosure</entry>
  621. <entry>Csv</entry>
  622. <entry>Definiert das zu verwendende Einschließungszeichen. Standard ist das doppelte Hochkomma</entry>
  623. <entry><emphasis role="strong">"</emphasis></entry>
  624. </row>
  625. </tbody>
  626. </tgroup>
  627. </table>
  628. <para>
  629. Wenn man selbstdefinierte Optionen haben will, können diese auch in allen Adaptern
  630. verwendet werden. Die <code>setOptions()</code> Methode kann verwendet werden um die
  631. eigene Option zu definieren. <code>setOptions()</code> benötigt ein Array mit den
  632. Optionen die gesetzt werden sollen. Wenn eine angegebene Option bereits existiert wird
  633. diese überschrieben. Es können beliebig viele Optionen definiert werden da diese nicht
  634. vom Adapter geprüft werden. Man muß nur Sicherstellen das keine existierende Option
  635. überschrieben werden die von einem Adapter verwendet wird.
  636. </para>
  637. <para>
  638. Um die Option zurückzugeben kann die Methode <code>getOptions()</code> verwendet
  639. werden. Wenn <code>getOptions()</code> ohne einen Parameter aufgerufen wird, gibt Sie
  640. alle Optionen zurück. Wenn der optionale Parameter angegeben wird, wird nur die
  641. spezifizierte Option zurückgegeben.
  642. </para>
  643. </sect2>
  644. <sect2 id="zend.translate.using.languages">
  645. <title>Mit Sprachen arbeiten</title>
  646. <para>
  647. Wenn mit verschiedenen Sprachen gearbeitet wird gibt es ein paar Methoden die nützlich
  648. sind.
  649. </para>
  650. <para>
  651. Die <code>getLocale()</code> Methode kann verwendet werden um die aktuell gesetzte
  652. Sprache zu erhalten. Sie kann entweder eine Instanz von <classname>Zend_Locale</classname> oder
  653. den Bezeichner des Gebietsschemas enthalten.
  654. </para>
  655. <para>
  656. Die <code>setLocale()</code> Methode setzt eine neue Standardsprache für Übersetzungen.
  657. Das verhindert das der optionale Sprachparameter der <code>translate()</code> Methode
  658. mehr als einmal gesetzt werden muß. Wenn die angegebene Sprache nicht existiert, oder
  659. keine Übersetzten Daten für diese Sprache vorhanden sind, versucht
  660. <code>setLocale()</code> auf die Sprache ohne Region downzugraden wenn diese angegeben
  661. wurde. Die Sprache <code>en_US</code> würde zum Beispiel zu <code>en</code>
  662. downgegradet werden. Wenn sogar nach dem Downgraden die Sprache nicht gefunden werden
  663. konnte, wird eine Ausnahme geworfen.
  664. </para>
  665. <para>
  666. Die <code>isAvailable()</code> Methode prüft ob eine angegebene Sprache bereits
  667. vorhanden ist. Es wird <code>true</code> zurückgegeben wenn Daten für die angegebene
  668. Sprache existieren.
  669. </para>
  670. <para>
  671. Und letztendlich kann die <code>getList()</code> Methode verwendet werden um alle
  672. aktuell gesetzten Sprachen für einen Adapter als Array zu erhalten.
  673. </para>
  674. <example id="zend.translate.using.languages.example">
  675. <title>Handhabung von Sprachen mit Adaptern</title>
  676. <programlisting role="php"><![CDATA[
  677. // gibt die aktuell gesetzte Sprache zurück
  678. $actual = $translate->getLocale();
  679. // der optionale Parameter kann wärend der Übersetzung verwendet werden
  680. echo $translate->_("mein_Text", "fr");
  681. // oder setze eine neue Standardsprache
  682. $translate->setLocale("fr");
  683. echo $translate->_("mein_Text");
  684. // zur Basissprache referieren
  685. // fr_CH wird zu fr downgegradet
  686. $translate->setLocale("fr_CH");
  687. echo $translate->_("mein_Text");
  688. // Prüft ob die Sprache existiert
  689. if ($translate->isAvailable("fr")) {
  690. // Sprache existiert
  691. }
  692. ]]></programlisting>
  693. </example>
  694. <sect3 id="zend.translate.using.languages.automatic">
  695. <title>Automatische Handhabung von Sprachen</title>
  696. <para>
  697. Es gilt zu beachten das, solange man neue Sprachquellen mit der
  698. <code>addTranslation()</code> Methode hinzufügt, <classname>Zend_Translate</classname>
  699. automatisch die am besten passende Sprache für die eigene Umgebung auswählt wenn
  700. man eine der automatischen Gebietsschemata verwendet die '<code>auto</code>' oder
  701. '<code>browser</code>' sein können. Man muß normalerweise also
  702. <code>setLocale()</code> nicht aufrufen. Das sollte nur in Verbindung mit der
  703. automatischen Erkennung von Quellen verwendet werden.
  704. </para>
  705. <para>
  706. Der Algorithmus sucht nach dem am besten passenden Gebietsschema abhängig vom
  707. Browser des Benutzers und der eigenen Umgebung. Siehe das folgende Beispiel für
  708. Details:
  709. </para>
  710. <example id="zend.translate.using.languages.automatic.example">
  711. <title>Automatische Erkennen der Sprache</title>
  712. <programlisting role="php"><![CDATA[
  713. // Angenommen der Browser gibt folgende Spracheneinstellungen zurück:
  714. // HTTP_ACCEPT_LANGUAGE = "de_AT=1;fr=1;en_US=0.8";
  715. // Beispiel 1:
  716. // Wenn keine passende Sprache gefunden wird, wird die MessageID zurückgegeben
  717. $translate = new Zend_Translate(
  718. 'gettext',
  719. '\my_it.mo',
  720. 'auto',
  721. array('scan' => Zend_Translate::LOCALE_FILENAME));
  722. // Beispiel 2:
  723. // Die am besten passende Sprache ist 'fr'
  724. $translate = new Zend_Translate(
  725. 'gettext',
  726. '\my_fr.mo',
  727. 'auto',
  728. array('scan' => Zend_Translate::LOCALE_FILENAME));
  729. // Beispiel 3:
  730. // Die am besten passende Sprache ist 'de' ('de_AT' wird degradiert)
  731. $translate = new Zend_Translate(
  732. 'gettext',
  733. '\my_de.mo',
  734. 'auto',
  735. array('scan' => Zend_Translate::LOCALE_FILENAME));
  736. // Beispiel 4:
  737. // Gibt 'it' als Übersetzungsquelle zurück und überschreibt
  738. // die automatischen Eigenschaften
  739. $translate = new Zend_Translate(
  740. 'gettext',
  741. '\my_it.mo',
  742. 'auto',
  743. array('scan' => Zend_Translate::LOCALE_FILENAME)
  744. );
  745. $translate->addTranslation('\my_ru.mo', 'ru');
  746. $translate->setLocale('it_IT');
  747. ]]></programlisting>
  748. </example>
  749. <para>
  750. Nachdem eine Sprache per Hand mit der <code>setLocale()</code> Methode gesetzt
  751. wurde, wird die automatische Erkennung ausgeschaltet und übergangen.
  752. </para>
  753. <para>
  754. Wenn man Sie wieder verwenden will, kann die Sprache
  755. <emphasis role="strong">auto</emphasis> mit <code>setLocale()</code> gesetzt
  756. werden, was die automatische Erkennung für <classname>Zend_Translate</classname> wieder
  757. reaktiviert.
  758. </para>
  759. <para>
  760. Seit dem Zend Framework 1.7.0 unterstützt <classname>Zend_Translate</classname> auch die
  761. Verwendung eines Anwendungsweiten Gebietsschemas. Man kann einfach eine
  762. <classname>Zend_Locale</classname> Instanz in der Registry setzen wie unten gezeigt. Mit
  763. dieser Schreibweise kann man das manuelle Setzen eines Gebietsschemas mit jeder
  764. Instanz komplett vergessen wenn man das gleiche Gebietsschema mehrere Male
  765. verwenden will.
  766. </para>
  767. <programlisting role="php"><![CDATA[
  768. // In der Bootstrap Datei
  769. $locale = new Zend_Locale();
  770. Zend_Registry::set('Zend_Locale', $locale);
  771. // Standardsprache wenn die angefragte Sprache nicht vorhanden ist
  772. $defaultlanguage = 'en';
  773. // Irgendwo in der Anwendung
  774. $translate = new Zend_Translate('gettext', 'my_de.mo');
  775. if (!$translate->isAvailable($locale->getLanguage())) {
  776. // Nicht vorhandene Sprache werden auf eine andere Sprache geroutet
  777. $translate->setLocale($defaultlanguage);
  778. }
  779. $translate->getLocale();
  780. ]]></programlisting>
  781. </sect3>
  782. </sect2>
  783. <sect2 id="zend.translate.using.detection">
  784. <title>Automatische Erkennung von Quellen</title>
  785. <para>
  786. <classname>Zend_Translate</classname> kann Übersetzungsquellen automatisch erkennen. Es muß also
  787. nicht jede Quelldatei manuell deklariert werden. Man kann diesen Job
  788. <classname>Zend_Translate</classname> überlassen welches die komplette Verzeichnisstruktur nach
  789. Quelldateien durchsucht.
  790. </para>
  791. <note>
  792. <para>
  793. Automatische Erkennung der Quellen ist seit Zend Framework Version 1.5 vorhanden.
  794. </para>
  795. </note>
  796. <para>
  797. Die Verwendung ist fast die selbe wie bei der Initiierung einer einzelnen
  798. Übersetzungsquelle mit einem Unterschied. Es darf nur ein Verzeichnis angegeben werden,
  799. statt einer Datei, welches gescannt werden soll.
  800. </para>
  801. <example id="zend.translate.using.languages.directory.example">
  802. <title>Scannen nach Quellen in einer Verzeichnisstruktur</title>
  803. <programlisting role="php"><![CDATA[
  804. // Angenommen wir haben die folgende Struktur
  805. // /language/
  806. // /language/login/login.tmx
  807. // /language/logout/logout.tmx
  808. // /language/error/loginerror.tmx
  809. // /language/error/logouterror.tmx
  810. $translate = new Zend_Translate('tmx', '/language');
  811. ]]></programlisting>
  812. </example>
  813. <para>
  814. <classname>Zend_Translate</classname> muß also nicht nur das angegebene Verzeichnis durchsuchen,
  815. sondern auch alle Unterverzeichnisse nach Dateien für Übersetzungen. Das macht die
  816. Verwendung sehr einfach. Aber <classname>Zend_Translate</classname> wird alle Dateien ignorieren,
  817. welche keine Quellen sind, oder wärend des Einlesens der Übersetzungsdaten Fehler
  818. produzieren. Man sollte also sicherstellen das alle Übersetzungsquellen korrekt sind
  819. und gelesen werden können weil man keinen Fehler erhält wenn eine Datei fehlerhaft ist
  820. oder nicht gelesen werden kann.
  821. </para>
  822. <note>
  823. <para>
  824. Abhängig davon wie tief die Verzeichnisstruktur ist und wieviele Dateien innerhalb
  825. dieser Struktur vorhanden sind, kann es eine sehr lange Zeit dauern bis
  826. <classname>Zend_Translate</classname> fertig ist.
  827. </para>
  828. </note>
  829. <para>
  830. In unserem Beispiel haben wir das TMX Format verwendet welches die Sprache enthält die
  831. innerhalb der Quelle verwendet wird. Aber viele der anderen Quellformate sind nicht
  832. dazu fähig die Sprache in der Datei selbst zu inkludieren. Aber auch diese quellen
  833. können mit der automatischen Erkennung verwendet werden wenn ein paar Dinge
  834. berücksichtigt werden die anbei beschrieben sind:
  835. </para>
  836. <sect3 id="zend.translate.using.detection.directory">
  837. <title>Sprachen durch die Benennung von Verzeichnissen</title>
  838. <para>
  839. Ein Weg, die automatische Spracherkennung zu inkludieren, ist es die Verzeichnisse
  840. relativ zur Sprache zu benennen, welche in den Quellen des betreffenden
  841. Verzeichnisses verwendet wird. Das ist der einfachste Weg und wird zum Beispiel in
  842. Standard Gettext Implementationen verwendet.
  843. </para>
  844. <para>
  845. <classname>Zend_Translate</classname> benötigt die '<code>scan</code>' Option um zu wissen
  846. das es die Namen aller Verzeichnisse nach Sprachen durchsuchen soll. Siehe das
  847. folgende Beispiel für Details:
  848. </para>
  849. <example id="zend.translate.using.detection.directory.example">
  850. <title>Verzeichnisse nach Sprachen durchsuchen</title>
  851. <programlisting role="php"><![CDATA[
  852. // Angenommen wir haben die folgende Struktur
  853. // /language/
  854. // /language/de/login/login.mo
  855. // /language/de/error/loginerror.mo
  856. // /language/en/login/login.mo
  857. // /language/en/error/loginerror.mo
  858. $translate = new Zend_Translate(
  859. 'gettext',
  860. '/language',
  861. null,
  862. array('scan' => Zend_Translate::LOCALE_DIRECTORY));
  863. ]]></programlisting>
  864. </example>
  865. <note>
  866. <para>
  867. Das funktioniert nur für Adapter die die Sprache nicht in der Quelldatei
  868. enthalten. Die Verwendung dieser Option wird zum Beispiel mit TMX ignoriert.
  869. Sprachdefinitionen im Dateinamen werden bei der Verwendung dieser Option
  870. ignoriert.
  871. </para>
  872. </note>
  873. <note>
  874. <para>
  875. Man sollte acht geben wenn man verschiedenen Unterverzeichnisse in der gleichen
  876. Struktur hat. Angenommen wir haben eine Struktur wie
  877. <code>/language/module/de/en/file.mo</code>. In diesem Fall enthält der Pfad
  878. mehrere Strings die als Gebietsschema erkannt werden würden. Das könnte
  879. entweder <code>de</code> oder <code>en</code> sein. In solch einem Fall ist das
  880. Verhalten nicht definiert und es wird empfohlen die Dateierkennung zu
  881. verwenden.
  882. </para>
  883. </note>
  884. </sect3>
  885. <sect3 id="zend.translate.using.detection.filename">
  886. <title>Sprache durch Dateinamen</title>
  887. <para>
  888. Ein anderer Weg um die Sprache automatisch zu erkennen ist die Verwendung von
  889. speziellen Dateienamen. Man kann entweder die komplette Datei oder Teile der
  890. Datei nach der verwendeten Sprache benennen. Um diese Option zu Verwenden muß die
  891. '<code>scan</code>' Option bei der Initiierung gesetzt werden. Es gibt verschiedene
  892. Wege die Quelldateien zu benennen welche im folgenden beschrieben werden:
  893. </para>
  894. <example id="zend.translate.using.detection.filename.example">
  895. <title>Suchen nach Sprachen im Dateinamen</title>
  896. <programlisting role="php"><![CDATA[
  897. // Angenommen wir haben die folgende Struktur
  898. // /language/
  899. // /language/login/login_en.mo
  900. // /language/login/login_de.mo
  901. // /language/error/loginerror_en.mo
  902. // /language/error/loginerror_de.mo
  903. $translate = new Zend_Translate(
  904. 'gettext',
  905. '/language',
  906. null,
  907. array('scan' => Zend_Translate::LOCALE_FILENAME));
  908. ]]></programlisting>
  909. </example>
  910. <sect4 id="zend.translate.using.detection.filename.complete">
  911. <title>Komplette Dateinamen</title>
  912. <para>
  913. Die komplette Datei nach der Sprache zu benennen ist der einfachste Weg, aber
  914. nur praktikabel wenn man nur eine Datei pro Verzeichnis verwendet.
  915. </para>
  916. <programlisting><![CDATA[
  917. /languages/
  918. /languages/en.mo
  919. /languages/de.mo
  920. /languages/es.mo
  921. ]]></programlisting>
  922. </sect4>
  923. <sect4 id="zend.translate.using.detection.filename.extension">
  924. <title>Erweiterung der Datei</title>
  925. <para>
  926. Ein anderer einfacher Weg ist die Verwendung der Dateiextension für die
  927. Spracherkennung. Aber das kann verwirrend sein weil man keine Idee mehr hat
  928. welche Erweiterung die Datei ursprünglich hatte.
  929. </para>
  930. <programlisting><![CDATA[
  931. /languages/
  932. /languages/view.en
  933. /languages/view.de
  934. /languages/view.es
  935. ]]></programlisting>
  936. </sect4>
  937. <sect4 id="zend.translate.using.detection.filename.token">
  938. <title>Teile von Dateinamen</title>
  939. <para>
  940. <classname>Zend_Translate</classname> kann die Sprache auch erkennen wenn Sie im Dateinamen enthalten
  941. ist. Aber wenn man diesen Weg nimmt, muß die Sprache mit einem Trennzeichen
  942. seperiert werden. Es gibt drei unterstützte Trennzeichen welche verwendet
  943. werden können. Ein Punkt '.', ein Unterstrich '_', oder ein Bindestrich '-'.
  944. </para>
  945. <programlisting><![CDATA[
  946. /languages/
  947. /languages/view_en.mo -> erkennt englisch
  948. /languages/view_de.mo -> erkennt deutsch
  949. /languages/view_it.mo -> erkennt italienisch
  950. ]]></programlisting>
  951. <para>
  952. Das erste gefundene String der von einem Trennzeichen getrennt wird das als
  953. Gebietsschema interpretiert werden kann, wird verwendet. Siehe das folgende
  954. Beispiel für Details.
  955. </para>
  956. <programlisting><![CDATA[
  957. /languages/
  958. /languages/view_en_de.mo -> erkennt englisch
  959. /languages/view_en_es.mo -> erkennt englisch und überschreibt die erste Datei
  960. /languages/view_it_it.mo -> erkennt italienisch
  961. ]]></programlisting>
  962. <para>
  963. Alle drei Trennzeichen werden verwendet um das Gebietsschema zu erkennen. Wenn
  964. der Dateiname mehrere Trennzeichen enthält, hängt das erste gefundene
  965. Trennzeichen von der Reihenfolge der Trennzeichen ab die verwendet werden.
  966. Siehe das folgende Beispiel für Details.
  967. </para>
  968. <programlisting><![CDATA[
  969. /languages/
  970. /languages/view_en-it.mo -> erkennt englisch weil '_' vor '-' verwendet wird
  971. /languages/view-en_it.mo -> erkennt italienisch weil '_' vor '-' verwendet wird
  972. /languages/view_en.it.mo -> erkennt italienisch weil '.' vor '_' verwendet wird
  973. ]]></programlisting>
  974. </sect4>
  975. </sect3>
  976. </sect2>
  977. <sect2 id="zend.translate.using.istranslated">
  978. <title>Prüfen von Übersetzungen</title>
  979. <para>
  980. Normalerweise wird Text ohne Berechnungen übersetzt. Aber manchmal ist es notwendig
  981. zu wissen, ob ein Text in der Quelle übersetzt ist oder nicht, und hierfür kann die
  982. Methode <code>isTranslated()</code> verwendet werden.
  983. </para>
  984. <para>
  985. <code>isTranslated($messageId, $original = false, $locale = null)</code> nimmt den Text
  986. bzw die Id von der man wissen will ob sie Übersetzbar ist, als ersten Parameter, und
  987. als optionalen dritten Parameter das Gebietsschema für das man die Prüfung durchführen
  988. will. Der optionale zweite Parameter definiert ob die Übersetzung fix für die
  989. definierte Sprache ist oder ob ein kleineres Set von Übersetzungen verwendet werden
  990. kann. Wenn ein Text, welcher für 'en' zurückgegeben werden kann, aber nicht für
  991. 'en_US', dann wird die Übersetzung normalerweise zurückgegeben, aber wenn
  992. <code>$original</code> auf true gesetzt ist, gibt die <code>isTranslated()</code>
  993. Methode in solche Fällen false zurück.
  994. </para>
  995. <example id="zend.translate.using.istranslated.example">
  996. <title>Prüfen ob ein Text übersetzbar ist</title>
  997. <programlisting role="php"><![CDATA[
  998. $english = array(
  999. 'message1' => 'Nachricht 1',
  1000. 'message2' => 'Nachricht 2',
  1001. 'message3' => 'Nachricht 3');
  1002. $translate = new Zend_Translate('array', $english, 'de_AT');
  1003. if ($translate->isTranslated('message1')) {
  1004. print "'message1' kann übersetzt werden";
  1005. }
  1006. if (!($translate->isTranslated('message1', true, 'de'))) {
  1007. print "'message1' kann nicht in 'de' übersetzt werden da es "
  1008. . "nur in 'de_AT' vorhanden ist";
  1009. }
  1010. if ($translate->isTranslated('message1', false, 'de')) {
  1011. print "'message1' kann in 'de_AT' übersetzt werden " .
  1012. "da es zu 'de' zurückfällt";
  1013. }
  1014. ]]></programlisting>
  1015. </example>
  1016. </sect2>
  1017. <sect2 id="zend.translate.using.logging">
  1018. <title>Wie können nicht gefundene Übersetzungen geloggt werden</title>
  1019. <para>
  1020. Wenn man eine größere Site hat, oder man die Übersetzungsdateien manuell erstellt hat man oft
  1021. das Problem das einige Meldungen nicht übersetzt werden. Aber es gibt eine einfache Lösung wenn
  1022. man <classname>Zend_Translate</classname> verwendet.
  1023. </para>
  1024. <para>
  1025. Man muß den folgenden zwei oder drei einfachen Schritten folgen. Erstens, muß man eine Instanz von
  1026. <classname>Zend_Log</classname> erstellen. Und dann muß man diese Instanz an <classname>Zend_Translate</classname>
  1027. übergeben. Siehe das folgende Beispiel:
  1028. </para>
  1029. <example id="zend.translate.using.logging.example">
  1030. <title>Übersetzungen loggen</title>
  1031. <programlisting role="php"><![CDATA[
  1032. $translate = new Zend_Translate('gettext', $path, 'de');
  1033. // Eine Log Instanz erstellen
  1034. $writer = new Zend_Log_Writer_Stream('/path/to/file.log');
  1035. $log = new Zend_Log($writer);
  1036. // Diese der Übersetzungs-Instanz hinzufügen
  1037. $translate->setOptions(array(
  1038. 'log' => $log,
  1039. 'logUntranslated' => true));
  1040. $translate->translate('unbekannter String');
  1041. ]]></programlisting>
  1042. </example>
  1043. <para>
  1044. Jetzt steht im Log eine neue Notiz:
  1045. <code>Untranslated message within 'de': unbekannter String</code>.
  1046. </para>
  1047. <note>
  1048. <para>
  1049. Man sollte beachten das jede Übersetzung die nicht gefunden wird mitgeloggt wird.
  1050. Das bedeutet alle Übersetzungen wenn ein Benutzer eine nicht unterstützte Sprache
  1051. anfragt. Aber auch jede Anfrage für eine Nachricht die nicht übersetzt werden kann
  1052. wird mitgeloggt. Es ist zu beachten das, 100 Personen die die gleiche Übersetzung
  1053. anfragen, auch zu 100 geloggten Notizen führen.
  1054. </para>
  1055. </note>
  1056. <para>
  1057. Dieses Feature kann nicht nur verwendet werden um Nachrichten zu Loggen sondern auch um
  1058. diese nicht übersetzen Nachrichten in eine leere Übersetzungsdatei zu schreiben. Um das
  1059. zu ermöglichen muß man seinen eigenen Log Writer erstellen der das Format schreibt das
  1060. man haben will und das führende "Untranslated message" herausschneidet.
  1061. </para>
  1062. <para>
  1063. Wenn man seine eigene Logmeldung haben will, kann man auch die Option
  1064. '<code>logMessage</code>' setzen. Das '<code>%message%</code>' Token ist für die
  1065. Platzierung der messageId in der eigenen Logmeldung zu verwenden, und das
  1066. '<code>%locale%</code>' Token für das angefragte Gebietsschema. Siehe das folgende
  1067. Beispiel für ein Beispiel einer selbst definierten Logmeldung:
  1068. </para>
  1069. <example id="zend.translate.using.logging.example2">
  1070. <title>Selbstdefinierte Logmeldungen</title>
  1071. <programlisting role="php"><![CDATA[
  1072. $translate = new Zend_Translate('gettext', $path, 'de');
  1073. // Eine Loginstanz erstellen
  1074. $writer = new Zend_Log_Writer_Stream('/path/to/file.log');
  1075. $log = new Zend_Log($writer);
  1076. // Diese der Übersetzungsinstanz hinzufügen
  1077. $translate->setOptions(array(
  1078. 'log' => $log,
  1079. 'logMessage' => "Fehlende '%message%' im Gebietsschema '%locale%'",
  1080. 'logUntranslated' => true));
  1081. $translate->translate('unknown string');
  1082. ]]></programlisting>
  1083. </example>
  1084. </sect2>
  1085. <sect2 id="zend.translate.using.sourcedata">
  1086. <title>Zugang zu Quelldaten</title>
  1087. <para>
  1088. Manchmal ist es nützlich, Zugang zu den übersetzten Quelldaten zu erhalten. Hierfür
  1089. werden die folgenden zwei Methoden angeboten.
  1090. </para>
  1091. <para>
  1092. Die <code>getMessageIds($locale = null)</code> Methode gibt alle bekannten Ids für
  1093. Übersetzungen als Array zurück.
  1094. </para>
  1095. <para>
  1096. Die <code>getMessages($locale = null)</code> Methode gibt die komplette
  1097. Übersetzungs-Quelle als Array zurück. Die Ids der Übersetzungen werden als Schlüssel
  1098. und die Übersetzten Daten als Wert verwendet.
  1099. </para>
  1100. <para>
  1101. Beide Methoden akzeptieren einen optionalen Parameter <code>$locale</code> welcher,
  1102. wenn er gesetzt wird, die Übersetzungsdaten für die spezifizierte Sprache, zurückgibt.
  1103. Wenn dieser Parameter nicht angegeben wird, wird die aktuell gesetzte Sprache
  1104. verwendet. Es ist zu beachten das normalerweise alle Übersetzungen in allen Sprachen
  1105. vorhanden sein sollten. Das bedeutet das man in einer normalen Situation diesen
  1106. Parameter nicht angeben muß.
  1107. </para>
  1108. <para>
  1109. Zusätzlich kann die <code>getMessages()</code> Methode verwendet werden um das
  1110. komplette Übersetzungsverzeichnis, mit dem Pseudo-Gebietsschema 'all', zurückgeben.
  1111. Das gibt alle vorhandenen Übersetzungsdaten für jedes hinzugefügte Gebietsschema
  1112. zurück.
  1113. </para>
  1114. <note>
  1115. <para>
  1116. Achtung: Das zurückgegebene Array kann
  1117. <emphasis role="strong">sehr groß</emphasis> sein, abhängig von der Anzahl an
  1118. hinzugefügten Gebietsschemata und der Anzahl an Übersetzungsdaten.
  1119. </para>
  1120. </note>
  1121. <example id="zend.translate.using.sourcedata.example">
  1122. <title>Handhabung von Quelldaten</title>
  1123. <programlisting role="php"><![CDATA[
  1124. // gibt alle bekannten Übersetzungs Ids zurück
  1125. $messageIds = $translate->getMessageIds();
  1126. print_r($messageIds);
  1127. // oder nur die spezifizierte Sprache
  1128. $messageIds = $translate->getMessageIds('en_US');
  1129. print_r($messageIds);
  1130. // gibt die kompletten Übersetzungs Daten zurück
  1131. $source = $translate->getMessages();
  1132. print_r($source);
  1133. ]]></programlisting>
  1134. </example>
  1135. </sect2>
  1136. </sect1>