Merge pull request #91 from picqer/v2

Version 2

Author: casperbakker

.github/workflows/phpunit.yml

@@ -1,4 +1,4 @@
-name: PHP Composer
+name: phpunit
 
 on: [push]
 
@@ -18,7 +18,7 @@ jobs:
       uses: shivammathur/setup-php@v1
       with:
         php-version: ${{ matrix.php-versions }}
-        extensions: mbstring, gd
+        extensions: mbstring, gd, bcmath, imagick
 
     - name: Validate composer.json
       run: composer validate

.gitignore

@@ -1,5 +1,3 @@
-.idea
-.DS_Store
 vendor
 composer.lock
-composer.phar
+composer.phar

.travis.yml

@@ -7,6 +7,8 @@ php:
 
 sudo: false
 
+before_script: yes | pecl install imagick
+
 install: composer install --no-interaction --prefer-source
 
 script: vendor/bin/phpunit

CHANGELOG.md

@@ -0,0 +1,52 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [2.0.0] - 2020-01-11
+### Added
+- Introduced Barcode and BarcodeBar classes to standardise generator output.
+- Introduced methods to force use of GD or Imagick, see readme.
+- Loads of new tests added, including tests on Github Actions.
+
+### Changed
+- Splitted all barcode types to different files.
+- Refactored a lot of code for better readability, stricter checking, and to be more efficient.
+- Merged JPG and PNG generators, because of duplicate code.
+
+### Fixed
+- Fixed a bug in Codabar generation 2d1128f5222d9368fc6151d2b51801ea29ba1052
+- Do not draw multiple bars on the same position #74
+- Do not try to draw barcodes for empty strings #42
+- Fixed possible casting issue in Codabar #92
+
+## [0.4.0] - 2019-12-31
+### Added
+- Added support for PHP 7.4, thanks to @pilif #80
+
+## [0.3.0] - 2019-01-12
+### Added
+- SVG: Add viewBox attribute to allow svg scaling #68 by @cuchac
+- Adjust CODE_128 to handle odd number of digits #55 by @richayles
+
+### Fixed
+- Bugfix update imagick function #51 by @Keinbockwurst
+
+## [0.2.2] - 2017-09-28
+### Added
+- Raising exceptions if we cannot generate JPG or PNG because of missing libraries. Thanks @OskarStark
+
+## [0.2.1] - 2016-10-24
+### Fixed
+- Bugfixes for wrong constant values.
+
+## [0.2.0] - 2016-05-14
+### Added
+- This release adds exceptions to this package. Now it is easier to detect if the generated barcode is correct or not.
+
+## [0.1.0] - 2015-08-13
+### Added
+- Everything. First release of this package.

Readme.md

@@ -1,9 +1,14 @@
-# PHP Barcode Generator [![Build Status](https://travis-ci.org/picqer/php-barcode-generator.svg?branch=master)](https://travis-ci.org/picqer/php-barcode-generator) [![Total Downloads](https://poser.pugx.org/picqer/php-barcode-generator/downloads)](https://packagist.org/packages/picqer/php-barcode-generator)
+# PHP Barcode Generator 
+[![Build Status](https://travis-ci.org/picqer/php-barcode-generator.svg?branch=master)](https://travis-ci.org/picqer/php-barcode-generator) [![Github Actions](https://github.com/picqer/php-barcode-generator/workflows/phpunit/badge.svg)](https://travis-ci.org/picqer/php-barcode-generator) [![Total Downloads](https://poser.pugx.org/picqer/php-barcode-generator/downloads)](https://packagist.org/packages/picqer/php-barcode-generator)
+
 This is an easy to use, non-bloated, framework independent, barcode generator in PHP.
 
 It creates SVG, PNG, JPG and HTML images, from the most used 1D barcode standards.
 
-*The codebase is largely from the [TCPDF barcode generator](https://github.com/tecnickcom/TCPDF) by Nicola Asuni. This code is therefor licensed under LGPLv3. It is still a bit of a mess, bit I will clean it in the future. I do not expect the interface of this class will change during the clean ups.*
+*The codebase is based on the [TCPDF barcode generator](https://github.com/tecnickcom/TCPDF) by Nicola Asuni. This code is therefor licensed under LGPLv3.*
+
+## No support for...
+We do not support any 2D barcodes, like QR codes. We also only generate the 'bars' part of a barcode. If you want text of the code below the barcode, you could add it later to the output of this package. 
 
 ## Installation
 Install through [composer](https://getcomposer.org/doc/00-intro.md):
@@ -18,16 +23,33 @@ If you want to generate PNG or JPG images, you need the GD library or Imagick in
 Initiate the barcode generator for the output you want, then call the ->getBarcode() routine as many times as you want.
 
 ```php
+<?php
+require 'vendor/autoload.php';
+
+// This will output the barcode as HTML output to display in the browser
 $generator = new Picqer\Barcode\BarcodeGeneratorHTML();
 echo $generator->getBarcode('081231723897', $generator::TYPE_CODE_128);
 ```
 
-The ->getBarcode() routine accepts the following:
-- $code Data for the barcode
-- $type Type of barcode, use the constants defined in the class
-- $widthFactor Width is based on the length of the data, with this factor you can make the barcode bars wider than default
-- $totalHeight The total height of the barcode
-- $color Hex code of the foreground color
+The `getBarcode()` method accepts the following parameters:
+- `$barcode` String needed to encode in the barcode
+- `$type` Type of barcode, use the constants defined in the class
+- `$widthFactor` Width is based on the length of the data, with this factor you can make the barcode bars wider than default
+- `$height` The total height of the barcode in pixels
+- `$foregroundColor` Hex code as string, or array of RGB, of the colors of the bars (the foreground color)
+
+Example of usage of all parameters:
+
+```php
+<?php
+
+require 'vendor/autoload.php';
+
+$redColor = [255, 0, 0];
+
+$generator = new Picqer\Barcode\BarcodeGeneratorPNG();
+file_put_contents('barcode.png', $generator->getBarcode('081231723897', $generator::TYPE_CODE_128, 3, 50, $redColor));
+```
 
 ## Image types
 ```php
@@ -37,7 +59,11 @@ $generatorJPG = new Picqer\Barcode\BarcodeGeneratorJPG();
 $generatorHTML = new Picqer\Barcode\BarcodeGeneratorHTML();
 ```
 
-## Accepted types
+## Accepted barcode types
+These barcode types are supported. All types support different character sets or have mandatory lengths. Please see wikipedia for supported chars and lengths per type.
+
+Most used types are TYPE_CODE_128 and TYPE_CODE_39. Because of the best scanner support, variable length and most chars supported.
+
 - TYPE_CODE_39
 - TYPE_CODE_39_CHECKSUM
 - TYPE_CODE_39E
@@ -69,10 +95,26 @@ $generatorHTML = new Picqer\Barcode\BarcodeGeneratorHTML();
 - TYPE_PHARMA_CODE
 - TYPE_PHARMA_CODE_TWO_TRACKS
 
+[See example images for all supported barcode types](examples.md)
+
+## A note about PNG and JPG images
+If you want to use PNG or JPG images, you need to install [Imagick](https://www.php.net/manual/en/intro.imagick.php) or the [GD library](https://www.php.net/manual/en/intro.image.php). This package will use Imagick if that is installed, or fall back to GD. If you have both installed but you want a specific method, you can use `$generator->useGd()` or `$generator->useImagick()` to force your preference.
+
 ## Examples
-Embedded PNG image in HTML:
 
+### Embedded PNG image in HTML
 ```php
-$generator = new \Picqer\Barcode\BarcodeGeneratorPNG();
+$generator = new Picqer\Barcode\BarcodeGeneratorPNG();
 echo '<img src="data:image/png;base64,' . base64_encode($generator->getBarcode('081231723897', $generator::TYPE_CODE_128)) . '">';
 ```
+
+### Save JPG barcode to disk
+```php
+$generator = new Picqer\Barcode\BarcodeGeneratorJPG();
+file_put_contents('barcode.jpg', $generator->getBarcode('081231723897', $generator::TYPE_CODABAR));
+```
+
+### Oneliner SVG output to disk
+```php
+file_put_contents('barcode.svg', (new Picqer\Barcode\BarcodeGeneratorSVG())->getBarcode('6825ME601', Picqer\Barcode\BarcodeGeneratorSVG::TYPE_KIX));
+```

composer.json

@@ -13,15 +13,22 @@
         },
         {
             "name": "Casper Bakker",
-            "email": "[email protected]"
+            "email": "[email protected]",
+            "homepage": "https://picqer.com"
         }
     ],
     "require": {
-        "php": ">=7.2.0"
+        "php": ">=7.2.0",
+        "ext-mbstring": "*"
     },
     "require-dev": {
         "phpunit/phpunit": "^8.5"
     },
+    "suggest": {
+        "ext-bcmath": "Barcode IMB (Intelligent Mail Barcode) needs bcmath extension",
+        "ext-gd": "For JPG and PNG generators, GD or Imagick is required",
+        "ext-imagick": "For JPG and PNG generators, GD or Imagick is required"
+    },
     "autoload": {
         "psr-4": {
             "Picqer\\Barcode\\": "src"

examples.md

@@ -0,0 +1,129 @@
+# Examples of supported barcodes
+
+These are examples of supported barcodes with this library.
+
+
+
+### C39
+
+![Barcode 1234567890abcABC as C39](tests/verified-files/C39-1234567890abcABC.svg)
+
+### C39+
+
+![Barcode 1234567890abcABC as C39+](tests/verified-files/C39+-1234567890abcABC.svg)
+
+### C39E+
+
+![Barcode 1234567890abcABC as C39E+](tests/verified-files/C39E+-1234567890abcABC.svg)
+
+### C93
+
+![Barcode 1234567890abcABC as C93](tests/verified-files/C93-1234567890abcABC.svg)
+
+### S25
+
+![Barcode 1234567890 as S25](tests/verified-files/S25-1234567890.svg)
+
+### S25+
+
+![Barcode 1234567890 as S25+](tests/verified-files/S25+-1234567890.svg)
+
+### I25
+
+![Barcode 1234567890 as I25](tests/verified-files/I25-1234567890.svg)
+
+### I25+
+
+![Barcode 1234567890 as I25+](tests/verified-files/I25+-1234567890.svg)
+
+### EAN13
+
+![Barcode 081231723897 as EAN13](tests/verified-files/EAN13-081231723897.svg)
+
+![Barcode 0049000004632 as EAN13](tests/verified-files/EAN13-0049000004632.svg)
+
+![Barcode 004900000463 as EAN13](tests/verified-files/EAN13-004900000463.svg)
+
+### C128
+
+![Barcode 081231723897 as C128](tests/verified-files/C128-081231723897.svg)
+
+![Barcode 1234567890abcABC-283*33 as C128](tests/verified-files/C128-1234567890abcABC-283*33.svg)
+
+### C128A
+
+![Barcode 1234567890 as C128A](tests/verified-files/C128A-1234567890.svg)
+
+### C128B
+
+![Barcode 081231723897 as C128B](tests/verified-files/C128B-081231723897.svg)
+
+![Barcode 1234567890abcABC-283*33 as C128B](tests/verified-files/C128B-1234567890abcABC-283*33.svg)
+
+### EAN2
+
+![Barcode 22 as EAN2](tests/verified-files/EAN2-22.svg)
+
+### EAN5
+
+![Barcode 1234567890abcABC-283*33 as EAN5](tests/verified-files/EAN5-1234567890abcABC-283*33.svg)
+
+### EAN8
+
+![Barcode 1234568 as EAN8](tests/verified-files/EAN8-1234568.svg)
+
+### UPCA
+
+![Barcode 123456789 as UPCA](tests/verified-files/UPCA-123456789.svg)
+
+### UPCE
+
+![Barcode 123456789 as UPCE](tests/verified-files/UPCE-123456789.svg)
+
+### MSI
+
+![Barcode 123456789 as MSI](tests/verified-files/MSI-123456789.svg)
+
+### MSI+
+
+![Barcode 123456789 as MSI+](tests/verified-files/MSI+-123456789.svg)
+
+### POSTNET
+
+![Barcode 123456789 as POSTNET](tests/verified-files/POSTNET-123456789.svg)
+
+### PLANET
+
+![Barcode 123456789 as PLANET](tests/verified-files/PLANET-123456789.svg)
+
+### RMS4CC
+
+![Barcode 123456789 as RMS4CC](tests/verified-files/RMS4CC-123456789.svg)
+
+### KIX
+
+![Barcode 123456789 as KIX](tests/verified-files/KIX-123456789.svg)
+
+### IMB
+
+![Barcode 123456789 as IMB](tests/verified-files/IMB-123456789.svg)
+
+### CODABAR
+
+![Barcode 123456789 as CODABAR](tests/verified-files/CODABAR-123456789.svg)
+
+### CODE11
+
+![Barcode 123456789 as CODE11](tests/verified-files/CODE11-123456789.svg)
+
+### PHARMA
+
+![Barcode 123456789 as PHARMA](tests/verified-files/PHARMA-123456789.svg)
+
+### PHARMA2T
+
+![Barcode 123456789 as PHARMA2T](tests/verified-files/PHARMA2T-123456789.svg)
+
+
+
+*This file is generated by generate-examples.php*

generate-examples.php

@@ -0,0 +1,22 @@
+<?php
+
+require('vendor/autoload.php');
+require(__DIR__ . '/tests/VerifiedBarcodeTest.php');
+$verifiedFiles = VerifiedBarcodeTest::$supportedBarcodes;
+
+$result = [];
+$result[] = '# Examples of supported barcodes';
+$result[] = 'These are examples of supported barcodes with this library.';
+$result[] = '';
+
+foreach ($verifiedFiles as $verifiedFile) {
+    $result[] = '### ' . $verifiedFile['type'];
+    foreach ($verifiedFile['barcodes'] as $barcode) {
+        $result[] = sprintf('![Barcode %s as %s](tests/verified-files/%s-%s.svg)', $barcode, $verifiedFile['type'], $verifiedFile['type'], $barcode);
+    }
+}
+
+$result[] = '';
+$result[] = '*This file is generated by generate-examples.php*';
+
+file_put_contents('examples.md', implode(PHP_EOL . PHP_EOL, $result));

generate-verified-files.php

@@ -1,10 +1,6 @@
 <?php
 
-include('src/BarcodeGenerator.php');
-include('src/BarcodeGeneratorPNG.php');
-include('src/BarcodeGeneratorSVG.php');
-include('src/BarcodeGeneratorJPG.php');
-include('src/BarcodeGeneratorHTML.php');
+require('vendor/autoload.php');
 
 $generatorSVG = new Picqer\Barcode\BarcodeGeneratorSVG();
 file_put_contents('tests/verified-files/081231723897-ean13.svg', $generatorSVG->getBarcode('081231723897', $generatorSVG::TYPE_EAN_13));
@@ -14,3 +10,15 @@
 
 $generatorSVG = new Picqer\Barcode\BarcodeGeneratorSVG();
 file_put_contents('tests/verified-files/0049000004632-ean13.svg', $generatorSVG->getBarcode('0049000004632', $generatorSVG::TYPE_EAN_13));
+
+
+// New style of verified files
+require(__DIR__ . '/tests/VerifiedBarcodeTest.php');
+$verifiedFiles = VerifiedBarcodeTest::$supportedBarcodes;
+
+$generatorSVG = new Picqer\Barcode\BarcodeGeneratorSVG();
+foreach ($verifiedFiles as $verifiedFile) {
+    foreach ($verifiedFile['barcodes'] as $barcode) {
+        file_put_contents('tests/verified-files/' . $verifiedFile['type'] . '-' . $barcode . '.svg', $generatorSVG->getBarcode($barcode, $verifiedFile['type']));
+    }
+}