https://github.com/mapado/sgkbarcodebundle
https://github.com/mapado/sgkbarcodebundle
Last synced: 22 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/mapado/sgkbarcodebundle
- Owner: mapado
- Created: 2016-03-22T16:45:30.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2024-12-31T10:07:59.000Z (over 1 year ago)
- Last Synced: 2025-11-20T22:04:30.481Z (6 months ago)
- Language: PHP
- Size: 138 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# SGKBarcodeBundle
[](https://travis-ci.org/mapado/SGKBarcodeBundle)
SGKBarcodeBundle is the Symfony Barcode Generator Bundle what you want!
This README is also available in French ([Français](Resources/doc/README_fr.md)) and Chinese ([中文](Resources/doc/README_zh-CN.md)).
Features:
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 use this laravel project: [dinesh/barcode](https://github.com/dineshrabara/barcode)
## Installation
Add SGKBarcodeBundle by running the command:
```sh
// Symfony version < 2.7
$ php composer require sgk/barcode-bundle:~1.0
// Symfony version >= 2.7
$ php composer.phar require sgk/barcode-bundle:~2.0
```
Or, add SGKBarcodeBundle to your ``composer.json``, then execute ``php composer.phar update``
```json
// Symfony version < 2.7
"require": {
"sgk/barcode-bundle": "~1.0"
}
// Symfony version >= 2.7
"require": {
"sgk/barcode-bundle": "~2.0"
}
```
Composer will install the bundle to your project's vendor/sgk directory.
Then, Enable the bundle in the kernel:
```php
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)
## Usage by service
The bundle registers one service: ``sgk_barcode.generator`` which will allows you to generate barcode:
* outpout html
```php
$options = array(
'code' => 'string to encode',
'type' => 'c128',
'format' => 'html',
);
$barcode =
$this->get('sgk_barcode.generator')->generate($options);
return new Response($barcode);
```
* outpout svg
```php
$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
```php
$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('
');
```
> 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](http://en.wikipedia.org/wiki/Data_URI_scheme) to direct display the png in webpage.
## 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.
``barcode`` use the same options, only different thing is your need pass a [Twig array](http://twig.sensiolabs.org/doc/templates.html#literals) (it looks really like Json, but it isn't) in the function.
* display html
```twig
{{ barcode({code: 'string to encode', type: 'c128', format: 'html'}) }}
```
* display svg
```twig
{{ barcode({code: 'string to encode', type: 'qrcode', format: 'svg', width: 10, height: 10, color: 'green'}) }}
```
* display png
```twig
%20}}%0A)
```
## Usage without service
```php
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!
* save as html
```php
$savePath = '/tmp/';
$fileName = 'sample.html';
file_put_contents($savePath.$fileName, $barcode);
```
* save as svg
```php
$savePath = '/tmp/';
$fileName = 'sample.svg';
file_put_contents($savePath.$fileName, $barcode);
```
* save as png
```php
$savePath = '/tmp/';
$fileName = 'sample.png';
file_put_contents($savePath.$fileName, base64_decode($barcode));
```
## Supported Barcode Types
Please read [Wikipedia page](http://en.wikipedia.org/wiki/Barcode) to know which type you should choice.
### 2d barcodes
|type |Name |Example(encode 123456)|
|:--------:|:-----------------------------------------------------:|:--------------------:|
|qrcode |[QR code](http://en.wikipedia.org/wiki/QR_code) ||
|pdf417 |[PDF417](http://en.wikipedia.org/wiki/PDF417) ||
|datamatrix|[Data Matrix](http://en.wikipedia.org/wiki/Data_Matrix)||
### 1d barcodes
|type |Symbology |Example(encode 123456)|
|:------:|:-----------------------------------------------------:|:--------------------:|
|c39 |[Code 39](http://en.wikipedia.org/wiki/Code_39) ||
|c39+ |Code 39 CHECK_DIGIT ||
|c39e |Code 39 EXTENDED ||
|c39e+ |Code 39 EXTENDED CHECK_DIGIT ||
|c93 |[Code 93](http://en.wikipedia.org/wiki/Code_93) ||
|s25 |[Standard 2 of 5](http://www.barcodeisland.com/2of5.phtml) ||
|s25+ |Standard 2 of 5 CHECK_DIGIT ||
|i25 |[Interleaved 2 of 5](http://en.wikipedia.org/wiki/Interleaved_2_of_5)||
|i25+ |Interleaved 2 of 5 CHECK_DIGIT ||
|c128 |[Code 128](http://en.wikipedia.org/wiki/Code_128) ||
|c128a |Code 128A||
|c128b |Code 128B||
|c128c |Code 128C||
|ean2 |[EAN 2](http://en.wikipedia.org/wiki/EAN_2) ||
|ean5 |[EAN 5](http://en.wikipedia.org/wiki/EAN_5) ||
|ean8 |[EAN 8](http://en.wikipedia.org/wiki/EAN-8) ||
|ean13 |[EAN 13](http://en.wikipedia.org/wiki/EAN-13) ||
|upca |[UPC-A](http://en.wikipedia.org/wiki/Universal_Product_Code)||
|upce |[UPC-B](http://en.wikipedia.org/wiki/Universal_Product_Code)||
|msi |[MSI](http://en.wikipedia.org/wiki/MSI_Barcode) ||
|msi+ |MSI CHECK_DIGIT ||
|postnet |[POSTNET](http://en.wikipedia.org/wiki/POSTNET) ||
|planet |[PLANET](http://en.wikipedia.org/wiki/Postal_Alpha_Numeric_Encoding_Technique)||
|rms4cc|[RMS4CC](http://en.wikipedia.org/wiki/RM4SCC) ||
|kix |[KIX-code](http://nl.wikipedia.org/wiki/KIX-code)||
|imb |[IM barcode](http://en.wikipedia.org/wiki/Intelligent_Mail_barcode)||
|codabar |[Codabar](http://en.wikipedia.org/wiki/Codabar) ||
|code11 |[Code 11](http://en.wikipedia.org/wiki/Code_11) ||
|pharma |[Pharmacode](http://en.wikipedia.org/wiki/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()).
- Barcodes requires [GD](http://php.net/manual/en/book.image.php) and [ImageMagick](http://php.net/manual/en/book.imagick.php) to create PNGs in PHP 5.3.
- Barcodes requires [PHP bcmath](http://php.net/manual/en/book.bc.php) extension for Intelligent Mail barcodes
## Tests
To execute unit tests:
```sh
$ phpunit --coverage-text
```