documentation/manual/en/module_specs/Zend_Barcode-Objects_Details.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect2 id="zend.barcode.objects.details">
   4     <title>Description of shipped barcodes</title>
   5
   6     <para>
   7         You will find below detailed information about all barcode types shipped by default with
   8         Zend Framework.
   9     </para>
  10
  11     <sect3 id="zend.barcode.objects.details.error">
  12         <title>Zend_Barcode_Object_Error</title>
  13
  14         <para>
  15             <inlinegraphic width="400" align="center" valign="middle"
  16                 fileref="figures/zend.barcode.objects.details.error.png" format="PNG"/>
  17         </para>
  18
  19         <para>
  20             This barcode is a special case. It is internally used to automatically render
  21             an exception caught by the <classname>Zend_Barcode</classname> component.
  22         </para>
  23     </sect3>
  24
  25     <sect3 id="zend.barcode.objects.details.code25">
  26         <title>Zend_Barcode_Object_Code25</title>
  27
  28         <para>
  29             <inlinegraphic width="152" align="center" valign="middle"
  30                 fileref="figures/zend.barcode.objects.details.code25.png" format="PNG"/>
  31         </para>
  32
  33         <itemizedlist>
  34             <listitem>
  35                 <para>
  36                     <emphasis>Name:</emphasis> Code 25 (or Code 2 of 5 or Code 25 Industrial)
  37                 </para>
  38             </listitem>
  39
  40             <listitem>
  41                 <para>
  42                     <emphasis>Allowed characters:</emphasis> '0123456789'
  43                 </para>
  44             </listitem>
  45
  46             <listitem>
  47                 <para>
  48                     <emphasis>Checksum:</emphasis> optional (modulo 10)
  49                 </para>
  50             </listitem>
  51
  52             <listitem>
  53                 <para>
  54                     <emphasis>Length:</emphasis> variable
  55                 </para>
  56             </listitem>
  57         </itemizedlist>
  58
  59         <para>
  60             There are no particular options for this barcode.
  61         </para>
  62     </sect3>
  63
  64     <sect3 id="zend.barcode.objects.details.code25interleaved">
  65         <title>Zend_Barcode_Object_Code25interleaved</title>
  66
  67         <para>
  68             <inlinegraphic width="101" align="center" valign="middle"
  69                 fileref="figures/zend.barcode.objects.details.int25.png" format="PNG"/>
  70         </para>
  71
  72         <para>
  73             This barcode extends <classname>Zend_Barcode_Object_Code25</classname>
  74             (Code 2 of 5), and has the same particulars and options, and adds the following:
  75         </para>
  76
  77         <itemizedlist>
  78             <listitem>
  79                 <para>
  80                     <emphasis>Name:</emphasis> Code 2 of 5 Interleaved
  81                 </para>
  82             </listitem>
  83
  84             <listitem>
  85                 <para>
  86                     <emphasis>Allowed characters:</emphasis> '0123456789'
  87                 </para>
  88             </listitem>
  89
  90             <listitem>
  91                 <para>
  92                     <emphasis>Checksum:</emphasis> optional (modulo 10)
  93                 </para>
  94             </listitem>
  95
  96             <listitem>
  97                 <para>
  98                     <emphasis>Length:</emphasis> variable (always even number of characters)
  99                 </para>
 100             </listitem>
 101         </itemizedlist>
 102
 103         <para>
 104             Available options include:
 105         </para>
 106
 107         <table id="zend.barcode.objects.details.code25interleaved.table">
 108             <title>Zend_Barcode_Object_Code25interleaved Options</title>
 109
 110             <tgroup cols="4">
 111                 <thead>
 112                     <row>
 113                         <entry>Option</entry>
 114                         <entry>Data Type</entry>
 115                         <entry>Default Value</entry>
 116                         <entry>Description</entry>
 117                     </row>
 118                 </thead>
 119
 120                 <tbody>
 121                     <row>
 122                         <entry><emphasis>withBearerBars</emphasis></entry>
 123                         <entry><type>Boolean</type></entry>
 124                         <entry><constant>FALSE</constant></entry>
 125                         <entry>Draw a thick bar at the top and the bottom of the barcode.</entry>
 126                     </row>
 127                 </tbody>
 128             </tgroup>
 129         </table>
 130
 131         <note>
 132             <para>
 133                 If the number of characters is not even,
 134                 <classname>Zend_Barcode_Object_Code25interleaved</classname> will automatically
 135                 prepend the missing zero to the barcode text.
 136             </para>
 137         </note>
 138     </sect3>
 139
 140     <sect3 id="zend.barcode.objects.details.ean2">
 141         <title>Zend_Barcode_Object_Ean2</title>
 142
 143         <para>
 144             <inlinegraphic width="41" align="center" valign="middle"
 145                 fileref="figures/zend.barcode.objects.details.ean2.png" format="PNG"/>
 146         </para>
 147
 148         <para>
 149             This barcode extends <classname>Zend_Barcode_Object_Ean5</classname>
 150             (<acronym>EAN</acronym> 5), and has the same particulars and options, and adds the
 151             following:
 152         </para>
 153
 154         <itemizedlist>
 155             <listitem>
 156                 <para>
 157                     <emphasis>Name:</emphasis> <acronym>EAN</acronym>-2
 158                 </para>
 159             </listitem>
 160
 161             <listitem>
 162                 <para>
 163                     <emphasis>Allowed characters:</emphasis> '0123456789'
 164                 </para>
 165             </listitem>
 166
 167             <listitem>
 168                 <para>
 169                     <emphasis>Checksum:</emphasis> only use internally but not displayed
 170                 </para>
 171             </listitem>
 172
 173             <listitem>
 174                 <para>
 175                     <emphasis>Length:</emphasis> 2 characters
 176                 </para>
 177             </listitem>
 178         </itemizedlist>
 179
 180         <para>
 181             There are no particular options for this barcode.
 182         </para>
 183
 184         <note>
 185             <para>
 186                 If the number of characters is lower than 2,
 187                 <classname>Zend_Barcode_Object_Ean2</classname> will automatically
 188                 prepend the missing zero to the barcode text.
 189             </para>
 190         </note>
 191     </sect3>
 192
 193     <sect3 id="zend.barcode.objects.details.ean5">
 194         <title>Zend_Barcode_Object_Ean5</title>
 195
 196         <para>
 197             <inlinegraphic width="68" align="center" valign="middle"
 198                 fileref="figures/zend.barcode.objects.details.ean5.png" format="PNG"/>
 199         </para>
 200
 201         <para>
 202             This barcode extends <classname>Zend_Barcode_Object_Ean13</classname>
 203             (<acronym>EAN</acronym> 13), and has the same particulars and options, and adds the
 204             following:
 205         </para>
 206
 207         <itemizedlist>
 208             <listitem>
 209                 <para>
 210                     <emphasis>Name:</emphasis> <acronym>EAN</acronym>-5
 211                 </para>
 212             </listitem>
 213
 214             <listitem>
 215                 <para>
 216                     <emphasis>Allowed characters:</emphasis> '0123456789'
 217                 </para>
 218             </listitem>
 219
 220             <listitem>
 221                 <para>
 222                     <emphasis>Checksum:</emphasis> only use internally but not displayed
 223                 </para>
 224             </listitem>
 225
 226             <listitem>
 227                 <para>
 228                     <emphasis>Length:</emphasis> 5 characters
 229                 </para>
 230             </listitem>
 231         </itemizedlist>
 232
 233         <para>
 234             There are no particular options for this barcode.
 235         </para>
 236
 237         <note>
 238             <para>
 239                 If the number of characters is lower than 5,
 240                 <classname>Zend_Barcode_Object_Ean5</classname> will automatically
 241                 prepend the missing zero to the barcode text.
 242             </para>
 243         </note>
 244     </sect3>
 245
 246     <sect3 id="zend.barcode.objects.details.ean8">
 247         <title>Zend_Barcode_Object_Ean8</title>
 248
 249         <para>
 250             <inlinegraphic width="82" align="center" valign="middle"
 251                 fileref="figures/zend.barcode.objects.details.ean8.png" format="PNG"/>
 252         </para>
 253
 254         <para>
 255             This barcode extends <classname>Zend_Barcode_Object_Ean13</classname>
 256             (<acronym>EAN</acronym> 13), and has the same particulars and options, and adds the
 257             following:
 258         </para>
 259
 260         <itemizedlist>
 261             <listitem>
 262                 <para>
 263                     <emphasis>Name:</emphasis> <acronym>EAN</acronym>-8
 264                 </para>
 265             </listitem>
 266
 267             <listitem>
 268                 <para>
 269                     <emphasis>Allowed characters:</emphasis> '0123456789'
 270                 </para>
 271             </listitem>
 272
 273             <listitem>
 274                 <para>
 275                     <emphasis>Checksum:</emphasis> mandatory (modulo 10)
 276                 </para>
 277             </listitem>
 278
 279             <listitem>
 280                 <para>
 281                     <emphasis>Length:</emphasis> 8 characters (including checksum)
 282                 </para>
 283             </listitem>
 284         </itemizedlist>
 285
 286         <para>
 287             There are no particular options for this barcode.
 288         </para>
 289
 290         <note>
 291             <para>
 292                 If the number of characters is lower than 8,
 293                 <classname>Zend_Barcode_Object_Ean8</classname> will automatically
 294                 prepend the missing zero to the barcode text.
 295             </para>
 296         </note>
 297     </sect3>
 298
 299     <sect3 id="zend.barcode.objects.details.ean13">
 300         <title>Zend_Barcode_Object_Ean13</title>
 301
 302         <para>
 303             <inlinegraphic width="113" align="center" valign="middle"
 304                 fileref="figures/zend.barcode.objects.details.ean13.png" format="PNG"/>
 305         </para>
 306
 307         <itemizedlist>
 308             <listitem>
 309                 <para>
 310                     <emphasis>Name:</emphasis> <acronym>EAN</acronym>-13
 311                 </para>
 312             </listitem>
 313
 314             <listitem>
 315                 <para>
 316                     <emphasis>Allowed characters:</emphasis> '0123456789'
 317                 </para>
 318             </listitem>
 319
 320             <listitem>
 321                 <para>
 322                     <emphasis>Checksum:</emphasis> mandatory (modulo 10)
 323                 </para>
 324             </listitem>
 325
 326             <listitem>
 327                 <para>
 328                     <emphasis>Length:</emphasis> 13 characters (including checksum)
 329                 </para>
 330             </listitem>
 331         </itemizedlist>
 332
 333         <para>
 334             There are no particular options for this barcode.
 335         </para>
 336
 337         <note>
 338             <para>
 339                 If the number of characters is lower than 13,
 340                 <classname>Zend_Barcode_Object_Ean13</classname> will automatically
 341                 prepend the missing zero to the barcode text.
 342             </para>
 343
 344             <para>
 345                 The option <property>withQuietZones</property> has no effect with this barcode.
 346             </para>
 347         </note>
 348     </sect3>
 349
 350     <sect3 id="zend.barcode.objects.details.code39">
 351         <title>Zend_Barcode_Object_Code39</title>
 352
 353         <para>
 354             <inlinegraphic width="275" align="center" valign="middle"
 355                 fileref="figures/zend.barcode.introduction.example-1.png" format="PNG"/>
 356         </para>
 357
 358         <itemizedlist>
 359             <listitem>
 360                 <para>
 361                     <emphasis>Name:</emphasis> Code 39
 362                 </para>
 363             </listitem>
 364
 365             <listitem>
 366                 <para>
 367                     <emphasis>Allowed characters:</emphasis>
 368                     '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ -.$/+%'
 369                 </para>
 370             </listitem>
 371
 372             <listitem>
 373                 <para>
 374                     <emphasis>Checksum:</emphasis> optional (modulo 43)
 375                 </para>
 376             </listitem>
 377
 378             <listitem>
 379                 <para>
 380                     <emphasis>Length:</emphasis> variable
 381                 </para>
 382             </listitem>
 383         </itemizedlist>
 384
 385         <note>
 386             <para>
 387                 <classname>Zend_Barcode_Object_Code39</classname> will automatically add
 388                 the start and stop characters ('*') for you.
 389             </para>
 390         </note>
 391
 392         <para>
 393             There are no particular options for this barcode.
 394         </para>
 395     </sect3>
 396
 397     <sect3 id="zend.barcode.objects.details.identcode">
 398         <title>Zend_Barcode_Object_Identcode</title>
 399
 400         <para>
 401             <inlinegraphic width="137" align="center" valign="middle"
 402                 fileref="figures/zend.barcode.objects.details.identcode.png" format="PNG"/>
 403         </para>
 404
 405         <para>
 406             This barcode extends <classname>Zend_Barcode_Object_Code25interleaved</classname>
 407             (Code 2 of 5 Interleaved), and inherits some of its capabilities; it also has a few
 408             particulars of its own.
 409         </para>
 410
 411         <itemizedlist>
 412             <listitem>
 413                 <para>
 414                     <emphasis>Name:</emphasis> Identcode (Deutsche Post Identcode)
 415                 </para>
 416             </listitem>
 417
 418             <listitem>
 419                 <para>
 420                     <emphasis>Allowed characters:</emphasis> '0123456789'
 421                 </para>
 422             </listitem>
 423
 424             <listitem>
 425                 <para>
 426                     <emphasis>Checksum:</emphasis> mandatory (modulo 10 different from Code25)
 427                 </para>
 428             </listitem>
 429
 430             <listitem>
 431                 <para>
 432                     <emphasis>Length:</emphasis> 12 characters (including checksum)
 433                 </para>
 434             </listitem>
 435         </itemizedlist>
 436
 437         <para>
 438             There are no particular options for this barcode.
 439         </para>
 440
 441         <note>
 442             <para>
 443                 If the number of characters is lower than 12,
 444                 <classname>Zend_Barcode_Object_Identcode</classname> will automatically prepend
 445                 missing zeros to the barcode text.
 446             </para>
 447         </note>
 448     </sect3>
 449
 450     <sect3 id="zend.barcode.objects.details.itf14">
 451         <title>Zend_Barcode_Object_Itf14</title>
 452
 453         <para>
 454             <inlinegraphic width="155" align="center" valign="middle"
 455                 fileref="figures/zend.barcode.objects.details.itf14.png" format="PNG"/>
 456         </para>
 457
 458         <para>
 459             This barcode extends <classname>Zend_Barcode_Object_Code25interleaved</classname>
 460             (Code 2 of 5 Interleaved), and inherits some of its capabilities; it also has a few
 461             particulars of its own.
 462         </para>
 463
 464         <itemizedlist>
 465             <listitem>
 466                 <para>
 467                     <emphasis>Name:</emphasis> <acronym>ITF</acronym>-14
 468                 </para>
 469             </listitem>
 470
 471             <listitem>
 472                 <para>
 473                     <emphasis>Allowed characters:</emphasis> '0123456789'
 474                 </para>
 475             </listitem>
 476
 477             <listitem>
 478                 <para>
 479                     <emphasis>Checksum:</emphasis> mandatory (modulo 10)
 480                 </para>
 481             </listitem>
 482
 483             <listitem>
 484                 <para>
 485                     <emphasis>Length:</emphasis> 14 characters (including checksum)
 486                 </para>
 487             </listitem>
 488         </itemizedlist>
 489
 490         <para>
 491             There are no particular options for this barcode.
 492         </para>
 493
 494         <note>
 495             <para>
 496                 If the number of characters is lower than 14,
 497                 <classname>Zend_Barcode_Object_Itf14</classname> will automatically prepend
 498                 missing zeros to the barcode text.
 499             </para>
 500         </note>
 501     </sect3>
 502
 503     <sect3 id="zend.barcode.objects.details.leitcode">
 504         <title>Zend_Barcode_Object_Leitcode</title>
 505
 506         <para>
 507             <inlinegraphic width="155" align="center" valign="middle"
 508                 fileref="figures/zend.barcode.objects.details.leitcode.png" format="PNG"/>
 509         </para>
 510
 511         <para>
 512             This barcode extends <classname>Zend_Barcode_Object_Identcode</classname>
 513             (Deutsche Post Identcode), and inherits some of its capabilities; it also has a few
 514             particulars of its own.
 515         </para>
 516
 517         <itemizedlist>
 518             <listitem>
 519                 <para>
 520                     <emphasis>Name:</emphasis> Leitcode (Deutsche Post Leitcode)
 521                 </para>
 522             </listitem>
 523
 524             <listitem>
 525                 <para>
 526                     <emphasis>Allowed characters:</emphasis> '0123456789'
 527                 </para>
 528             </listitem>
 529
 530             <listitem>
 531                 <para>
 532                     <emphasis>Checksum:</emphasis> mandatory (modulo 10 different from Code25)
 533                 </para>
 534             </listitem>
 535
 536             <listitem>
 537                 <para>
 538                     <emphasis>Length:</emphasis> 14 characters (including checksum)
 539                 </para>
 540             </listitem>
 541         </itemizedlist>
 542
 543         <para>
 544             There are no particular options for this barcode.
 545         </para>
 546
 547         <note>
 548             <para>
 549                 If the number of characters is lower than 14,
 550                 <classname>Zend_Barcode_Object_Leitcode</classname> will automatically
 551                 prepend missing zeros to the barcode text.
 552             </para>
 553         </note>
 554     </sect3>
 555
 556     <sect3 id="zend.barcode.objects.details.planet">
 557         <title>Zend_Barcode_Object_Planet</title>
 558
 559         <para>
 560             <inlinegraphic width="286" align="center" valign="middle"
 561                 fileref="figures/zend.barcode.objects.details.planet.png" format="PNG"/>
 562         </para>
 563
 564         <itemizedlist>
 565             <listitem>
 566                 <para>
 567                     <emphasis>Name:</emphasis> Planet (PostaL Alpha Numeric Encoding Technique)
 568                 </para>
 569             </listitem>
 570
 571             <listitem>
 572                 <para>
 573                     <emphasis>Allowed characters:</emphasis> '0123456789'
 574                 </para>
 575             </listitem>
 576
 577             <listitem>
 578                 <para>
 579                     <emphasis>Checksum:</emphasis> mandatory (modulo 10)
 580                 </para>
 581             </listitem>
 582
 583             <listitem>
 584                 <para>
 585                     <emphasis>Length:</emphasis> 12 or 14 characters (including checksum)
 586                 </para>
 587             </listitem>
 588         </itemizedlist>
 589
 590         <para>
 591             There are no particular options for this barcode.
 592         </para>
 593     </sect3>
 594
 595     <sect3 id="zend.barcode.objects.details.postnet">
 596         <title>Zend_Barcode_Object_Postnet</title>
 597
 598         <para>
 599             <inlinegraphic width="286" align="center" valign="middle"
 600                 fileref="figures/zend.barcode.objects.details.postnet.png" format="PNG"/>
 601         </para>
 602
 603         <itemizedlist>
 604             <listitem>
 605                 <para>
 606                     <emphasis>Name:</emphasis> Postnet (POSTal Numeric Encoding Technique)
 607                 </para>
 608             </listitem>
 609
 610             <listitem>
 611                 <para>
 612                     <emphasis>Allowed characters:</emphasis> '0123456789'
 613                 </para>
 614             </listitem>
 615
 616             <listitem>
 617                 <para>
 618                     <emphasis>Checksum:</emphasis> mandatory (modulo 10)
 619                 </para>
 620             </listitem>
 621
 622             <listitem>
 623                 <para>
 624                     <emphasis>Length:</emphasis> 6, 7, 10 or 12 characters (including checksum)
 625                 </para>
 626             </listitem>
 627         </itemizedlist>
 628
 629         <para>
 630             There are no particular options for this barcode.
 631         </para>
 632     </sect3>
 633
 634     <sect3 id="zend.barcode.objects.details.royalmail">
 635         <title>Zend_Barcode_Object_Royalmail</title>
 636
 637         <para>
 638             <inlinegraphic width="158" align="center" valign="middle"
 639                 fileref="figures/zend.barcode.objects.details.royalmail.png" format="PNG"/>
 640         </para>
 641
 642         <itemizedlist>
 643             <listitem>
 644                 <para>
 645                     <emphasis>Name:</emphasis> Royal Mail or <acronym>RM4SCC</acronym> (Royal Mail
 646                     4-State Customer Code)
 647                 </para>
 648             </listitem>
 649
 650             <listitem>
 651                 <para>
 652                     <emphasis>Allowed characters:</emphasis> '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'
 653                 </para>
 654             </listitem>
 655
 656             <listitem>
 657                 <para>
 658                     <emphasis>Checksum:</emphasis> mandatory
 659                 </para>
 660             </listitem>
 661
 662             <listitem>
 663                 <para>
 664                     <emphasis>Length:</emphasis> variable
 665                 </para>
 666             </listitem>
 667         </itemizedlist>
 668
 669         <para>
 670             There are no particular options for this barcode.
 671         </para>
 672     </sect3>
 673
 674     <sect3 id="zend.barcode.objects.details.upca">
 675         <title>Zend_Barcode_Object_Upca</title>
 676
 677         <para>
 678             <inlinegraphic width="115" align="center" valign="middle"
 679                 fileref="figures/zend.barcode.objects.details.upca.png" format="PNG"/>
 680         </para>
 681
 682         <para>
 683             This barcode extends <classname>Zend_Barcode_Object_Ean13</classname>
 684             (<acronym>EAN</acronym>-13), and inherits some of its capabilities; it also has a few
 685             particulars of its own.
 686         </para>
 687
 688         <itemizedlist>
 689             <listitem>
 690                 <para>
 691                     <emphasis>Name:</emphasis> <acronym>UPC</acronym>-A (Universal Product Code)
 692                 </para>
 693             </listitem>
 694
 695             <listitem>
 696                 <para>
 697                     <emphasis>Allowed characters:</emphasis> '0123456789'
 698                 </para>
 699             </listitem>
 700
 701             <listitem>
 702                 <para>
 703                     <emphasis>Checksum:</emphasis> mandatory (modulo 10)
 704                 </para>
 705             </listitem>
 706
 707             <listitem>
 708                 <para>
 709                     <emphasis>Length:</emphasis> 12 characters (including checksum)
 710                 </para>
 711             </listitem>
 712         </itemizedlist>
 713
 714         <para>
 715             There are no particular options for this barcode.
 716         </para>
 717
 718         <note>
 719             <para>
 720                 If the number of characters is lower than 12,
 721                 <classname>Zend_Barcode_Object_Upca</classname> will automatically
 722                 prepend missing zeros to the barcode text.
 723             </para>
 724
 725             <para>
 726                 The option <property>withQuietZones</property> has no effect with this barcode.
 727             </para>
 728         </note>
 729     </sect3>
 730
 731     <sect3 id="zend.barcode.objects.details.upce">
 732         <title>Zend_Barcode_Object_Upce</title>
 733
 734         <para>
 735             <inlinegraphic width="71" align="center" valign="middle"
 736                 fileref="figures/zend.barcode.objects.details.upce.png" format="PNG"/>
 737         </para>
 738
 739         <para>
 740             This barcode extends <classname>Zend_Barcode_Object_Upca</classname>
 741             (<acronym>UPC</acronym>-A), and inherits some of its capabilities; it also has a few
 742             particulars of its own. The first character of the text to encode
 743             is the system (0 or 1).
 744         </para>
 745
 746         <itemizedlist>
 747             <listitem>
 748                 <para>
 749                     <emphasis>Name:</emphasis> <acronym>UPC</acronym>-E (Universal Product Code)
 750                 </para>
 751             </listitem>
 752
 753             <listitem>
 754                 <para>
 755                     <emphasis>Allowed characters:</emphasis> '0123456789'
 756                 </para>
 757             </listitem>
 758
 759             <listitem>
 760                 <para>
 761                     <emphasis>Checksum:</emphasis> mandatory (modulo 10)
 762                 </para>
 763             </listitem>
 764
 765             <listitem>
 766                 <para>
 767                     <emphasis>Length:</emphasis> 8 characters (including checksum)
 768                 </para>
 769             </listitem>
 770         </itemizedlist>
 771
 772         <para>
 773             There are no particular options for this barcode.
 774         </para>
 775
 776         <note>
 777             <para>
 778                 If the number of characters is lower than 8,
 779                 <classname>Zend_Barcode_Object_Upce</classname> will automatically
 780                 prepend missing zeros to the barcode text.
 781             </para>
 782         </note>
 783
 784         <note>
 785             <para>
 786                 If the first character of the text to encode is not 0 or 1,
 787                 <classname>Zend_Barcode_Object_Upce</classname> will automatically
 788                 replace it by 0.
 789             </para>
 790
 791             <para>
 792                 The option <property>withQuietZones</property> has no effect with this barcode.
 793             </para>
 794         </note>
 795     </sect3>
 796 </sect2>