Programmer's Reference Guide

Introduction

Zend_Barcode
Programmer's Reference Guide

Barcode creation using Zend_Barcode class

Using Zend_Barcode::factory

Zend_Barcode uses a factory method to create an instance of a renderer that extends Zend_Barcode_Renderer_RendererAbstract. The factory method accepts five arguments.

The name of the barcode format (e.g., "code39") (required)
The name of the renderer (e.g., "image") (required)
Options to pass to the barcode object (an array or Zend_Config object) (optional)
Options to pass to the renderer object (an array or Zend_Config object) (optional)
Boolean to indicate whether or not to automatically render errors. If an exception occurs, the provided barcode object will be replaced with an Error representation (optional default TRUE)

Example #1 Getting a Renderer with Zend_Barcode::factory()

Zend_Barcode::factory() instantiates barcode objects and renderers and ties them together. In this first example, we will use the Code39 barcode type together with the Image renderer.

// Only the text to draw is required
$barcodeOptions = array('text' => 'ZEND-FRAMEWORK');
 
// No required options
$rendererOptions = array();
$renderer = Zend_Barcode::factory(
    'code39', 'image', $barcodeOptions, $rendererOptions
);

Example #2 Using Zend_Barcode::factory() with Zend_Config objects

You may pass a Zend_Config object to the factory in order to create the necessary objects. The following example is functionally equivalent to the previous.

// Using only one Zend_Config object
$config = new Zend_Config(array(
    'barcode'        => 'code39',
    'barcodeParams'  => array('text' => 'ZEND-FRAMEWORK'),
    'renderer'       => 'image',
    'rendererParams' => array('imageType' => 'gif'),
));
 
$renderer = Zend_Barcode::factory($config);

Drawing a barcode

When you draw the barcode, you retrieve the resource in which the barcode is drawn. To draw a barcode, you can call the draw() of the renderer, or simply use the proxy method provided by Zend_Barcode.

Example #3 Drawing a barcode with the renderer object

// Only the text to draw is required
$barcodeOptions = array('text' => 'ZEND-FRAMEWORK');
 
// No required options
$rendererOptions = array();
 
// Draw the barcode in a new image,
$imageResource = Zend_Barcode::factory(
    'code39', 'image', $barcodeOptions, $rendererOptions
)->draw();

Example #4 Drawing a barcode with Zend_Barcode::draw()

// Only the text to draw is required
$barcodeOptions = array('text' => 'ZEND-FRAMEWORK');
 
// No required options
$rendererOptions = array();
 
// Draw the barcode in a new image,
$imageResource = Zend_Barcode::draw(
    'code39', 'image', $barcodeOptions, $rendererOptions
);

Renderering a barcode

When you render a barcode, you draw the barcode, you send the headers and you send the resource (e.g. to a browser). To render a barcode, you can call the render() method of the renderer or simply use the proxy method provided by Zend_Barcode.

Example #5 Renderering a barcode with the renderer object

// Only the text to draw is required
$barcodeOptions = array('text' => 'ZEND-FRAMEWORK');
 
// No required options
$rendererOptions = array();
 
// Draw the barcode in a new image,
// send the headers and the image
Zend_Barcode::factory(
    'code39', 'image', $barcodeOptions, $rendererOptions
)->render();

This will generate this barcode:

Example #6 Renderering a barcode with Zend_Barcode::render()

// Only the text to draw is required
$barcodeOptions = array('text' => 'ZEND-FRAMEWORK');
 
// No required options
$rendererOptions = array();
 
// Draw the barcode in a new image,
// send the headers and the image
Zend_Barcode::render(
    'code39', 'image', $barcodeOptions, $rendererOptions
);

This will generate the same barcode as the previous example.

Introduction

Zend_Barcode
Programmer's Reference Guide

Zend_Barcode Objects

Comments

Posted by: prowler on: 2010-02-17 11:49:35 ⁋

In Example #5 I can't see no barcode (using Firefox 3.5).

Posted by: kevin quinn on: 2010-05-23 22:52:11 ⁋

this is not working. Please fix it. I'm new to ZF and I want to believe!!! :-)

Posted by: Mickael Perraud on: 2010-05-27 19:50:17 ⁋

If you are in MVC, think to deactivate layout and viewRenderer:



public function myAction() 
{
    $this->_helper->layout->disableLayout();
    $this->_helper->viewRenderer->setNoRender(); 
    Zend_Barcode::render(
        'code39', 'image', array('text' => 'ZEND-FRAMEWORK'), array()
    );
}

Posted by: zeng on: 2010-08-24 14:01:54 ⁋

this not working!!

Posted by: jay on: 2010-11-24 01:14:13 ⁋

Works for me! cool. @ zf version 1.10.7

Posted by: William on: 2011-01-26 04:55:35 ⁋

It works for me only if the text is CAPITALIZED, lowercase gives me an error "illegal characters"

Posted by: Nicolas Rios on: 2011-02-11 06:09:49 ⁋

Hello,
I'm interested to use this component into Yii Framework, but in not works ok.
I have this error when I render the object.

PHP Error

include(Zend_Barcode_Object_Code39.php)