Reference

Barcode Objects

Barcode objects allow you to generate barcodes independently of the rendering support. After generation, you can retrieve the barcode as an array of drawing instructions to provide to a renderer.

Objects have a large number of options, most of which are common across all implementations. These options can be set in three ways:

• As an array or a Traversable object passed to the constructor.
• As an array passed to the setOptions() method.
• Via individual setters for each configuration type.

Different ways to parameterize a barcode object

use Laminas\Barcode\Object;

$options = ['text' => 'ZEND-FRAMEWORK', 'barHeight' => 40];

// Case 1: constructor
$barcode = new Object\Code39($options);

// Case 2: setOptions()
$barcode = new Object\Code39();
$barcode->setOptions($options);

// Case 3: individual setters
$barcode = new Object\Code39();
$barcode->setText('ZEND-FRAMEWORK')
    ->setBarHeight(40);

Common Options

In the following list, the values have no units; as such, we will use the generic term "unit." For example, the default value of the "thin bar" is "1 unit". The real units depend on the rendering support (see the [renderers documentation] (renderers.md) for more information).

Setters are each named by uppercasing the initial letter of the option and prefixing the name with "set" (e.g. barHeight becomes setBarHeight). All options have a corresponding getter prefixed with "get" (e.g. getBarHeight).

Available options are:

Text with checksum

Available since 2.8.0

With barcodes where checksum is mandatory (EAN 8, EAN 13, ITF 14, Leitcode, Identcode, UPC-A, UPC-E, Postnet, Royalmail) you can provide text with checksum:

$barcode = new Ean13([
    'text' => '1234567890128',
    'providedChecksum' => true,
]);

where 8 is checksum. Without checksum it will be:

$barcode = new Ean13([
    'text' => '123456789012',
]);

and the final result of the rendered barcode is the same.

Setting a common font for all objects

You can set a common font for all your objects by using the static method Laminas\Barcode\Barcode::setBarcodeFont(). This value can be always be overridden for individual objects by using the setFont() method.

use Laminas\Barcode\Barcode;

// In your bootstrap:
Barcode::setBarcodeFont('my_font.ttf');

// Later in your code:
Barcode::render(
    'code39',
    'pdf',
    ['text' => 'ZEND-FRAMEWORK']
); // will use 'my_font.ttf'

// or:
Barcode::render(
    'code39',
    'image',
    [
        'text' => 'ZEND-FRAMEWORK',
        'font' => 3,
    ]
); // will use the 3rd GD internal font

Common Additional Getters

Description of shipped barcodes

Below is detailed information on all barcode types supported. Unless otherwise noted, each barcode supports the general options outlined in the previous section, and no others.

Laminas\Barcode\Object\Error

This barcode is a special case. It is internally used to automatically render an exception caught by the component.

Laminas\Barcode\Object\Code128

• Name: Code 128
• Allowed characters: the complete ASCII-character set
• Checksum: optional (modulo 103)
• Length: variable

Laminas\Barcode\Object\Codabar

• Name: Codabar (or Code 2 of 7)
• Allowed characters: 0123456789-\$:/.+ with ABCD as start and stop characters
• Checksum: none
• Length: variable

Laminas\Barcode\Object\Code25

• Name: Code 25 (or Code 2 of 5 or Code 25 Industrial)
• Allowed characters: 0123456789
• Checksum: optional (modulo 10)
• Length: variable

Laminas\Barcode\Object\Code25interleaved

This barcode extends Laminas\Barcode\Object\Code25 (Code 2 of 5), with the following changes:

• Name: Code 2 of 5 Interleaved
• Allowed characters: 0123456789
• Checksum: optional (modulo 10)
• Length: variable (always even number of characters)

It also defines the following additional option:

If the number of characters is not even, Laminas\Barcode\Object\Code25interleaved will automatically prepend the missing zero to the barcode text.

Laminas\Barcode\Object\Ean2

This barcode extends Laminas\Barcode\Object\Ean5 (EAN 5), with the following changes:

• Name: EAN-2
• Allowed characters: 0123456789
• Checksum: Used internally, but not displayed
• Length: 2 characters

If the number of characters is lower than 2, Laminas\Barcode\Object\Ean2 will automatically prepend the missing zero to the barcode text.

Laminas\Barcode\Object\Ean5

This barcode extends Laminas\Barcode\Object\Ean13 (EAN 13), with the following changes:

• Name: EAN-5
• Allowed characters: 0123456789
• Checksum: Used internally, but not displayed
• Length: 5 characters

If the number of characters is lower than 5, Laminas\Barcode\Object\Ean5 will automatically prepend zeroes to the barcode text until it reaches 5 characters.

Laminas\Barcode\Object\Ean8

This barcode extends Laminas\Barcode\Object\Ean13 (EAN 13), with the following changes:

• Name: EAN-8
• Allowed characters: 0123456789
• Checksum: mandatory (modulo 10)
• Length: 8 characters (including checksum)

If the number of characters is lower than 8, Laminas\Barcode\Object\Ean8 will automatically prepend zeros to the barcode text until it reaches 8 characters.

Laminas\Barcode\Object\Ean13

• Name: EAN-13
• Allowed characters: 0123456789
• Checksum: mandatory (modulo 10)
• Length: 13 characters (including checksum)

If the number of characters is lower than 13, Laminas\Barcode\Object\Ean13 will automatically prepend zeros to the barcode text until it reaches 13 characters.

The option withQuietZones has no effect with this barcode.

Laminas\Barcode\Object\Code39

• Name: Code 39
• Allowed characters: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ -.\$/+%
• Checksum: optional (modulo 43)
• Length: variable

Laminas\Barcode\Object\Code39 automatically adds the start and stop characters (*) for you.

Laminas\Barcode\Object\Identcode

This barcode extends Laminas\Barcode\Object\Code25interleaved (Code 2 of 5 Interleaved), inheriting its capabilities and defining some of its own.

• Name: Identcode (Deutsche Post Identcode)
• Allowed characters: 0123456789
• Checksum: mandatory (modulo 10 different from Code25)
• Length: 12 characters (including checksum)

If the number of characters is lower than 12, Laminas\Barcode\Object\Identcode will automatically prepend missing zeros to the barcode text.

Laminas\Barcode\Object\Itf14

This barcode extends Laminas\Barcode\Object\Code25interleaved (Code 2 of 5 Interleaved), inheriting its capabilities and defining some of its own.

• Name: ITF-14
• Allowed characters: 0123456789
• Checksum: mandatory (modulo 10)
• Length: 14 characters (including checksum)

If the number of characters is lower than 14, Laminas\Barcode\Object\Itf14 will automatically prepend missing zeros to the barcode text.

Laminas\Barcode\Object\Leitcode

This barcode extends Laminas\Barcode\Object\Identcode (Deutsche Post Identcode), inheriting its capabilities and defining some of its own:

• Name: Leitcode (Deutsche Post Leitcode)
• Allowed characters: 0123456789
• Checksum: mandatory (modulo 10 different from Code25)
• Length: 14 characters (including checksum)

If the number of characters is lower than 14, Laminas\Barcode\Object\Leitcode will automatically prepend missing zeros to the barcode text.

Laminas\Barcode\Object\Planet

• Name: Planet (PostaL Alpha Numeric Encoding Technique)
• Allowed characters: 0123456789
• Checksum: mandatory (modulo 10)
• Length: 12 or 14 characters (including checksum)

Laminas\Barcode\Object\Postnet

• Name: Postnet (POSTal Numeric Encoding Technique)
• Allowed characters: 0123456789
• Checksum: mandatory (modulo 10)
• Length: 6, 7, 10, or 12 characters (including checksum)

Laminas\Barcode\Object\Royalmail

• Name: Royal Mail or RM4SCC (Royal Mail 4-State Customer Code)
• Allowed characters: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ
• Checksum: mandatory
• Length: variable

Laminas\Barcode\Object\Upca

This barcode extends Laminas\Barcode\Object\Ean13 (EAN-13), inheriting some of its capabilities and defining some of its own.

• Name: UPC-A (Universal Product Code)
• Allowed characters: 0123456789
• Checksum: mandatory (modulo 10)
• Length: 12 characters (including checksum)

If the number of characters is lower than 12, Laminas\Barcode\Object\Upca will automatically prepend missing zeros to the barcode text.

The option withQuietZones has no effect with this barcode.

Laminas\Barcode\Object\Upce

This barcode extends Laminas\Barcode\Object\Upca (UPC-A), inheriting some of its capabilities and defining some of its own. In particular, the first character of the text to encode is the system (0 or 1).

• Name: UPC-E (Universal Product Code)
• Allowed characters: 0123456789
• Checksum: mandatory (modulo 10)
• Length: 8 characters (including checksum)

If the number of characters is lower than 8, Laminas\Barcode\Object\Upce will automatically prepend missing zeros to the barcode text.

If the first character of the text to encode is not 0 or 1, Laminas\Barcode\Object\Upce will automatically replace it with 0.

The option withQuietZones has no effect with this barcode.