Zend_Validate-Barcode.xml 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 20003 -->
  3. <!-- Reviewed: no -->
  4. <sect2 id="zend.validate.set.barcode">
  5. <title>Barcode</title>
  6. <para>
  7. <classname>Zend_Validate_Barcode</classname> erlaubt es zu prüfen ob ein gegebener Wert als
  8. Barcode repräsentiert werden kann.
  9. </para>
  10. <para>
  11. <classname>Zend_Validate_Barcode</classname> unterstützt viele Barcode Standards und kann
  12. sehr einfach mit prorietären Barcode Implementationen erweitert werden. Die folgenden
  13. Barcode Standards werden unterstützt:
  14. </para>
  15. <itemizedlist>
  16. <listitem>
  17. <para>
  18. <emphasis>CODE25</emphasis>: Oft auch "Two of Five" oder "Code 25 Industrial"
  19. genannt.
  20. </para>
  21. <para>
  22. Dieser Barcode hat keine Begrenzung der Länge. Es unterstützt nur Ziffern, und die
  23. letzte Ziffer kann eine optionale Checksumme sein welche durch Modulo 10 berechnet
  24. wird. Dieser Standard sehr alt und wird heutzutage nicht oft verwendet. Übliche
  25. Anwendungsfälle liegen in der Industrie.
  26. </para>
  27. </listitem>
  28. <listitem>
  29. <para>
  30. <emphasis>CODE25INTERLEAVED</emphasis>: Oft auch "Code 2 of 5 Interleaved" genannt.
  31. </para>
  32. <para>
  33. Dieser Standard ist eine Variante von CODE25. Er hat keine Begrenzung der Länge,
  34. muss aber eine gerade Anzahl an Zeichen enthalten. Es unterstützt nur Ziffern, und
  35. die letzte Ziffer kann eine optionale Checksumme sein welche durch Modulo 10
  36. berechnet wird. Dieser Standard wird weltweit verwendet und üblicherweise im Handel.
  37. </para>
  38. </listitem>
  39. <listitem>
  40. <para>
  41. <emphasis>CODE39</emphasis>: CODE39 ist einer der ältesten vorhandenen Codes.
  42. </para>
  43. <para>
  44. Dieser Barcode hat eine variable Länge. Er unterstützt Ziffern, großgeschriebene
  45. alphabetische Zeichen und 7 spezielle Zeichen wie Leerzeichen, Punkte und
  46. Dollarzeichen. Er kann eine optionale Checksumme enthalten welche durch Modulo 43
  47. berechnet wird. Dieser Standard wird weltweit verwendet und üblicherweise in der
  48. Industrie.
  49. </para>
  50. </listitem>
  51. <listitem>
  52. <para>
  53. <emphasis>CODE39EXT</emphasis>: CODE39EXT ist eine Erweiterung von CODE39.
  54. </para>
  55. <para>
  56. Dieser Barcode hat die gleichen Eigenschaften wie CODE39. Zusätzlich erlaubt er die
  57. Verwendung aller 128 ASCII Zeichen. Dieser Standard wird weltweit verwendet und
  58. ist in der Industrie üblich.
  59. </para>
  60. </listitem>
  61. <listitem>
  62. <para>
  63. <emphasis>CODE93</emphasis>: CODE93 ist der Nachfolger von CODE39.
  64. </para>
  65. <para>
  66. Dieser Barcode hat eine variable Länge. Er unterstützt Ziffern, alphabetische
  67. Zeichen und 7 spezielle Zeichen. Er enthält eine Checksumme welche durch Modulo 47
  68. berechnet wird und aus 2 Zeichen besteht. Dieser Standard produziert einen
  69. kompakteren Code als CODE39 und ist sicherer.
  70. </para>
  71. </listitem>
  72. <listitem>
  73. <para>
  74. <emphasis>EAN8</emphasis>: EAN ist die Abkürzung für "European Article Number".
  75. </para>
  76. <para>
  77. Dieser Barcode muss eine Länge von 8 Zeichen haben. Er unterstützt nur Ziffern wobei
  78. die letzte Ziffer immer eine Checksumme ist. Dieser Standard wird weltweit
  79. verwendet, hat aber eine sehr begrenzte Reichweite. Er kann auf kleinen Artikeln
  80. gefunden werden wo ein längerer Barcode nicht gedruckt werden könnte.
  81. </para>
  82. </listitem>
  83. <listitem>
  84. <para>
  85. <emphasis>EAN12</emphasis>: EAN ist die Abkürzung für "European Article Number".
  86. </para>
  87. <para>
  88. Dieser Barcode muss eine Länge von 12 Zeichen haben. Er unterstützt nur Ziffern
  89. wobei die letzte Ziffer immer eine Checksumme ist welche durch Modulo 10 berechnet
  90. wird. Dieser Standard wird in der USA verwendet und hierbei üblicherweise im Handel.
  91. Er wurde ersetzt durch EAN13.
  92. </para>
  93. </listitem>
  94. <listitem>
  95. <para>
  96. <emphasis>EAN13</emphasis>: EAN ist die Abkürzung für "European Article Number".
  97. </para>
  98. <para>
  99. Dieser Barcode muss eine Länge von 13 Zeichen haben. Er unterstützt nur Ziffern
  100. wobei die letzte Ziffer immer eine Checksumme ist welche durch Modulo 10 berechnet
  101. wird. Dieser Standard wird weltweit verwendet, üblicherweise im Handel.
  102. </para>
  103. </listitem>
  104. <listitem>
  105. <para>
  106. <emphasis>EAN14</emphasis>: EAN ist die Abkürzung für "European Article Number".
  107. </para>
  108. <para>
  109. Dieser Barcode muss eine Länge von 14 Zeichen haben. Er unterstützt nur Ziffern
  110. wobei die letzte Ziffer immer eine Checksumme ist welche durch Modulo 10 berechnet
  111. wird. Dieser Standard wird weltweit verwendet, üblicherweise im Handel. Er ist der
  112. Nachfolger von EAN13.
  113. </para>
  114. </listitem>
  115. <listitem>
  116. <para>
  117. <emphasis>EAN18</emphasis>: EAN ist die Abkürzung für "European Article Number".
  118. </para>
  119. <para>
  120. Dieser Barcode muss eine Länge von 18 Zeichen haben. Er unterstützt nur Ziffern.
  121. Die letzte Ziffer ist immer eine Checksumme welche durch Modulo 10 berechnet wird.
  122. Dieser Code wird ost für die Identifizierung von Transport Containern verwendet.
  123. </para>
  124. </listitem>
  125. <listitem>
  126. <para>
  127. <emphasis>GTIN12</emphasis>: GTIN ist die Abkürzung für "Global Trade Item Number".
  128. </para>
  129. <para>
  130. Dieser Barcode verwendet den gleichen Standard wie EAN12 und ist sein Nachfolger.
  131. Er wird üblicherweise in den USA verwendet.
  132. </para>
  133. </listitem>
  134. <listitem>
  135. <para>
  136. <emphasis>GTIN13</emphasis>: GTIN ist die Abkürzung für "Global Trade Item Number".
  137. </para>
  138. <para>
  139. Dieser Barcode verwendet den gleichen Standard wie EAN13 und ist sein Nachfolger.
  140. Er wird weltweit von der Industrie verwendet.
  141. </para>
  142. </listitem>
  143. <listitem>
  144. <para>
  145. <emphasis>GTIN14</emphasis>: GTIN ist die Abkürzung für "Global Trade Item Number".
  146. </para>
  147. <para>
  148. Dieser Barcode verwendet den gleichen Standard wie EAN14 und ist sein Nachfolger.
  149. Er wird weltweit verwendet, üblicherweise im Handel.
  150. </para>
  151. </listitem>
  152. <listitem>
  153. <para>
  154. <emphasis>IDENTCODE</emphasis>: Identcode wird von Deutsche Post und DHL verwendet.
  155. Es ist eine spezialisierte Implementation von Code25.
  156. </para>
  157. <para>
  158. Dieser Barcode muss eine Länge von 12 Zeichen haben. Er unterstützt nur Ziffern und
  159. die letzte Ziffer ist immer eine Checksumme die mit Modulo 10 berechnet wird. Dieser
  160. Standard wird hauptsächlich von den Firmen DP und DHL verwendet.
  161. </para>
  162. </listitem>
  163. <listitem>
  164. <para>
  165. <emphasis>ITF14</emphasis>: ITF14 ist die GS1 Implementation des Interleaved Two of
  166. Five Barcodes.
  167. </para>
  168. <para>
  169. Dieser Barcode ist eine spezielle Variante von Interleaved 2 of 5. Er muss eine
  170. Länge von 14 Zeichen haben und basiert auf GTIN14. Er unterstützt nur Ziffern wobei
  171. die letzte Ziffer die Ziffer einer Checksumme ist welche durch Modulo 10 berechnet
  172. wird. Er wird weltweit verwendet, üblicherweise im Handel.
  173. </para>
  174. </listitem>
  175. <listitem>
  176. <para>
  177. <emphasis>LEITCODE</emphasis>: Leitcode wird von Deutsche Post und DHL verwendet.
  178. Er ist eine spezialisierte Implementation von Code25.
  179. </para>
  180. <para>
  181. Dieser Barcode muss eine Länge von 14 Zeichen haben. Er unterstützt nur Ziffern,
  182. wobei die letzte Ziffer immer eine Checksumme ist welche durch Modulo 10 berechnet
  183. wird. Dieser Standard wird hauptsächlich von den Firmen DP und DHL verwendet.
  184. </para>
  185. </listitem>
  186. <listitem>
  187. <para>
  188. <emphasis>SSCC</emphasis>: SSCC ist die Abkürzung für "Serial Shipping Container
  189. Code".
  190. </para>
  191. <para>
  192. Dieser Barcode ist eine Variante des EAN Barcodes. Er muss eine Länge von 18 Zeichen
  193. enthalten und unterstützt nur Ziffern. Die letzte Ziffer muss ein Ziffer für eine
  194. Checksumme sein welche durch Modulo 10 berechnet wird. Er wird üblicherweise in der
  195. Transport Industrie verwendet.
  196. </para>
  197. </listitem>
  198. <listitem>
  199. <para>
  200. <emphasis>UPCA</emphasis>: UPC ist die Abkürzung für "Univeral Product Code".
  201. </para>
  202. <para>
  203. Dieser Barcode ist der Vorgänger von EAN13. Er muss eine Länge von 12 Zeichen haben
  204. und unterstützt nur Ziffern. Die letzte Ziffer muss die Ziffer einer Checksumme sein
  205. welche durch Modulo 10 berechnet wird. Er wird üblicherweise in den USA verwendet.
  206. </para>
  207. </listitem>
  208. <listitem>
  209. <para>
  210. <emphasis>UPCE</emphasis>: UPCE ist die kurze Variante von UPCA.
  211. </para>
  212. <para>
  213. Dieser Barcode ist die kleinere Variante von UPCA. Er muss eine Länge von 6, 7 oder
  214. 8 Zeichen haben und unterstützt nur Ziffern. Wenn der Barcode 8 Ziffern lang ist
  215. enthält er eine Checksumme die durch Modulo 10 berechnet wird. Er wird üblicherweise
  216. bei kleinen Produkten verwendet wo ein UPCA Barcode nicht passen würde.
  217. </para>
  218. </listitem>
  219. </itemizedlist>
  220. <sect3 id="zend.validate.set.barcode.basic">
  221. <title>Grundsätzliche Verwendung</title>
  222. <para>
  223. Um zu prüfen ob ein angegebener String ein Barcode ist muss man nur dessen Typ wissen.
  224. Siehe das folgende Beispiel für einen EAN13 Barcode:
  225. </para>
  226. <programlisting language="php"><![CDATA[
  227. $valid = new Zend_Validate_Barcode('EAN13');
  228. if ($valid->isValid($input)) {
  229. // Die Eingabe scheint gültig zu sein
  230. } else {
  231. // Die Eingabe ist ungültig
  232. }
  233. ]]></programlisting>
  234. </sect3>
  235. <sect3 id="zend.validate.set.barcode.checksum">
  236. <title>Optionale Checksumme</title>
  237. <para>
  238. Einige Barcodes können mit einer optionalen Checksumme angegeben werden. Diese Barcodes
  239. würden gültig sein, selbst ohne Checksumme. Trotzdem, wenn eine Checksumme angegeben
  240. wird, dann sollte man Sie auch prüfen. Standardmäßig führen diese Barcode Typen keine
  241. Prüfung der Checksumme durch. Durch Verwendung der Option <property>checksum</property>
  242. kann man definieren ob die Checksumme geprüft oder ignoriert wird.
  243. </para>
  244. <programlisting language="php"><![CDATA[
  245. $valid = new Zend_Validate_Barcode(array(
  246. 'adapter' => 'EAN13',
  247. 'checksum' => false,
  248. ));
  249. if ($valid->isValid($input)) {
  250. // Die Eingabe scheint gültig zu sein
  251. } else {
  252. // Die Eingabe ist ungültig
  253. }
  254. ]]></programlisting>
  255. <note>
  256. <title>Reduzierte Sicherheit durch ausgeschaltete Prüfung der Checksumme</title>
  257. <para>
  258. Indem die Prüfung der Checksumme ausgeschaltet wird, verringert man auch die
  259. Sicherheit der verwendeten Barcodes. Zusätzlich sollte man beachten dass man
  260. die Prüfung der Checksumme für jene Barcode Typen ausschalten kann welche einen
  261. Wert für die Checksumme enthalten müssen. Barcodes welche nicht gültig wären
  262. könnten dann als gültig zurückgegeben werden, selbst wenn Sie es nicht sind.
  263. </para>
  264. </note>
  265. </sect3>
  266. <sect3 id="zend.validate.set.barcode.custom">
  267. <title>Schreiben eigener Adapter</title>
  268. <para>
  269. Man kann eigene Barcode Prüfungen für die Verwendung mit
  270. <classname>Zend_Validate_Barcode</classname> schreiben; das ist oft notwendig wenn man
  271. mit proprietären Barcodes arbeiten muss. Um eine eigene Barcode Prüfung zu schreiben
  272. benötigt man die folgenden Informationen.
  273. </para>
  274. <itemizedlist>
  275. <listitem>
  276. <para>
  277. <emphasis>Length</emphasis>: Die Länge welche der Barcode haben muss. Diese kann
  278. einen der folgenden Werte haben:
  279. </para>
  280. <itemizedlist>
  281. <listitem>
  282. <para>
  283. <emphasis>Integer</emphasis>: Ein Wert größer als 0, was bedeutet das
  284. der Barcode diese Länge haben muss.
  285. </para>
  286. </listitem>
  287. <listitem>
  288. <para>
  289. <emphasis>-1</emphasis>: Es gibt keine Begrenzung der Länge für diesen
  290. Barcode.
  291. </para>
  292. </listitem>
  293. <listitem>
  294. <para>
  295. <emphasis>"even"</emphasis>: Die Länge dieses Barcodes muss eine gerade
  296. Anzahl an Ziffern enthalten.
  297. </para>
  298. </listitem>
  299. <listitem>
  300. <para>
  301. <emphasis>"odd"</emphasis>: Die Länge dieses Barcodes muss eine ungerade
  302. Anzahl an Ziffern enthalten.
  303. </para>
  304. </listitem>
  305. <listitem>
  306. <para>
  307. <emphasis>array</emphasis>: Ein Array von Integer Werten. Die Länge
  308. dieses Barcodes muss einer der gesetzten Array Werte haben.
  309. </para>
  310. </listitem>
  311. </itemizedlist>
  312. </listitem>
  313. <listitem>
  314. <para>
  315. <emphasis>Characters</emphasis>: Ein String der die erlaubten Zeichen für diesen
  316. Barcode enthält. Auhc der Integer Wert 128 ist erlaubt, was für die ersten 128
  317. Zeichen der ASCII Tabelle steht.
  318. </para>
  319. </listitem>
  320. <listitem>
  321. <para>
  322. <emphasis>Checksum</emphasis>: Ein Strung der als Callback für eine Methode
  323. verwendet wird, welche die Prüfung der Checksumme durchführt.
  324. </para>
  325. </listitem>
  326. </itemizedlist>
  327. <para>
  328. Die eigene Barcode Prüfung muss
  329. <classname>Zend_Validate_Barcode_AdapterAbstract</classname> erweitern oder
  330. <interface>Zend_Validate_Barcode_AdapterInterface</interface> implementieren.
  331. </para>
  332. <para>
  333. Als Beispiel, erstellen wir eine Prüfung welche eine gerade Anzahl an Zeichen erwartet
  334. welche alle Ziffern und die Zeichen 'ABCDE' enthalten kann, und die eine Checksumme
  335. benötigt.
  336. </para>
  337. <programlisting language="php"><![CDATA[
  338. class My_Barcode_MyBar extends Zend_Validate_Barcode_AdapterAbstract
  339. {
  340. protected $_length = 'even';
  341. protected $_characters = '0123456789ABCDE';
  342. protected $_checksum = '_mod66';
  343. protected function _mod66($barcode)
  344. {
  345. // Mach einige Prüfungen und gib ein Boolean zurück
  346. }
  347. }
  348. $valid = new Zend_Validate_Barcode('My_Barcode_MyBar');
  349. if ($valid->isValid($input)) {
  350. // Die Eingabe scheint gültig zu sein
  351. } else {
  352. // Die Eingabe ist ungültig
  353. }
  354. ]]></programlisting>
  355. </sect3>
  356. </sect2>
  357. <!--
  358. vim:se ts=4 sw=4 et:
  359. -->