chrisandchris/barcode-bundle

Symfony 3 & 4 Barcode Generator Bundle with Twig function extension

SGKBarcodeBundle

SGKBarcodeBundle is a Symfony3 / 4 Barcode Generator Bundle., _(*1)

Features:, _(*2)

1. Support 3 two-dimensional (2D) and 30 one-dimensional (1D) Barcode types
2. Three output formats: HTML, PNG and SVG canvas
3. Twig integration: you can simply use a extensional function of Twig in the template to generate Barcode
4. Core of this bundle from this project tc-lib-barcode

, _(*3)

Installation

Add SGKBarcodeBundle by running the command:, _(*4)

$ php composer.phar require sgk/barcode-bundle:v2.0.0

Or, add SGKBarcodeBundle to your composer.json, then execute php composer.phar update, _(*5)

"require": {
        "sgk/barcode-bundle": "v2.0.0"
    }

Composer will install the bundle to your project's vendor/sgk directory., _(*6)

Then, Enable the bundle in the kernel:, _(*7)

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new SGK\BarcodeBundle\SGKBarcodeBundle(),
    );
}

If you are using Symfony 4 with Flex the line should have automatically been added to config/bundles.php, _(*8)

Generate options

To generate one barcode, you have 5 options can be configured., _(*9)

Default width and height for 2D barcode are 5, 5, for 1D are 2, 30. Default color for html, svg is black, for png is array(0, 0, 0), _(*10)

Usage by service

This is deprecated in version 3.4 and will break in Symfony 4. See 'usage without service' instead., _(*11)

The bundle registers one service: sgk_barcode.generator which will allows you to generate barcode:, _(*12)

• outpout html

$options = array(
    'code'   => 'string to encode',
    'type'   => 'c128',
    'format' => 'html',
);

$barcode =
    $this->get('sgk_barcode.generator')->generate($options);

return new Response($barcode);

• outpout svg

$options = array(
    'code'   => 'string to encode',
    'type'   => 'qrcode',
    'format' => 'svg',
    'width'  => 10,
    'height' => 10,
    'color'  => 'green',
);

$barcode =
    $this->get('sgk_barcode.generator')->generate($options);

return new Response($barcode);

• outpout png

$options = array(
    'code'   => 'string to encode',
    'type'   => 'datamatrix',
    'format' => 'png',
    'width'  => 10,
    'height' => 10,
    'color'  => array(127, 127, 127),
);

$barcode =
    $this->get('sgk_barcode.generator')->generate($options);

return new Response('<img src="data:image/png;base64,'.$barcode.'" />');

For format png, the generator return the based64 of png file, so you can get the real data of png by base64_decode($barcode). Here we use Data URI scheme to direct display the png in webpage., _(*13)

Usage in Twig template

This bundle extend one function of Twig: barcode which you can simply use it to generate barcode in the twig template., _(*14)

barcode use the same options, only different thing is your need pass a Twig array (it looks really like Json, but it isn't) in the function., _(*15)

• display html

{{ barcode({code: 'string to encode', type: 'c128', format: 'html'}) }}

• display svg

{{ barcode({code: 'string to encode', type: 'qrcode', format: 'svg', width: 10, height: 10, color: 'green'}) }}

• display png

<img src="data:image/png;base64,
{{ barcode({code: 'string to encode', type: 'datamatrix', format: 'png', width: 10, height: 10, color: [127, 127, 127]}) }}
" />

Usage without service

use SGK\BarcodeBundle\Generator\Generator;
//...
$options = array(
    'code'   => 'string to encode',
    'type'   => 'qrcode',
    'format' => 'html',
);

$generator = new Generator();
$barcode = $generator->generate($options);

return new Response($barcode);

Save Barcode in file

As you can see, the Bundle save nothing on the file system, But if you want to keep the barcode, No problem!, _(*16)

• save as html

$savePath = '/tmp/';
$fileName = 'sample.html';

file_put_contents($savePath.$fileName, $barcode);

• save as svg

$savePath = '/tmp/';
$fileName = 'sample.svg';

file_put_contents($savePath.$fileName, $barcode);

• save as png

$savePath = '/tmp/';
$fileName = 'sample.png';

file_put_contents($savePath.$fileName, base64_decode($barcode));

Supported Barcode Types

Please read Wikipedia page to know which type you should choice., _(*17)

2d barcodes

type	Name	Example(encode 123456)
qrcode	QR code
pdf417	PDF417
datamatrix	Data Matrix

1d barcodes

type	Symbology	Example(encode 123456)
c39	Code 39
c39+	Code 39 CHECK_DIGIT
c39e	Code 39 EXTENDED
c39e+	Code 39 EXTENDED CHECK_DIGIT
c93	Code 93
s25	Standard 2 of 5
s25+	Standard 2 of 5 CHECK_DIGIT
i25	Interleaved 2 of 5
i25+	Interleaved 2 of 5 CHECK_DIGIT
c128	Code 128
c128a	Code 128A
c128b	Code 128B
c128c	Code 128C
ean2	EAN 2
ean5	EAN 5
ean8	EAN 8
ean13	EAN 13
upca	UPC-A
upce	UPC-B
msi	MSI
msi+	MSI CHECK_DIGIT
postnet	POSTNET
planet	PLANET
rms4cc	RMS4CC
kix	KIX-code
imb	IM barcode
codabar	Codabar
code11	Code 11
pharma	Pharmacode
pharma2t	Pharmacode Two-Track

Requirements

If there is some problem of requirements, make sure you have install these two extensions of PHP (check in your phpinfo())., _(*18)

• Barcodes requires GD and ImageMagick to create PNGs in PHP 5.3.
• Barcodes requires PHP bcmath extension for Intelligent Mail barcodes

Tests

To execute unit tests, composer install and run:, _(*19)

phpunit --coverage-text