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:

Different ways to parameterize a barcode object

use Zend\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:

Option Data Type Default Value Description
barcodeNamespace string Zend\Barcode\Object Namespace of the barcode; for example, if you need to extend the embedding objects.
barHeight int 50 Height of the bars.
barThickWidth int 3 Width of the thick bar.
barThinWidth int 1 Width of the thin bar.
factor int, float, string, or Bool 1 Factor by which to multiply bar widths and font sizes (barHeight, barThinWidth, barThickWidth, and fontSize).
foreColor int 0x000000 (black) Color of the bar and the text. Could be provided as an integer or as a HTML value (e.g. #333333).
backgroundColor int or string 0xFFFFFF (white) Color of the background. Could be provided as an integer or as a HTML value (e.g. #333333).
orientation int, float, string, or Bool 0 Orientation of the barcode.
font string or Int NULL Font path to a TTF font or a number between 1 and 5 if using image generation with GD (internal fonts).
fontSize float 10 Size of the font (not applicable with numeric fonts).
withBorder bool FALSE Draw a border around the barcode and the quiet zones.
withQuietZones bool TRUE Leave a quiet zone before and after the barcode.
drawText bool TRUE Set if the text is displayed below the barcode.
stretchText bool FALSE Specify if the text is stretched all along the barcode.
withChecksum bool FALSE Indicate whether or not the checksum is automatically added to the barcode.
withChecksumInText bool FALSE Indicate whether or not the checksum is displayed in the textual representation.
text string NULL The text to represent as a barcode.

Setting a common font for all objects

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

use Zend\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

Getter Data Type Description
getType() string Return the name of the barcode class without the namespace (e.g. Zend\Barcode\Object\Code39 returns simply "code39").
getRawText() string Return the original text provided to the object.
getTextToDisplay() string Return the text to display, including, if activated, the checksum value.
getQuietZone() int Return the size of the space needed before and after the barcode without any drawing.
getInstructions() array Return drawing instructions as an array..
getHeight($recalculate = false) int Return the height of the barcode calculated after possible rotation.
getWidth($recalculate = false) int Return the width of the barcode calculated after possible rotation.
getOffsetTop($recalculate = false) int Return the position of the top of the barcode calculated after possible rotation.
getOffsetLeft($recalculate = false) int Return the position of the left of the barcode calculated after possible rotation.

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.

Zend\Barcode\Object\Error

error

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

Zend\Barcode\Object\Code128

image

Zend\Barcode\Object\Codabar

image

Zend\Barcode\Object\Code25

image

Zend\Barcode\Object\Code25interleaved

image

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

It also defines the following additional option:

Option Data Type Default Value Description
withBearerBars bool FALSE Draw a thick bar at the top and the bottom of the barcode.

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

Zend\Barcode\Object\Ean2

image

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

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

Zend\Barcode\Object\Ean5

image

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

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

Zend\Barcode\Object\Ean8

image

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

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

Zend\Barcode\Object\Ean13

image

If the number of characters is lower than 13, Zend\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.

Zend\Barcode\Object\Code39

image

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

Zend\Barcode\Object\Identcode

image

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

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

Zend\Barcode\Object\Itf14

image

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

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

Zend\Barcode\Object\Leitcode

image

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

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

Zend\Barcode\Object\Planet

image

Zend\Barcode\Object\Postnet

image

Zend\Barcode\Object\Royalmail

image

Zend\Barcode\Object\Upca

image

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

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

The option withQuietZones has no effect with this barcode.

Zend\Barcode\Object\Upce

image

This barcode extends Zend\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).

If the number of characters is lower than 8, Zend\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, Zend\Barcode\Object\Upce will automatically replace it with 0.

The option withQuietZones has no effect with this barcode.