Zend_Translate-Using.xml 55 KB

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