Zend_Translate-Using.xml 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993
  1. <!-- EN-Revision: 13827 -->
  2. <sect1 id="zend.translate.using">
  3. <title>Utiliser les adaptateurs de traduction</title>
  4. <para>L'étape suivante est d'utiliser l'adaptateur dans votre code.</para>
  5. <example id="zend.translate.using.example1">
  6. <title>Exemple de code PHP monolingue</title>
  7. <programlisting role="php"><![CDATA[
  8. print "Exemple\n";
  9. print "=======\n";
  10. print "Ceci la ligne une\n";
  11. print "Aujourd'hui nous sommes le " . date("d/m/Y") . "\n";
  12. print "\n";
  13. print "Correction de la langue ceci est la ligne deux\n";
  14. ]]></programlisting>
  15. </example>
  16. <para>L'exemple ci-dessus montre l'affichage sans le support de traduction. Vous écrivez probablement votre code
  17. dans votre langue maternelle. Généralement vous devez traduire non seulement l'affichage, mais également les
  18. messages d'erreur et les messages de log.</para>
  19. <para>La prochaine étape est d'inclure <classname>Zend_Translate</classname> dans votre code existant. Naturellement il est
  20. beaucoup plus facile si vous écrivez dès le début votre code en utilisant <classname>Zend_Translate</classname> au lieu de
  21. modifier votre code après.</para>
  22. <example id="zend.translate.using.example2">
  23. <title>Exemple de code PHP multilingue</title>
  24. <programlisting role="php"><![CDATA[
  25. $translate = new Zend_Translate('gettext',
  26. '/mon/chemin/source-de.mo',
  27. 'de');
  28. $translate->addTranslation('//mon/chemin/fr-source.mo', 'fr');
  29. print $translate->_("Exemple")."\n";
  30. print "=======\n";
  31. print $translate->_("Ceci la ligne une")."\n";
  32. printf($translate->_("Aujourd'hui nous sommes le %1\$s") . "\n",
  33. date("d/m/Y"));
  34. print "\n";
  35. $translate->setLocale('fr');
  36. print $translate->_("Correction de la langue ceci est la ligne deux") . "\n";
  37. ]]></programlisting>
  38. </example>
  39. <para>Maintenant regardons plus attentivement ce qui a été fait et la façon d'intégrer <classname>Zend_Translate</classname>
  40. dans votre code.</para>
  41. <para>Créer un nouvel objet de traduction et définir l'adaptateur de base : <programlisting role="php"><![CDATA[
  42. $translate = new Zend_Translate('gettext',
  43. '/chemin/vers/source-de.mo',
  44. 'de');
  45. ]]></programlisting> Dans cet exemple nous avons décidé d'utiliser <emphasis role="strong">l'adaptateur
  46. Gettext</emphasis>. Nous plaçons notre fichier <code>source-de.mo</code> dans le dossier <code>/chemin/vers</code>.
  47. Le fichier gettext inclura la traduction allemande. Et nous avons également ajouté un autre fichier de langue pour
  48. le français.</para>
  49. <para>L'étape suivante est d'envelopper toutes les chaînes qui doivent être traduites. L'approche la plus simple est
  50. d'avoir seulement des chaînes simples ou des phrases comme celle-ci : <programlisting role="php"><![CDATA[
  51. print $translate->_("Exemple")."\n";
  52. print "=======\n";
  53. print $translate->_("Ceci la ligne une")."\n";
  54. ]]></programlisting>Certaines chaînes ne sont pas nécessairement traduites. La ligne séparatrice est toujours la même,
  55. même dans d'autres langues.</para>
  56. <para>Avoir des valeurs de données intégrées dans une chaîne de traduction est également supporté par l'utilisation
  57. des paramètres inclus. <programlisting role="php"><![CDATA[
  58. printf($translate->_("Aujourd'hui nous sommes le %1\$s") . "\n",
  59. date("d/m/Y"));
  60. ]]></programlisting> Au lieu de <code>print()</code>, utiliser la fonction <code>printf()</code> et remplacer tous les
  61. paramètres avec des éléments de type <code>%1\$s</code>. Le premier est <code>%1\$s</code>, le second
  62. <code>%2\$s</code>, et ainsi de suite. De cette façon une traduction peut être faite sans savoir la valeur exacte.
  63. Dans notre exemple, la date est toujours le jour actuel, mais la chaîne peut être traduite sans connaissance du jour
  64. actuel.</para>
  65. <para>Chaque chaîne est identifiée dans le stockage de traduction par un identificateur de message. Vous pouvez
  66. employer l'identificateur de message au lieu des chaînes dans votre code, comme ceci : <programlisting
  67. role="php"><![CDATA[
  68. print $translate->_(1)."\n";
  69. print "=======\n";
  70. print $translate->_(2)."\n";
  71. ]]></programlisting>Mais faire ceci a plusieurs inconvénients :</para>
  72. <para>Vous ne pouvez pas voir ce que votre code devrait afficher juste en lisant celui-ci.</para>
  73. <para>En outre vous obtiendrez des problèmes si certaines chaînes ne sont pas traduites. Vous devez toujours
  74. imaginer comment la traduction fonctionne. Premièrement <classname>Zend_Translate</classname> vérifie si la langue choisie a
  75. une traduction pour l'identificateur de message ou la chaîne fournie. Si aucune chaîne de traduction n'a été
  76. trouvée, elle se reporte sur la langue suivante comme définie dans <classname>Zend_Locale</classname>. Ainsi le "<emphasis
  77. role="strong">de_AT</emphasis>" devient seulement "<emphasis role="strong">de</emphasis>". Si aucune
  78. traduction n'est trouvée pour le "<emphasis role="strong">de</emphasis>", alors le message original est retourné. De
  79. cette façon vous avez toujours un affichage, au cas où la traduction de message n'existerait pas dans votre stockage
  80. des messages. <classname>Zend_Translate</classname> ne lève jamais d'erreur ou d'exception en traduisant les chaînes.</para>
  81. <sect2 id="zend.translate.using.structure">
  82. <title>Structures des sources de traduction</title>
  83. <para>L'étape suivante est la création des sources de traduction pour les multiples langues vers lesquelles vous
  84. traduisez. Chaque adaptateur est créé de sa propre manière comme décrit ici. Mais il y a quelques dispositifs
  85. généraux qui sont valables pour tous les adaptateurs.</para>
  86. <para>Vous devrez savoir où stocker vos fichiers sources de traduction. Avec <classname>Zend_Translate</classname> vous
  87. n'avez aucune restriction. Les structures suivantes sont préférables :</para>
  88. <itemizedlist>
  89. <listitem>
  90. <para>Structure de source unique</para>
  91. <programlisting><![CDATA[
  92. /application
  93. /languages
  94. lang.en
  95. lang.de
  96. /library
  97. ]]></programlisting>
  98. <para>Positif : Tous les fichiers sources pour chacune des langues peuvent être trouvés dans un dossier.
  99. Aucun fractionnement des fichiers.</para>
  100. </listitem>
  101. <listitem>
  102. <para>Source structurée par langue</para>
  103. <programlisting><![CDATA[
  104. /application
  105. /languages
  106. /en
  107. lang.en
  108. other.en
  109. /de
  110. lang.de
  111. other.de
  112. /library
  113. ]]></programlisting>
  114. <para>Positif : chaque langue est située dans un dossier. La traduction est facilitée car un seul
  115. dossier doit être traduit par une équipe de langue. En outre l'utilisation de dossiers multiples est
  116. transparente.</para>
  117. </listitem>
  118. <listitem>
  119. <para>Source structurée par application</para>
  120. <programlisting><![CDATA[
  121. /application
  122. /languages
  123. lang.en
  124. lang.de
  125. other.en
  126. other.de
  127. ]]></programlisting>
  128. <para>Positif : tous les fichiers sources pour chacune des langues peuvent être trouvés dans un seul
  129. dossier. Aucun fractionnement des fichiers.</para>
  130. <para>Négatif : avoir des dossiers multiples pour la même langue est problématique.</para>
  131. </listitem>
  132. <listitem>
  133. <para>Source structurée par Gettext</para>
  134. <programlisting><![CDATA[
  135. /languages
  136. /de
  137. /LC_MESSAGES
  138. lang.mo
  139. other.mo
  140. /en
  141. /LC_MESSAGES
  142. lang.mo
  143. other.mo
  144. ]]></programlisting>
  145. <para>Positif : de vieilles sources de gettext peuvent être utilisées sans changer la structure.</para>
  146. <para>Négatif : avoir des dossiers de dossiers peut être embrouillant pour les personnes qui n'ont pas
  147. utilisé gettext avant.</para>
  148. </listitem>
  149. <listitem>
  150. <para>Source structurée par fichier</para>
  151. <programlisting><![CDATA[
  152. /application
  153. /models
  154. mymodel.php
  155. mymodel.de
  156. mymodel.en
  157. /views
  158. /controllers
  159. mycontroller.de
  160. /document_root
  161. /images
  162. /styles
  163. .htaccess
  164. index.php
  165. index.de
  166. /library
  167. /Zend
  168. ]]></programlisting>
  169. <para>Positif : chaque fichier est lié à sa propre source de traduction.</para>
  170. <para>Négatif : de multiples petits fichiers sources de traduction rendent plus difficile la traduction. En
  171. outre chaque fichier doit être ajouté comme source de traduction.</para>
  172. </listitem>
  173. </itemizedlist>
  174. <para>Les fichiers source uniques et structurés par langue sont les plus utilisés pour
  175. <classname>Zend_Translate</classname>.</para>
  176. <para>Maintenant, que nous connaissons la structure que nous voulons avoir, nous devons créer nos fichiers
  177. sources de traduction.</para>
  178. </sect2>
  179. <sect2 id="zend.translate.using.source.array">
  180. <title>Créer des fichiers sources de type tableau</title>
  181. <para>Les fichiers sources de type tableau sont simplement des tableaux. Mais vous devez les définir manuellement
  182. parce qu'il n'y a aucun outil pour automatiser cela. Mais parce qu'ils sont très simples, ils représentent la manière
  183. la plus rapide de rechercher des messages si votre code fonctionne comme prévu. C'est généralement le meilleur adaptateur pour
  184. démarrer avec des systèmes multilingues.</para>
  185. <programlisting role="php"><![CDATA[
  186. $english = array('message1' => 'message1',
  187. 'message2' => 'message2',
  188. 'message3' => 'message3');
  189. $german = array('message1' => 'Nachricht1',
  190. 'message2' => 'Nachricht2',
  191. 'message3' => 'Nachricht3');
  192. $translate = new Zend_Translate('array', $english, 'en');
  193. $translate->addTranslation($deutsch, 'de');
  194. ]]></programlisting>
  195. <para>Depuis la version 1.5 il est également possible d'avoir des tableaux inclus dans un fichier externe. Vous
  196. devez simplement fournir le nom de fichier, <classname>Zend_Translate</classname> l'inclura automatiquement et recherchera
  197. le tableau. Voir l'exemple suivant pour les détails :</para>
  198. <programlisting role="php"><![CDATA[
  199. // montableau.php
  200. return array(
  201. 'message1' => 'Nachricht1',
  202. 'message2' => 'Nachricht2',
  203. 'message3' => 'Nachricht3');
  204. // contrôleur
  205. $translate = new Zend_Translate('array',
  206. 'chemin/vers/montableau.php',
  207. 'de');
  208. ]]></programlisting>
  209. <note>
  210. <para>Les fichiers qui ne renvoient pas un tableau ne seront pas inclus. N'importe quel rendu issu de ce
  211. fichier sera ignoré et également supprimé.</para>
  212. </note>
  213. </sect2>
  214. <sect2 id="zend.translate.using.source.gettext">
  215. <title>Créer des fichiers sources Gettext</title>
  216. <para>Des fichiers source Gettext sont créés par la bibliothèque GNU gettext. Il y a plusieurs outils libres
  217. disponibles qui peuvent analyser vos fichiers de code et créer les fichiers sources nécessaires à gettext. Ces
  218. fichiers se terminent par <emphasis role="strong">*.mo</emphasis> et ce sont des fichiers binaires. Un gratuiciel
  219. pour créer ces fichiers est <ulink url="http://sourceforge.net/projects/poedit/">poEdit</ulink>. Cet outil vous
  220. aide également pour le processus de traduction lui-même.</para>
  221. <programlisting role="php"><![CDATA[
  222. // Les fichiers mo sont créés et déjà traduits
  223. $translate = new Zend_Translate('gettext',
  224. 'chemin/vers/english.mo',
  225. 'en');
  226. $translate->addTranslation('chemin/vers/german.mo', 'de');
  227. ]]></programlisting>
  228. <para>Comme vous pouvez le voir, les adaptateurs sont utilisés exactement de la même manière, avec juste une
  229. petite différence : changer "<code>array</code>" en "<code>gettext</code>". Toutes autres utilisations sont
  230. exactement les mêmes qu'avec tous autres adaptateurs. Avec l'adaptateur de gettext vous ne devez plus vous
  231. occuper de la structure des répertoires, du "<code>bindtextdomain</code>" et du "<code>textdomain</code>".
  232. Fournissez juste le chemin et le nom de fichier à l'adaptateur.</para>
  233. <note>
  234. <para>Vous devriez toujours employer UTF-8 comme source d'encodage. Autrement vous aurez des problèmes si
  235. vous employez deux encodages différents. Par exemple, si un de vos fichiers source est encodé en ISO-8815-1
  236. et un fichier différent est codé avec CP815. Vous ne pouvez utiliser qu'un seul encodage pour vos fichiers
  237. sources, ainsi une de vos langues ne s'affichera probablement pas correctement.</para>
  238. <para>UTF-8 est un format portable qui supporte toutes les langues. Si vous employez l'encodage UTF-8 pour
  239. toutes les langues, vous éliminez le problème des encodages incompatibles.</para>
  240. </note>
  241. <para>La plupart des éditeur gettext ajoutent les informations de l'adaptateur comme chaines de traduction vides.
  242. C'est pour cela que traduire des chaines vides ne fonctionne pas avec l'adaptateur gettext. A la place, elles sont
  243. effacées de la table de traduction. <code>getAdapterInfo()</code> retourne les informations de l'adaptateur gettext,
  244. notamment les informations des fichiers gettext ajoutés.</para>
  245. <programlisting role="php"><![CDATA[
  246. // Informations sur l'adaptateur
  247. $translate = new Zend_Translate('gettext',
  248. 'path/to/english.mo',
  249. 'en');
  250. print_r $translate->getAdapterInfo();
  251. ]]></programlisting>
  252. </sect2>
  253. <sect2 id="zend.translate.using.source.tmx">
  254. <title>Créer des fichiers source TMX</title>
  255. <para>Les fichiers sources TMX sont les nouveaux standards industriels. Ils ont l'avantage d'être des fichiers
  256. XML et ainsi ils sont lisibles par tout éditeur de fichier et naturellement ils sont lisibles pour l'homme. Vous
  257. pouvez soit créer des fichiers TMX manuellement avec un éditeur de texte, soit utiliser un outil. Mais la
  258. plupart des programmes actuellement disponibles pour développer des fichiers source TMX ne sont pas des
  259. gratuiciels.</para>
  260. <example id="zend.translate.using.source.tmx.example">
  261. <title>Exemple de fichier TMX</title>
  262. <programlisting role="xml"><![CDATA[
  263. <?xml version="1.0" ?>
  264. <!DOCTYPE tmx SYSTEM "tmx14.dtd">
  265. <tmx version="1.4">
  266. <header creationtoolversion="1.0.0" datatype="winres"
  267. segtype="sentence" adminlang="en-us" srclang="de-at"
  268. o-tmf="abc" creationtool="XYZTool" >
  269. </header>
  270. <body>
  271. <tu tuid='message1'>
  272. <tuv xml:lang="de"><seg>Nachricht1</seg></tuv>
  273. <tuv xml:lang="en"><seg>message1</seg></tuv>
  274. </tu>
  275. <tu tuid='message2'>
  276. <tuv xml:lang="en"><seg>message2</seg></tuv>
  277. <tuv xml:lang="de"><seg>Nachricht2</seg></tuv>
  278. </tu>
  279. ]]></programlisting>
  280. <programlisting role="php"><![CDATA[
  281. $translate = new Zend_Translate('tmx',
  282. 'chemin/vers/mytranslation.tmx',
  283. 'en');
  284. // TMX peut contenir différentes langues dans le même fichier
  285. ]]></programlisting>
  286. </example>
  287. <para>Les fichiers TMX peuvent avoir plusieurs langues dans le même fichier. Toute autre langue incluse est
  288. ajoutée automatiquement, ainsi vous n'avez pas à appeler <code>addLanguage()</code>.</para>
  289. <para>Si vous voulez avoir seulement les langues spécifiées de la source traduite, vous pouvez régler l'option
  290. <code>defined_language</code> à <code>true</code>. Avec cette option vous pouvez ajouter les langues souhaitées
  291. explicitement avec <code>addLanguage()</code>. La valeur par défaut pour cette option est d'ajouter toutes les
  292. langues.</para>
  293. </sect2>
  294. <sect2 id="zend.translate.using.source.csv">
  295. <title>Créer des fichiers source CSV</title>
  296. <para>Les fichiers sources CSV sont petits et lisibles pour l'homme. Si vos clients veulent eux-mêmes traduire,
  297. vous utiliserez probablement l'adaptateur CSV.</para>
  298. <example id="zend.translate.using.source.csv.example">
  299. <title>Exemple avec un fichier CSV</title>
  300. <programlisting><![CDATA[
  301. #Exemple de fichier csv
  302. message1;Nachricht1
  303. message2;Nachricht2
  304. ]]></programlisting>
  305. <programlisting role="php"><![CDATA[
  306. $translate = new Zend_Translate('csv',
  307. 'chemin/vers/matraduction.csv',
  308. 'de');
  309. $translate->addTranslation('chemin/vers/autretraduction.csv',
  310. 'fr');
  311. ]]></programlisting>
  312. </example>
  313. <para>Il existe trois options différentes pour l'adaptateur CSV. Vous pouvez paramétrer
  314. "<code>delimiter</code>", "<code>limit</code>" et "<code>enclosure</code>".</para>
  315. <para>Le délimiteur standard des fichiers CSV est le signe "<code>;</code>". Mais celui-ci n'est pas
  316. obligatoire. Avec l'option "<code>delimiter</code>" vous pouvez décider d'utiliser un autre signe de
  317. séparation.</para>
  318. <para>La taille limite d'une ligne de fichier CSV est par défaut "<code>0</code>" Ce qui veut dire que la fin de
  319. la ligne est recherchée automatiquement. Si vous paramétrez l'option "<code>limit</code>" avec une valeur
  320. quelconque, alors le fichier CSV sera lu plus rapidement, mais toute ligne dont la longueur excédera la limite
  321. sera tronquée.</para>
  322. <para>"L'échappement" par défaut d'un fichier CSV est le "<code>"</code>". Vous pouvez en paramétrer un autre
  323. avec l'option "<code>enclosure</code>".</para>
  324. <example id="zend.translate.using.source.csv.example2">
  325. <title>Exemple avec un fichier CSV (2)</title>
  326. <programlisting><![CDATA[
  327. #Exemple de fichier csv
  328. # original 'message,1'
  329. "message,1",Nachricht1
  330. # traduction 'Nachricht,2'
  331. message2,"Nachricht,2"
  332. # original 'message3,'
  333. "message3,",Nachricht3
  334. ]]></programlisting>
  335. <programlisting role="php"><![CDATA[
  336. $translate = new Zend_Translate('csv',
  337. 'chemin/vers/matraduction.csv',
  338. 'de',
  339. array('delimiter' => ','));
  340. $translate->addTranslation('chemin/vers/autretraduction.csv',
  341. 'fr');
  342. ]]></programlisting>
  343. </example>
  344. </sect2>
  345. <sect2 id="zend.translate.using.source.ini">
  346. <title>Créer des fichiers sources INI</title>
  347. <para>Les fichiers sources INI sont lisibles par l'homme mais habituellement pas très petits puisqu'ils incluent
  348. également d'autres données à côté des traductions. Si vous avez des données qui seront éditables par vos
  349. clients, vous pouvez aussi utiliser l'adaptateur INI dans ce cas.</para>
  350. <example id="zend.translate.using.source.ini.example">
  351. <title>Exemple avec un fichier INI</title>
  352. <programlisting><![CDATA[
  353. [Test]
  354. ;Commentaires possibles
  355. Message_1="Nachricht 1 (de)"
  356. Message_2="Nachricht 2 (de)"
  357. Message_3="Nachricht :3 (de)"
  358. ]]></programlisting>
  359. <programlisting role="php"><![CDATA[
  360. $translate = new Zend_Translate('ini',
  361. 'path/to/mytranslation.ini',
  362. 'de');
  363. $translate->addTranslation('path/to/other.ini',
  364. 'it');
  365. ]]></programlisting>
  366. </example>
  367. <para>Les fichiers INI ont de multiples restrictions. Si une valeur dans le fichier INI contient un caractère
  368. non-alphanumérique, il doit être entouré avec des guillemets doubles ("). Il y a aussi des mots réservés qui ne
  369. doivent pas être utilisés en tant que clés des fichiers INI. Ceci inclut : <code>null</code>, <code>yes</code>,
  370. <code>no</code>, <code>true</code> et <code>false</code>. Les valeurs <code>null</code>, <code>no</code> et
  371. <code>false</code> sont retournées sous la forme "". <code>yes</code> et <code>true</code> sont retournés en
  372. "1". Les caractères {}|&amp;~![()" ne doivent pas être utilisés dans la clé et ont une signification
  373. particulière dans la valeur. Ne les utilisez pas ou vous rencontrerez des comportements inattendus.</para>
  374. </sect2>
  375. <sect2 id="zend.translate.using.options">
  376. <title>Options pour les adaptateurs</title>
  377. <para>Les options peuvent être utilisées avec tous les adaptateurs. Bien sûr chacun d'eux accepte des options
  378. différentes. Vous pouvez passer des options quand vous créez l'adaptateur. Pour l'instant il y a qu'une
  379. option qui est valable pour tous les adaptateurs. '<code>clear</code>' décide si des données de traduction
  380. peuvent être ajoutées à l'existant ou non. Le comportement standard est d'ajouter des nouvelles données de
  381. traduction à l'existant. Les données de traduction sont seulement effacées pour la langue choisie. Donc on ne
  382. touchera pas aux autres langues.</para>
  383. <para>Vous pouvez régler des options temporaires en utilisant <code>addTranslation($data, $locale, array
  384. $options = array())</code> comme troisième paramètre optionnel. Ou vous pouvez utiliser la fonction
  385. <code>setOptions()</code> pour régler une option.</para>
  386. <example id="zend.translate.using.options.example">
  387. <title>Utiliser les options de traduction</title>
  388. <programlisting role="php"><![CDATA[
  389. // définir ':' comme séparateur pour les fichiers sources de traduction
  390. $options = array('delimiter' => ':');
  391. $translate = new Zend_Translate('csv',
  392. 'chemin/vers/matraduction.csv',
  393. 'fr',
  394. $options);
  395. ...
  396. // efface le langage défini et utilise de nouvelles données de traduction
  397. $options = array('clear' => true);
  398. $translate->addTranslation('chemin/vers/nouveau.csv',
  399. 'en',
  400. $options);
  401. ]]></programlisting>
  402. </example>
  403. <para>Ici vous pouvez trouver toutes les options disponibles pour les différents adaptateurs avec une
  404. description de leur utilisation :</para>
  405. <table id="zend.translate.using.options.alloptions">
  406. <title>Options des adaptateurs de traduction</title>
  407. <tgroup cols="4">
  408. <thead>
  409. <row>
  410. <entry>Adaptateur</entry>
  411. <entry>Option</entry>
  412. <entry>Valeur standard</entry>
  413. <entry>Description</entry>
  414. </row>
  415. </thead>
  416. <tbody>
  417. <row>
  418. <entry>Tous</entry>
  419. <entry><code>clear</code></entry>
  420. <entry><code>false</code></entry>
  421. <entry>Si réglé à <code>true</code>, les traductions déjà lues seront effacées. Ceci peut être
  422. utilisé au lieu de créer une nouvelle instance quand on lit de nouvelles données de
  423. traduction.</entry>
  424. </row>
  425. <row>
  426. <entry>Tous</entry>
  427. <entry><code>disableNotices</code></entry>
  428. <entry><code>false</code></entry>
  429. <entry>Si réglé à <code>true</code>, toutes les notices concernant la non-disponibilité des
  430. traductions seront désactivées. Vous devriez mettre cette option à <code>true</code> dans votre
  431. environnement de production.</entry>
  432. </row>
  433. <row>
  434. <entry>Tous</entry>
  435. <entry><code>ignore</code></entry>
  436. <entry><emphasis role="strong">.</emphasis></entry>
  437. <entry>Tous les dossiers et les fichiers commençant par ce caractère seront ignorés dans la recherche
  438. automatique de traductions. La valeur par défaut est <emphasis role="strong">'.'</emphasis>, ce qui signifie
  439. que tous les fichiers cachés (Unix) seront ignorés. Mettre une valeur par exemple à 'tmp' aura pour effet
  440. d'ignorer les dossiers ou fichiers 'tmpImages' ou encore 'tmpFiles' (par exemple), ainsi que tous les
  441. sous-dossiers</entry>
  442. </row>
  443. <row>
  444. <entry>Tous</entry>
  445. <entry><code>scan</code></entry>
  446. <entry><code>null</code></entry>
  447. <entry>Si réglé à <code>null</code>, aucun scan de la structure de répertoire ne sera effectué.
  448. Si réglé à <classname>Zend_Translate::LOCALE_DIRECTORY</classname>, la localisation sera détectée dans le
  449. répertoire. Si réglé à <classname>Zend_Translate::LOCALE_FILENAME</classname>, la localisation sera
  450. détectée dans le nom de fichier. Voir <xref linkend="zend.translate.using.detection" /> pour de
  451. plus amples détails.</entry>
  452. </row>
  453. <row>
  454. <entry>Csv</entry>
  455. <entry><code>delimiter</code></entry>
  456. <entry><code>;</code></entry>
  457. <entry>Définit quel signe est utilisé pour la séparation de la source et de la
  458. traduction.</entry>
  459. </row>
  460. <row>
  461. <entry>Csv</entry>
  462. <entry><code>length</code></entry>
  463. <entry><code>0</code></entry>
  464. <entry>Définit la longueur maximum d'une ligne de fichier. Réglé à 0, la recherche sera
  465. automatique.</entry>
  466. </row>
  467. <row>
  468. <entry>Csv</entry>
  469. <entry><code>enclosure</code></entry>
  470. <entry><code>"</code></entry>
  471. <entry>Définit le caractère d'échappement.</entry>
  472. </row>
  473. </tbody>
  474. </tgroup>
  475. </table>
  476. <para>Si vous souhaitez avoir vos propres définitions d'options, vous pouvez les utiliser avec tous les
  477. adaptateurs. La méthode <code>setOptions()</code> peut être utilisée pour définir vos options. La méthode
  478. <code>setOptions()</code> nécessite un tableau avec les options que vous voulez paramétrer. Si une option
  479. fournie existe déjà, elle sera alors ré-assignée. Vous pouvez définir autant d'options que nécessaire car elles
  480. ne seront pas vérifiées par l'adaptateur. Vérifiez simplement que vous ne créez pas une option qui existe déjà
  481. dans l'adaptateur, vous affecteriez alors une nouvelle valeur.</para>
  482. <para>Pour récupérer l'ensemble des options, vous pouvez utiliser la méthode <code>getOptions()</code>. Quand
  483. <code>getOptions()</code> est appelée sans paramètre, elle retourne l'ensemble des options. Si un paramètre est
  484. fourni, seule l'option particulière sera retournée.</para>
  485. </sect2>
  486. <sect2 id="zend.translate.using.languages">
  487. <title>Gérer les langues</title>
  488. <para>En travaillant avec différentes langues il y a quelques méthodes qui seront utiles.</para>
  489. <para>La méthode <code>getLocale()</code> peut être utilisée pour récupérer la langue actuellement réglée. Elle
  490. peut retourner soit une instance de <classname>Zend_Locale</classname>, soit un identifiant de localisation.</para>
  491. <para>La méthode <code>setLocale()</code> règle une nouvelle langue standard pour la traduction. Ceci évite de
  492. placer le paramètre facultatif de langue plus d'une fois lors de l'appel de la méthode <code>translate()</code>.
  493. Si la langue donnée n'existe pas, ou si aucune donnée de traduction n'est disponible pour la langue,
  494. <code>setLocale()</code> essaye de remonter à la langue sans région si elle est indiquée. Une langue
  495. <code>fr_FR</code> serait remontée à <code>fr</code>. Si la remontée n'est pas possible, une exception sera
  496. levée.</para>
  497. <para>La méthode <code>isAvailable()</code> vérifie si une langue donnée est déjà disponible. Elle retourne
  498. <code>true</code> si des données existent pour la langue fournie.</para>
  499. <para>Et enfin la méthode <code>getList()</code> peut être utilisée pour récupérer sous la forme d'un tableau
  500. tous les langues paramétrées pour un adaptateur.</para>
  501. <example id="zend.translate.using.languages.example">
  502. <title>Gestion des langues avec des adaptateurs</title>
  503. <programlisting role="php"><![CDATA[
  504. ...
  505. // retourne la langue paramétrée actuelle
  506. $actual = $translate->getLocale();
  507. ...
  508. // vous pouvez utiliser le paramètre optionel au moment de la traduction
  509. echo $translate->_("mon_texte", "fr");
  510. // ou paramètrer une langue standard
  511. $translate->setLocale("fr");
  512. echo $translate->_("mon_texte");
  513. // référence à la langue de base... fr_CH sera remonté à fr
  514. $translate->setLocale("fr_CH");
  515. echo $translate->_("mon_texte");
  516. ...
  517. // vérifie si la langue existe
  518. if ($translate->isAvailable("fr")) {
  519. // la langue existe
  520. }
  521. ]]></programlisting>
  522. </example>
  523. <sect3 id="zend.translate.using.languages.automatic">
  524. <title>Gestion automatique des langues</title>
  525. <para>Notez que tant que vous ajouterez les nouvelles sources de traduction seulement via la méthode
  526. <code>addTranslation()</code>, <classname>Zend_Translate</classname> cherchera automatiquement la langue correspondant
  527. au mieux à votre environnement quand vous utiliserez une des localisations automatiques "<code>auto</code>"
  528. ou "<code>browser</code>". Donc normalement vous ne devriez pas appeler <code>setLocale()</code>. Ceci ne
  529. doit être utilisé qu'en conjonction avec la détection automatique des sources de traduction.</para>
  530. <para>L'algorithme recherchera la meilleure locale suivant le navigateur des utilisateurs et votre
  531. environnement. Voyez l'exemple suivant pour les détails :</para>
  532. <example id="zend.translate.using.languages.automatic.example">
  533. <title>Comment la détection automatique de la langue fonctionne-t-elle ?</title>
  534. <programlisting role="php"><![CDATA[
  535. // Assumons que le navigateur retourne ces valeurs
  536. // HTTP_ACCEPT_LANGUAGE = "de_AT=1;fr=1;en_US=0.8";
  537. // Exemple 1 :
  538. $translate = new Zend_Translate('gettext',
  539. '\my_it.mo',
  540. 'auto',
  541. array('scan' => Zend_Translate::LOCALE_FILENAME);
  542. // pas de langue trouvée, on retourne le messageid
  543. // Exemple 2 :
  544. $translate = new Zend_Translate('gettext',
  545. '\my_fr.mo',
  546. 'auto',
  547. array('scan' => Zend_Translate::LOCALE_FILENAME);
  548. // langue correspondante trouvée "en_US"
  549. // Exemple 3 :
  550. $translate = new Zend_Translate('gettext',
  551. '\my_de.mo',
  552. 'auto',
  553. array('scan' => Zend_Translate::LOCALE_FILENAME);
  554. // langue correspondante trouvée "de" car "de_AT" est descendue à "de"
  555. // Exemple 4 :
  556. $translate = new Zend_Translate('gettext',
  557. '\my_it.mo',
  558. 'auto',
  559. array('scan' => Zend_Translate::LOCALE_FILENAME);
  560. $translate->addTranslation('\my_ru.mo', 'ru');
  561. $translate->setLocale('it_IT');
  562. // retourne "it_IT" comme source de traduction et surcharge le réglage automatique
  563. ]]></programlisting>
  564. </example>
  565. <para>Si vous utilisez <code>setLocale()</code>, la detection automatique de la langue sera alors annulée, et la
  566. langue à utiliser sera celle spécifiée par l'appel de la méthode.</para>
  567. <para>Si vous voulez réactiver la détection automatique, réappelez <code>setLocale()</code> et passez lui la valeur
  568. <emphasis role="strong">auto</emphasis>.</para>
  569. <para>Depuis Zend Framework 1.7.0 <classname>Zend_Translate</classname> reconnait une locale globale pour l'application.
  570. Vous pouvez ainsi simplement mettre un objet <classname>Zend_Locale</classname> dans le registre, comme montré ci-après.
  571. Avec cette fonctionnalité, vous pouvez oublier le passage de la locale à votre objet de traduction.</para>
  572. <programlisting role="php"><![CDATA[
  573. // En fichier d'amorçage (bootstrap)
  574. $locale = new Zend_Locale('de_AT');
  575. Zend_Registry::set('Zend_Locale', $locale);
  576. // ailleurs dans votre application
  577. $translate = new Zend_Translate('gettext', '\my_de.mo');
  578. $translate->getLocale();
  579. ]]></programlisting>
  580. </sect3>
  581. </sect2>
  582. <sect2 id="zend.translate.using.detection">
  583. <title>Détéction automatique de la source</title>
  584. <para>Zend_Translate peut détecter les sources de traduction de manière automatique. Ainsi vous n'avez pas à déclarer
  585. toutes les sources manuellement. Vous laissez Zend_Translate faire ce travail et scanner complètement tout un répertoire
  586. à la recherche de fichiers de langue de traduction.</para>
  587. <note>
  588. <para>La détection automatique des sources de traduction est disponible depuis Zend Framework version 1.5.</para>
  589. </note>
  590. <para>L'utilisation est assez semblable à celle qui permet de spécifier une source de langue. Vous devez simplement
  591. donner un dossier, et non plus un fichier, à l'adaptateur. Ce dossier sera alors scanné</para>
  592. <example id="zend.translate.using.languages.directory.example">
  593. <title>Scanner un dossier à la recherche de sources de traduction</title>
  594. <programlisting role="php"><![CDATA[
  595. // Soit la structure suivante :
  596. // /language
  597. // /language/login/login.tmx
  598. // /language/logout/logout.tmx
  599. // /language/error/loginerror.tmx
  600. // /language/error/logouterror.tmx
  601. $translate = new Zend_Translate('tmx', '/language');
  602. ]]></programlisting>
  603. </example>
  604. <para>Notez que Zend_Translate cherche dans tous les sous-repertoires. L'utilisation devient alors relativement
  605. simple. Aussi, Zend_Translate ignorera tout fichier qui ne l'interresse pas : des fichiers non représentatifs de
  606. traductions ou encore des fichiers illisibles. Vérifiez donc que le dossier principal ne contienne que des fichiers
  607. de traductions, car Zend_Translate ne renverra aucune erreur dans le cas contraire, il ignorera simplement de tels
  608. fichiers.</para>
  609. <note>
  610. <para>Selon la compléxité de la récursivité, la traversée du répertoire principal peut devenir longue et couteuse.
  611. </para>
  612. </note>
  613. <para>Dans notre exemple, nous utilisons l'adaptateur TMX qui inclut la langue à utiliser dans le fichier en question.
  614. D'autres adaptateurs n'agissent pas comme cela, ainsi les noms de fichiers devront comporter les noms des langues à
  615. considérer pour de tels adaptateurs.</para>
  616. <sect3 id="zend.translate.using.detection.directory">
  617. <title>La langue se trouve dans le nom des dossiers</title>
  618. <para>One way to include automatic language detection is to name the directories related to the language
  619. which is used for the sources within this directory. This is the easiest way and is used for example within
  620. standard gettext implementations.</para>
  621. <para>Zend_Translate needs the 'scan' option to know that it should search the names of all directories for
  622. languages. See the following example for details:</para>
  623. <example id="zend.translate.using.detection.directory.example">
  624. <title>Directory scanning for languages</title>
  625. <programlisting role="php"><![CDATA[
  626. // expect we have the following structure
  627. // /language
  628. // /language/de/login/login.mo
  629. // /language/de/error/loginerror.mo
  630. // /language/en/login/login.mo
  631. // /language/en/error/loginerror.mo
  632. $translate = new Zend_Translate('gettext',
  633. '/language',
  634. null,
  635. array('scan' =>
  636. Zend_Translate::LOCALE_DIRECTORY));
  637. ]]></programlisting>
  638. </example>
  639. <note>
  640. <para>This works only for adapters which do not include the language within the source file. Using this
  641. option for example with TMX will be ignored. Also language definitions within the filename will be
  642. ignored when using this option.</para>
  643. </note>
  644. <note>
  645. <para>You should be aware if you have several subdirectories under the same structure. Expect we have a
  646. structure like <code>/language/module/de/en/file.mo</code>. The path contains in this case multiple
  647. strings which would be detected as locale. It could be eigther <code>de</code> or <code>en</code>. As
  648. the behaviour is, in this case, not declared it is recommended that you use file detection in such
  649. situations.</para>
  650. </note>
  651. </sect3>
  652. <sect3 id="zend.translate.using.detection.filename">
  653. <title>Language through filenames</title>
  654. <para>Another way to detect the langage automatically is to use special filenames. You can either name the
  655. complete file or parts of a file with the used language. To use this way of detection you will have to set
  656. the 'scan' option at initiation. There are several ways of naming the sourcefiles which are described
  657. below:</para>
  658. <example id="zend.translate.using.detection.filename.example">
  659. <title>Filename scanning for languages</title>
  660. <programlisting role="php"><![CDATA[
  661. // expect we have the following structure
  662. // /language
  663. // /language/login/login_en.mo
  664. // /language/login/login_de.mo
  665. // /language/error/loginerror_en.mo
  666. // /language/error/loginerror_de.mo
  667. $translate = new Zend_Translate('gettext',
  668. '/language',
  669. null,
  670. array('scan' =>
  671. Zend_Translate::LOCALE_FILENAME));
  672. ]]></programlisting>
  673. </example>
  674. <sect4 id="zend.translate.using.detection.filename.complete">
  675. <title>Complete Filename</title>
  676. <para>Having the whole file named after the language is the simplest way but only usable if you have
  677. only one file per directory.</para>
  678. <programlisting><![CDATA[
  679. /languages
  680. en.mo
  681. de.mo
  682. es.mo
  683. ]]></programlisting>
  684. </sect4>
  685. <sect4 id="zend.translate.using.detection.filename.extension">
  686. <title>Extension of the file</title>
  687. <para>Another very simple way if to use the extension of the file for the language detection. But this
  688. may be confusing because you will no longer know which file extension the file originally was.</para>
  689. <programlisting><![CDATA[
  690. /languages
  691. view.en
  692. view.de
  693. view.es
  694. ]]></programlisting>
  695. </sect4>
  696. <sect4 id="zend.translate.using.detection.filename.token">
  697. <title>Filename tokens</title>
  698. <para>Zend_Translate is also captable of detecting the language if it is included within the filename.
  699. But if you use this way you will have to seperate the language with a token. There are three supported
  700. tokens which can be used: A point '.', a underline '_', or a hyphen '-'.</para>
  701. <programlisting><![CDATA[
  702. /languages
  703. view_en.mo -> detects english
  704. view_de.mo -> detects german
  705. view_it.mo -> detects italian
  706. ]]></programlisting>
  707. <para>The first found token which can be detected as locale will be used. See the following example for
  708. details.</para>
  709. <programlisting><![CDATA[
  710. /languages
  711. view_en_de.mo -> detects english
  712. view_en_es.mo -> detects english and overwrites the first file
  713. because the same messageids are used
  714. view_it_it.mo -> detects italian
  715. ]]></programlisting>
  716. <para>All three tokens are used to detect the locale. The first one is the point '.', the second is the
  717. underline '_' and the third the hyphen '-'. If you have several tokens within the filename the first
  718. found depending on the order of the tokens will be used. See the following example for details.</para>
  719. <programlisting><![CDATA[
  720. /languages
  721. view_en-it.mo -> detects english because '_' will be used before '-'
  722. view-en_it.mo -> detects italian because '_' will be used before '-'
  723. view_en.it.mo -> detects italian because '.' will be used before '_'
  724. ]]></programlisting>
  725. </sect4>
  726. </sect3>
  727. </sect2>
  728. <sect2 id="zend.translate.using.istranslated">
  729. <title>Vérifier les traductions</title>
  730. <para>Normalement le texte sera traduit sans aucun calcul. Mais il est quelquefois nécessaire si un texte est
  731. traduit ou non dans la source. Dans ce cas la méthode <code>isTranslated()</code> peut être utilisé.</para>
  732. <para><code>isTranslated($messageId, $original = false, $locale = null)</code> prend comme premier paramètre le
  733. texte dont vous voulez vérifier que la traduction est possible. Et comme troisième paramètre optionnel la langue
  734. dont vous voulez connaître la traduction. Le second paramètre optionnel détermine si la traduction est fixée à
  735. la langue déclarée ou si une autre langue peut être utilisée. Si vous avez un texte qui peut être traduit en
  736. "fr" mais pas en "fr_fr" vous obtiendriez normalement la traduction fournie, mais avec <code>$original</code>
  737. réglé à <code>true</code>, la méthode <code>isTranslated()</code> retournera <code>false</code> dans ce
  738. cas.</para>
  739. <example id="zend.translate.using.istranslated.example">
  740. <title>Vérifier si une texte est traduisible</title>
  741. <programlisting role="php"><![CDATA[
  742. $english = array('message1' => 'Nachricht 1',
  743. 'message2' => 'Nachricht 2',
  744. 'message3' => 'Nachricht 3');
  745. $translate = new Zend_Translate('array', $english, 'de_AT');
  746. if ($translate->isTranslated('message1')) {
  747. print "'message1' peut être traduit";
  748. }
  749. if (!($translate->isTranslated('message1', true, 'de'))) {
  750. print "'message1' ne peut pas être traduit en 'de', "
  751. . "il est seulement disponible en 'de_AT'";
  752. }
  753. if ($translate->isTranslated('message1', false, 'de')) {
  754. print "'message1' peut être traduit en 'de_AT' "
  755. . "et par conséquent en 'de'";}
  756. ]]></programlisting>
  757. </example>
  758. </sect2>
  759. <sect2 id="zend.translate.using.sourcedata">
  760. <title>Access to the source data</title>
  761. <para>Of course sometimes it is useful to have access to the translation source data. Therefor two functions
  762. exist.</para>
  763. <para>The <code>getMessageIds($locale = null)</code> method returns all known message ids as array.</para>
  764. <para>And the <code>getMessages($locale = null)</code> method returns the complete translation source as array.
  765. The message id is used as key and the translation data as value.</para>
  766. <para>Both methods accept an optional parameter <code>$locale</code> which, when set, returns the translation
  767. data for the specified language. If this parameter is not given, the actual set language will be used. Keep in
  768. mind that normally all translations should be available in all languages. Which means that in a normal situation
  769. you will not have to set this parameter.</para>
  770. <para>Additionally the <code>getMessages()</code> method is able to return the complete translation dictionary
  771. with the pseudo-locale 'all'. This will return all available translation data for each added locale.</para>
  772. <note>
  773. <para>Attention: The returned array can be <emphasis role="strong">very big</emphasis>, depending on the
  774. count of added locales and the amount of translation data.</para>
  775. </note>
  776. <example id="zend.translate.using.sourcedata.example">
  777. <title>Handling languages with adapters</title>
  778. <programlisting role="php"><![CDATA[
  779. ...
  780. // returns all known message ids
  781. $messageids = $translate->getMessageIds();
  782. print_r($messageids);
  783. ...
  784. // or just for the specified language
  785. $messageids = $translate->getMessageIds('en_US');
  786. print_r($messageids);
  787. ...
  788. // returns all the complete translation data
  789. $source = $translate->getMessages();
  790. print_r($source);
  791. ]]></programlisting>
  792. </example>
  793. </sect2>
  794. </sect1>