Zend_Validate-Barcode.xml 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- Reviewed: no -->
  3. <!-- EN-Revision: 24249 -->
  4. <sect2 id="zend.validate.set.barcode">
  5. <title>Barcode</title>
  6. <para>
  7. <classname>Zend_Validate_Barcode</classname> permet de vérifier si une donnée représente
  8. un code barres.
  9. </para>
  10. <para>
  11. <classname>Zend_Validate_Barcode</classname> supporte de multiples standards de codes à barres
  12. et peut être étendu pour les codes barres propriétaires. Les formats suivants sont supportés:
  13. </para>
  14. <itemizedlist>
  15. <listitem>
  16. <para>
  17. <emphasis>CODE25</emphasis>: Aussi appelé "two of five" ou "Code25 Industrial".
  18. </para>
  19. <para>
  20. Ce code n'a pas de limite de taille. Il supporte les chiffres et le dernier chiffre
  21. peut être une somme de contrôle optionnelle calculée sur un modulo 10. Ce standard est
  22. très vieux et plus trop utilisé. Les cas d'utilisations classiques sont l'industrie
  23. </para>
  24. </listitem>
  25. <listitem>
  26. <para>
  27. <emphasis>CODE25INTERLEAVED</emphasis>: Aussi appelé "Code 2 of 5 Interleaved".
  28. </para>
  29. <para>
  30. C'est une variante de CODE25. Il n'a pas de limite de taille mais il doit contenir un
  31. nombre de caractères pair. Il supporte uniquement les chiffres et le dernier chiffre
  32. peut être une somme de contrôle optionnelle calculée sur un modulo 10. Il est utilisé
  33. au travers le monde et typiquement dans l'industrie / la distribution.
  34. </para>
  35. </listitem>
  36. <listitem>
  37. <para>
  38. <emphasis>CODE39</emphasis>: CODE39 est un des codes les plus vieux.
  39. </para>
  40. <para>
  41. Ce code a une taille variable. Il supporte les chiffres, les lettres majuscules, et 7 caractères
  42. spéciaux comme l'espace, le point ou le signe dollar. Il peut posséder optionnellement une somme
  43. de contrôle calculée sur un modulo 43. Il est utilisé dans le monde, dans l'industrie.
  44. </para>
  45. </listitem>
  46. <listitem>
  47. <para>
  48. <emphasis>CODE39EXT</emphasis>: CODE39EXT est une extension de CODE39.
  49. </para>
  50. <para>
  51. Ce code à barres a les mêmes propriétés que CODE39. Aussi, il autorise l'utilisation de tous les
  52. caractères ASCII (128). Ce standard est très utilisé dans l'industrie, dans le monde.
  53. </para>
  54. </listitem>
  55. <listitem>
  56. <para>
  57. <emphasis>CODE93</emphasis>: CODE93 est le successeur de CODE39.
  58. </para>
  59. <para>
  60. Ce code a une taille variable. Il supporte les chiffres, les lettres de l'alphabet et 7 caractères
  61. spéciaux. Il possède optionnellement une somme de contrôle à 2 caractères calculée sur un modulo 47.
  62. Ce standard produit un code plus dense que CODE39 et est plus sécurisé.
  63. </para>
  64. </listitem>
  65. <listitem>
  66. <para>
  67. <emphasis>CODE93EXT</emphasis>: CODE93EXT est une extension de CODE93.
  68. </para>
  69. <para>
  70. Ce type de code à barres a les mêmes propriétés que CODE93. Aussi, il permet l'utilisation des 128
  71. caractères du jeu ASCII. Ce standard est utilisé dans le monde et principalement dans l'industrie.
  72. </para>
  73. </listitem>
  74. <listitem>
  75. <para>
  76. <emphasis>EAN2</emphasis>: EAN est un raccourci de "European Article Number".
  77. </para>
  78. <para>
  79. Ces codes ont deux caractères. Seuls les chiffres sont supportés et ils n'ont pas de
  80. somme de contrôle. Ce standard est utilisé principalement en plus de EAN13 (ISBN) sur
  81. les livres imprimés.
  82. </para>
  83. </listitem>
  84. <listitem>
  85. <para>
  86. <emphasis>EAN5</emphasis>: EAN est un raccourci pour "European Article Number".
  87. </para>
  88. <para>
  89. Ce code barres doit comporter 5 caractères. Il ne supporte que les chiffres et ne possède pas de
  90. somme de contrôle. Ce standard est principalement utilisé en plus de EAN13 (ISBN) pour
  91. l'impression de livres.
  92. </para>
  93. </listitem>
  94. <listitem>
  95. <para>
  96. <emphasis>EAN8</emphasis>: EAN est un raccourci pour "European Article Number".
  97. </para>
  98. <para>
  99. Ce code barres se compose de 7 ou 8 caractères. Il supporte les chiffres uniquement. Lorsqu'il est
  100. à 8 caractères, il inclut une somme de contrôle. Ce standard est utilisé dans le monde mais pour
  101. des besoins limités. On le trouve pour les petits articles où un code barres plus long n'aurait
  102. pas pu être imprimé.
  103. </para>
  104. </listitem>
  105. <listitem>
  106. <para>
  107. <emphasis>EAN12</emphasis>: EAN est un raccourci pour "European Article Number".
  108. </para>
  109. <para>
  110. Ce code doit faire 12 caractères de long. Il ne supporte que les chiffres et le dernier chiffre est
  111. une somme de contrôle calculée sur un modulo 10. C'est un code utilisé aux Etats-Unis et courant
  112. sur le marché. Il a été dépassé par EAN13.
  113. </para>
  114. </listitem>
  115. <listitem>
  116. <para>
  117. <emphasis>EAN13</emphasis>: EAN est un raccourci pour "European Article Number".
  118. </para>
  119. <para>
  120. Ce code doit faire 13 caractères de long, il ne supporte que les chiffres et le dernier chiffre est
  121. une somme de contrôle calculée sur un modulo 10. Ce standard est utilisé dans le monde et est très
  122. commun sur le marché.
  123. </para>
  124. </listitem>
  125. <listitem>
  126. <para>
  127. <emphasis>EAN14</emphasis>: EAN est un raccourci pour "European Article Number".
  128. </para>
  129. <para>
  130. Ce code fait 14 caractères de longueur et ne supporte que les chiffres. Le dernier chiffre
  131. représente la somme de contrôle calculée sur un modulo 10. Ce code barres est utilisé dans
  132. le monde pour la distribution. C'est le successeur de EAN13.
  133. </para>
  134. </listitem>
  135. <listitem>
  136. <para>
  137. <emphasis>EAN18</emphasis>: EAN est un raccourci pour "European Article Number".
  138. </para>
  139. <para>
  140. Ce code fait 18 caractères de longueur et ne supporte que les chiffres. Le dernier chiffre
  141. représente la somme de contrôle calculée sur un modulo 10. Ce code barres est utilisé pour
  142. identifier les conteneur d'envoi dans le transport.
  143. </para>
  144. </listitem>
  145. <listitem>
  146. <para>
  147. <emphasis>GTIN12</emphasis>: GTIN est le raccourci de "Global Trade Item Number".
  148. </para>
  149. <para>
  150. Ce code utilise le même standard que EAN12 et est son successeur. Il est utilisé paticulièrement
  151. aux Etats-Unis.
  152. </para>
  153. </listitem>
  154. <listitem>
  155. <para>
  156. <emphasis>GTIN13</emphasis>: GTIN est le raccourci de "Global Trade Item Number".
  157. </para>
  158. <para>
  159. Ce code utilise le même standard que EAN13 et est son successeur. Il est utilisé dans le monde
  160. entier par l'industrie.
  161. </para>
  162. </listitem>
  163. <listitem>
  164. <para>
  165. <emphasis>GTIN14</emphasis>: GTIN est le raccourci de "Global Trade Item Number".
  166. </para>
  167. <para>
  168. Ce code utilise le même standard que EAN14 et est son successeur. Il est utilisé dans le monde
  169. entier par l'industrie.
  170. </para>
  171. </listitem>
  172. <listitem>
  173. <para>
  174. <emphasis>IDENTCODE</emphasis>: Identcode est utilisé par Deutsche Post et DHL. C'est
  175. un cas particulier de Code25.
  176. </para>
  177. <para>
  178. Ce code fait 12 caractères de longueur et ne supporte que les chiffres. Le dernier chiffre
  179. représente la comme de contrôle calculée modulo 10. Ce code barres est utilisé principalement
  180. par les entreprises DP et DHL.
  181. </para>
  182. </listitem>
  183. <listitem>
  184. <para>
  185. <emphasis>INTELLIGENTMAIL</emphasis>: Intelligent Mail est utilisé par les services postaux.
  186. </para>
  187. <para>
  188. Ce code fait 20, 25, 29 ou 31 caractères de longueur. Il ne support que les chiffres et ne
  189. contient pas de somme de contrôle. Il est le successeur de <acronym>PLANET</acronym> et
  190. <acronym>POSTNET</acronym>. Il est utilisé principalement dans les services postaux aux
  191. Etats-Unis.
  192. </para>
  193. </listitem>
  194. <listitem>
  195. <para>
  196. <emphasis>ISSN</emphasis>: <acronym>ISSN</acronym> est l'abréviation de
  197. International Standard Serial Number.
  198. </para>
  199. <para>
  200. Ce code a une longueur de 8 ou 13 caractères. Il ne supporte que les chiffres et le dernier
  201. chiffre représente la somme de contrôle calculée sur un modulo 11. Il est utilisé dans
  202. le print à travers le monde.
  203. </para>
  204. </listitem>
  205. <listitem>
  206. <para>
  207. <emphasis>ITF14</emphasis>: ITF14 est l'implémentation GS1 de Interleaved Two
  208. of Five bar code.
  209. </para>
  210. <para>
  211. Ce code est une implémentation particulière de Interleaved 2 of 5. Il doit mesurer
  212. 14 caractères de long et est basé sur GTIN14. Il ne contient que des chiffres et le dernier
  213. chiffre est une somme de contrôle calculée sur un modulo 10. Il est utilisé dans le monde
  214. dans la distribution.
  215. </para>
  216. </listitem>
  217. <listitem>
  218. <para>
  219. <emphasis>LEITCODE</emphasis>: Leitcode est utilisé par Deutsche Post et DHL. C'est un cas
  220. particulier de Code25.
  221. </para>
  222. <para>
  223. Ce code mesure 14 caractères de longueur et ne supporte que les chiffres. Le dernier chiffre
  224. est une somme de contrôle calculée sur un modulo 10. Il est principalement utilisé par
  225. les entreprises DP et DHL.
  226. </para>
  227. </listitem>
  228. <listitem>
  229. <para>
  230. <emphasis>PLANET</emphasis>: Planet est l'abréviation de Postal Alpha Numeric
  231. Encoding Technique.
  232. </para>
  233. <para>
  234. Ce code fait 12 ou 14 caractères de long. Il ne supporte que les chiffres et le dernier
  235. chiffre est une somme de contrôle. Ce code barres est utilisé principalement dans les
  236. services postaux des Etats-Unis.
  237. </para>
  238. </listitem>
  239. <listitem>
  240. <para>
  241. <emphasis>POSTNET</emphasis>: Postnet est utilisé par le service des Postes des
  242. Etats-Unis.
  243. </para>
  244. <para>
  245. Ce code fait 6, 7, 10 ou 12 caractères. Il ne supporte que les chiffres et le dernier
  246. chiffre est une somme de contrôle. Ce code barres est utilisé dans les services postaux
  247. aux Etats-Unis principalement.
  248. </para>
  249. </listitem>
  250. <listitem>
  251. <para>
  252. <emphasis>ROYALMAIL</emphasis>: Royalmail est utilisé par Royal Mail.
  253. </para>
  254. <para>
  255. Ce code n'a pas de taille précise. Il supporte les chiffres, les lettres majuscules et le
  256. dernier caractère est une somme de contrôle. Ce standard est utilisé par Royal Mail pour le
  257. service Cleanmail. Il est aussi appelé <acronym>RM4SCC</acronym>.
  258. </para>
  259. </listitem>
  260. <listitem>
  261. <para>
  262. <emphasis>SSCC</emphasis>: SSCC est un raccourci pour "Serial Shipping Container
  263. Code".
  264. </para>
  265. <para>
  266. Ce code est une variante de EAN, il doit faire 18 caractères de long et ne supporte que
  267. les chiffres. Le dernier chiffre doit être la somme de contrôle qui est calculée sur un
  268. modulo 10. Ce code est utilisé principalement dans le transport.
  269. </para>
  270. </listitem>
  271. <listitem>
  272. <para>
  273. <emphasis>UPCA</emphasis>: UPC est le raccourci de "Univeral Product Code".
  274. </para>
  275. <para>
  276. Ce code a précédé EAN13. Il doit faire 12 caractères et ne supporte que les chiffres.
  277. Le dernier chiffre est une somme de contrôle calculée sur un modulo 10. Ce code barres
  278. est utilisé aux Etats-Unis.
  279. </para>
  280. </listitem>
  281. <listitem>
  282. <para>
  283. <emphasis>UPCE</emphasis>: UPCE est une variante simplifié et plus courte de UPCA.
  284. </para>
  285. <para>
  286. Il peut faire 6, 7 ou 8 caractères et ne supporte que les chiffres. Lorsqu'il fait 8
  287. caractères, il inclut une somme de contrôle calculée sur un modulo 10. Ce code barres
  288. est utilisé sur de petits produits sur lesquels UPCA ne pourrait pas tenir.
  289. </para>
  290. </listitem>
  291. </itemizedlist>
  292. <sect3 id="zend.validate.set.barcode.options">
  293. <title>Options supportées par Zend_Validate_Barcode</title>
  294. <para>
  295. Les options suivantes sont supportées par <classname>Zend_Validate_Barcode</classname>:
  296. </para>
  297. <itemizedlist>
  298. <listitem>
  299. <para>
  300. <emphasis><property>adapter</property></emphasis>: Affecte l'adaptateur de code
  301. barres à utiliser. La liste des adaptateurs est donnée ci-dessus. Si vous voulez préciser
  302. un adaptateur personnalisé, le nom complet de la classe est requis.
  303. </para>
  304. </listitem>
  305. <listitem>
  306. <para>
  307. <emphasis><property>checksum</property></emphasis>: <constant>TRUE</constant>
  308. si oui ou non utiliser une somme de contrôle. Notez que certains adaptateurs ne supportent
  309. pas un telle option.
  310. </para>
  311. </listitem>
  312. <listitem>
  313. <para>
  314. <emphasis><property>options</property></emphasis>: Affecte des options personnalisées pour
  315. un adaptateur personnalisé.
  316. </para>
  317. </listitem>
  318. </itemizedlist>
  319. </sect3>
  320. <sect3 id="zend.validate.set.barcode.basic">
  321. <title>Utilisation classique</title>
  322. <para>
  323. Pour valider si une chaine est un code barres, vous devez juste connaitre son type. Voyez l'exemple
  324. suivant pour un EAN13:
  325. </para>
  326. <programlisting language="php"><![CDATA[
  327. $valid = new Zend_Validate_Barcode('EAN13');
  328. if ($valid->isValid($input)) {
  329. // input semble être valide
  330. } else {
  331. // input est invalide
  332. }
  333. ]]></programlisting>
  334. </sect3>
  335. <sect3 id="zend.validate.set.barcode.checksum">
  336. <title>Somme de contrôle optionnelle</title>
  337. <para>
  338. Certains codes barres proposent une somme de contrôle. Ils peuvent être valides sans cette
  339. somme mais si vous préciser celle-la alors elle devra être validée. Par défaut la somme
  340. de contrôle n'est pas activée. En utilisant l'option <property>checksum</property> vous pouvez
  341. indiquer si oui ou non la somme de contrôle doit être vérifiée.
  342. </para>
  343. <programlisting language="php"><![CDATA[
  344. $valid = new Zend_Validate_Barcode(array(
  345. 'adapter' => 'EAN13',
  346. 'checksum' => false,
  347. ));
  348. if ($valid->isValid($input)) {
  349. // input semble être valide
  350. } else {
  351. // input est invalide
  352. }
  353. ]]></programlisting>
  354. <note>
  355. <title>Sécurité moindre en désactivant la validation de la somme de contrôle</title>
  356. <para>
  357. En désactivant la validation de la somme de contrôle vous réduirez la sécurité du
  358. code à barres. Aussi veuillez noter que si vous désactiver ce contrôle pour des
  359. codes l'utilisant vous risqueriez de considérer comme valides des codes barres
  360. qui ne le sont pas en réalité.
  361. </para>
  362. </note>
  363. </sect3>
  364. <sect3 id="zend.validate.set.barcode.custom">
  365. <title>Ecrire des validateurs personnalisés</title>
  366. <para>
  367. Vous pouvez créer vos propres validateurs pour <classname>Zend_Validate_Barcode</classname>;
  368. ce qui est nécessaire si vous traitez des codes barres propriétaires. Vous aurez alors besoin
  369. des informations suivantes.
  370. </para>
  371. <itemizedlist>
  372. <listitem>
  373. <para>
  374. <emphasis>Length</emphasis>: La taille du code barres. Peut être une des valeur suivantes:
  375. </para>
  376. <itemizedlist>
  377. <listitem>
  378. <para>
  379. <emphasis>Integer</emphasis>: Une valeur plus grande que zéro qui définit exactement
  380. le nombre de caractères du code barres.
  381. </para>
  382. </listitem>
  383. <listitem>
  384. <para>
  385. <emphasis>-1</emphasis>: Aucune limite de taille pour ce code barres.
  386. </para>
  387. </listitem>
  388. <listitem>
  389. <para>
  390. <emphasis>"even"</emphasis>: La taille du code barres doit être un nombre
  391. de caractères pair.
  392. </para>
  393. </listitem>
  394. <listitem>
  395. <para>
  396. <emphasis>"odd"</emphasis>: La taille du code barres doit être un nombre
  397. de caractères impair.
  398. </para>
  399. </listitem>
  400. <listitem>
  401. <para>
  402. <emphasis>array</emphasis>: Un tableau de valeurs entières. La taille du code
  403. barres doit être exactement égale à une des valeurs dans le tableau.
  404. </para>
  405. </listitem>
  406. </itemizedlist>
  407. </listitem>
  408. <listitem>
  409. <para>
  410. <emphasis>Characters</emphasis>: Une chaine qui contient tous les caractères autorisés
  411. pour ce code barres. La valeur entière spéciale 128 est autorisée ici, elle signifie
  412. "les 128 premiers caractères du jeu ASCII".
  413. </para>
  414. </listitem>
  415. <listitem>
  416. <para>
  417. <emphasis>Checksum</emphasis>: Une chaine utilisée comme callback pour valideer la
  418. somme de contrôle.
  419. </para>
  420. </listitem>
  421. </itemizedlist>
  422. <para>
  423. Votre validateur de code à barres personnalisé doit étendre
  424. <classname>Zend_Validate_Barcode_AdapterAbstract</classname> ou implémenter
  425. <interface>Zend_Validate_Barcode_AdapterInterface</interface>.
  426. </para>
  427. <para>
  428. Comme exemple, créons un validateur qui utilise un nombre pair de caractères pouvant être des
  429. chiffres et les lettres 'ABCDE'. Une somme de contrôle sera aussi calculée.
  430. </para>
  431. <programlisting language="php"><![CDATA[
  432. class My_Barcode_MyBar extends Zend_Validate_Barcode_AdapterAbstract
  433. {
  434. protected $_length = 'even';
  435. protected $_characters = '0123456789ABCDE';
  436. protected $_checksum = '_mod66';
  437. protected function _mod66($barcode)
  438. {
  439. // effectuer de la validation et retourner un booléen
  440. }
  441. }
  442. $valid = new Zend_Validate_Barcode('My_Barcode_MyBar');
  443. if ($valid->isValid($input)) {
  444. // input semble valide
  445. } else {
  446. // input est invalide
  447. }
  448. ]]></programlisting>
  449. </sect3>
  450. </sect2>
  451. <!--
  452. vim:se ts=4 sw=4 et:
  453. -->