Merge branch 'refs/heads/main' into upc-e

Author: Bernhard-Krop

.github/workflows/phpstan.yml

@@ -0,0 +1,29 @@
+name: Static analysis (phpstan)
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: 8.3
+        extensions: mbstring, gd, bcmath, imagick
+
+    - name: Install dependencies
+      run: composer install --prefer-dist --no-progress --no-interaction
+
+    - name: Run analysis
+      run: vendor/bin/phpstan --error-format=github --no-progress

.github/workflows/phpunit.yml

@@ -1,18 +1,24 @@
-name: phpunit
+name: Unit tests (phpunit)
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        php-versions: ['7.3', '7.4', '8.0', '8.1']
+        php-versions: ['8.1', '8.2', '8.3']
 
     steps:
-    - uses: actions/checkout@v2
+    - name: Checkout code
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
 
     - name: Setup PHP
       uses: shivammathur/setup-php@v2
@@ -24,7 +30,7 @@ jobs:
       run: composer validate
 
     - name: Install dependencies
-      run: composer install --prefer-dist --no-progress
+      run: composer install --prefer-dist --no-progress --no-interaction
 
     - name: Run test suite
       run: composer run-script test

CHANGELOG.md

@@ -1,7 +1,9 @@
 # PHP Barcode Generator 
-[![Build Status](https://travis-ci.org/picqer/php-barcode-generator.svg?branch=main)](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)
+<a href="https://github.com/picqer/php-barcode-generator/actions"><img src="https://github.com/picqer/php-barcode-generator/workflows/phpunit/badge.svg" alt="Build Status"></a>
+<a href="https://packagist.org/packages/picqer/php-barcode-generator"><img src="https://img.shields.io/packagist/dt/picqer/php-barcode-generator" alt="Total Downloads"></a>
+<a href="https://packagist.org/packages/picqer/php-barcode-generator"><img src="https://img.shields.io/packagist/v/picqer/php-barcode-generator" alt="Latest Stable Version"></a>
 
-This is an easy to use, non-bloated, framework independent, barcode generator in PHP.
+This is an easy to use, non-bloated, framework independent, barcode generator in PHP. It uses zero(!) composer dependencies and is only a handful of files. Probably the reason that this is the most downloaded barcode generator for PHP on Packagist. ;)
 
 It creates SVG, PNG, JPG and HTML images, from the most used 1D barcode standards.
 
@@ -32,6 +34,9 @@ $generator = new Picqer\Barcode\BarcodeGeneratorHTML();
 echo $generator->getBarcode('081231723897', $generator::TYPE_CODE_128);
 ```
 
+Will result in this beauty:<br>
+![Barcode 081231723897 as Code 128](tests/verified-files/081231723897-ean13.svg)
+
 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
@@ -84,6 +89,7 @@ Most used types are TYPE_CODE_128 and TYPE_CODE_39. Because of the best scanner
 - TYPE_EAN_5
 - TYPE_EAN_8
 - TYPE_EAN_13
+- TYPE_ITF14 (Also known as GTIN-14)
 - TYPE_UPC_A
 - TYPE_UPC_E
 - TYPE_MSI

Readme.md

@@ -18,11 +18,12 @@
         }
     ],
     "require": {
-        "php": "^7.3|^8.0",
+        "php": "^8.1",
         "ext-mbstring": "*"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.5"
+        "phpunit/phpunit": "^9.5",
+        "phpstan/phpstan": "^1.10"
     },
     "suggest": {
         "ext-bcmath": "Barcode IMB (Intelligent Mail Barcode) needs bcmath extension",

composer.json

@@ -6,11 +6,15 @@ These are examples of supported barcodes with this library.
 
 ### C39
 
-![Barcode 1234567890abcABC as C39](tests/verified-files/C39-1234567890abcABC.svg)
+![Barcode 1234567890ABC as C39](tests/verified-files/C39-1234567890ABC.svg)
 
 ### C39+
 
-![Barcode 1234567890abcABC as C39+](tests/verified-files/C39+-1234567890abcABC.svg)
+![Barcode 1234567890ABC as C39+](tests/verified-files/C39+-1234567890ABC.svg)
+
+### C39E
+
+![Barcode 1234567890abcABC as C39E](tests/verified-files/C39E-1234567890abcABC.svg)
 
 ### C39E+
 
@@ -44,6 +48,12 @@ These are examples of supported barcodes with this library.
 
 ![Barcode 004900000463 as EAN13](tests/verified-files/EAN13-004900000463.svg)
 
+### ITF14
+
+![Barcode 00012345600012 as ITF14](tests/verified-files/ITF14-00012345600012.svg)
+
+![Barcode 05400141288766 as ITF14](tests/verified-files/ITF14-05400141288766.svg)
+
 ### C128
 
 ![Barcode 081231723897 as C128](tests/verified-files/C128-081231723897.svg)

examples.md

@@ -8,6 +8,7 @@ function getSaveFilename($value) {
 
 $generatorSVG = new Picqer\Barcode\BarcodeGeneratorSVG();
 file_put_contents('tests/verified-files/081231723897-ean13.svg', $generatorSVG->getBarcode('081231723897', $generatorSVG::TYPE_EAN_13));
+file_put_contents('tests/verified-files/081231723897-ean13-fractional-width.svg', $generatorSVG->getBarcode('081231723897', $generatorSVG::TYPE_EAN_13, 0.25, 25.75));
 
 $generatorHTML = new Picqer\Barcode\BarcodeGeneratorHTML();
 file_put_contents('tests/verified-files/081231723897-code128.html', $generatorHTML->getBarcode('081231723897', $generatorHTML::TYPE_CODE_128));

generate-verified-files.php

@@ -0,0 +1,4 @@
+parameters:
+  paths:
+    - src
+  level: 4

phpstan.neon.dist

@@ -1,23 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit backupGlobals="false"
-         backupStaticAttributes="false"
-         colors="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnError="false"
-         stopOnFailure="false"
-         verbose="true"
->
-    <testsuites>
-        <testsuite name="Barcode Test Suite">
-            <directory>./tests/</directory>
-        </testsuite>
-    </testsuites>
-    <filter>
-        <whitelist>
-            <directory>./src</directory>
-        </whitelist>
-    </filter>
-</phpunit>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" backupStaticAttributes="false" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnError="false" stopOnFailure="false" verbose="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+  <coverage>
+    <include>
+      <directory>./src</directory>
+    </include>
+  </coverage>
+  <testsuites>
+    <testsuite name="Barcode Test Suite">
+      <directory>./tests/</directory>
+    </testsuite>
+  </testsuites>
+</phpunit>

phpunit.xml

@@ -47,6 +47,7 @@
 use Picqer\Barcode\Types\TypeIntelligentMailBarcode;
 use Picqer\Barcode\Types\TypeInterleaved25;
 use Picqer\Barcode\Types\TypeInterleaved25Checksum;
+use Picqer\Barcode\Types\TypeITF14;
 use Picqer\Barcode\Types\TypeKix;
 use Picqer\Barcode\Types\TypeMsi;
 use Picqer\Barcode\Types\TypeMsiChecksum;
@@ -57,6 +58,7 @@
 use Picqer\Barcode\Types\TypeRms4cc;
 use Picqer\Barcode\Types\TypeStandard2of5;
 use Picqer\Barcode\Types\TypeStandard2of5Checksum;
+use Picqer\Barcode\Types\TypeTelepen;
 use Picqer\Barcode\Types\TypeUpcA;
 use Picqer\Barcode\Types\TypeUpcE;
 use Picqer\Barcode\Types\TypeUpcExtension2;
@@ -74,6 +76,7 @@ abstract class BarcodeGenerator
     const TYPE_STANDARD_2_5_CHECKSUM = 'S25+';
     const TYPE_INTERLEAVED_2_5 = 'I25';
     const TYPE_INTERLEAVED_2_5_CHECKSUM = 'I25+';
+    const TYPE_ITF_14 = 'ITF14';
     const TYPE_CODE_128 = 'C128';
     const TYPE_CODE_128_A = 'C128A';
     const TYPE_CODE_128_B = 'C128B';
@@ -88,6 +91,8 @@ abstract class BarcodeGenerator
     const TYPE_MSI_CHECKSUM = 'MSI+'; // MSI + CHECKSUM (modulo 11)
     const TYPE_POSTNET = 'POSTNET';
     const TYPE_PLANET = 'PLANET';
+    const TYPE_TELEPEN_ALPHA = 'TELEPENALPHA';
+    const TYPE_TELEPEN_NUMERIC = 'TELEPENNUMERIC';
     const TYPE_RMS4CC = 'RMS4CC'; // RMS4CC (Royal Mail 4-state Customer Code) - CBC (Customer Bar Code)
     const TYPE_KIX = 'KIX'; // KIX (Klant index - Customer index)
     const TYPE_IMB = 'IMB'; // IMB - Intelligent Mail Barcode - Onecode - USPS-B-3200
@@ -136,6 +141,9 @@ protected function createDataBuilderForType(string $type)
             case self::TYPE_INTERLEAVED_2_5_CHECKSUM:
                 return new TypeInterleaved25Checksum();
 
+            case self::TYPE_ITF_14:
+                return new TypeITF14();
+
             case self::TYPE_CODE_128:
                 return new TypeCode128();
 
@@ -198,6 +206,13 @@ protected function createDataBuilderForType(string $type)
 
             case self::TYPE_PHARMA_CODE_TWO_TRACKS:
                 return new TypePharmacodeTwoCode();
+            
+            case self::TYPE_TELEPEN_ALPHA:
+                return new TypeTelepen();
+            
+            case self::TYPE_TELEPEN_NUMERIC:
+                return new TypeTelepen('numeric');
+            
         }
 
         throw new UnknownTypeException();

src/BarcodeGenerator.php

@@ -11,11 +11,11 @@ class BarcodeGeneratorDynamicHTML extends BarcodeGenerator
      * This 'dynamic' version uses percentage based widths and heights, resulting in a vector-y qualitative result.
      *
      * @param string $barcode code to print
-     * @param string $type type of barcode
+     * @param BarcodeGenerator::TYPE_* $type (string) type of barcode
      * @param string $foregroundColor Foreground color for bar elements as '#333' or 'orange' for example (background is transparent).
      * @return string HTML code.
      */
-    public function getBarcode($barcode, $type, string $foregroundColor = 'black')
+    public function getBarcode(string $barcode, $type, string $foregroundColor = 'black'): string
     {
         $barcodeData = $this->getBarcodeData($barcode, $type);
 

src/BarcodeGeneratorDynamicHTML.php

@@ -9,13 +9,13 @@ class BarcodeGeneratorHTML extends BarcodeGenerator
      * This original version uses pixel based widths and heights. Use Dynamic HTML version for better quality representation.
      *
      * @param string $barcode code to print
-     * @param string $type type of barcode
+     * @param BarcodeGenerator::TYPE_* $type (string) type of barcode
      * @param int $widthFactor Width of a single bar element in pixels.
      * @param int $height Height of a single bar element in pixels.
      * @param string $foregroundColor Foreground color for bar elements as '#333' or 'orange' for example (background is transparent).
      * @return string HTML code.
      */
-    public function getBarcode($barcode, $type, int $widthFactor = 2, int $height = 30, string $foregroundColor = 'black')
+    public function getBarcode($barcode, $type, int $widthFactor = 2, int $height = 30, string $foregroundColor = 'black'): string
     {
         $barcodeData = $this->getBarcodeData($barcode, $type);
 

src/BarcodeGeneratorHTML.php

@@ -11,6 +11,9 @@ class BarcodeGeneratorPNG extends BarcodeGenerator
 {
     protected $useImagick = true;
 
+    /**
+     * @throws BarcodeException
+     */
     public function __construct()
     {
         // Auto switch between GD and Imagick based on what is installed
@@ -43,13 +46,13 @@ public function useGd()
      * Return a PNG image representation of barcode (requires GD or Imagick library).
      *
      * @param string $barcode code to print
-     * @param string $type type of barcode:
+     * @param BarcodeGenerator::TYPE_* $type (string) type of barcode
      * @param int $widthFactor Width of a single bar element in pixels.
      * @param int $height Height of a single bar element in pixels.
      * @param array $foregroundColor RGB (0-255) foreground color for bar elements (background is transparent).
      * @return string image data or false in case of error.
      */
-    public function getBarcode($barcode, $type, int $widthFactor = 2, int $height = 30, array $foregroundColor = [0, 0, 0])
+    public function getBarcode(string $barcode, $type, int $widthFactor = 2, int $height = 30, array $foregroundColor = [0, 0, 0]): string
     {
         $barcodeData = $this->getBarcodeData($barcode, $type);
         $width = round($barcodeData->getWidth() * $widthFactor);
@@ -73,7 +76,7 @@ public function getBarcode($barcode, $type, int $widthFactor = 2, int $height =
                 $barHeight = round(($bar->getHeight() * $height / $barcodeData->getHeight()), 3);
 
                 // draw a vertical bar
-                if ($this->useImagick && isset($imagickBarsShape)) {
+                if ($this->useImagick) {
                     $imagickBarsShape->rectangle($positionHorizontal, $y, ($positionHorizontal + $barWidth - 1), ($y + $barHeight));
                 } else {
                     imagefilledrectangle($image, $positionHorizontal, $y, ($positionHorizontal + $barWidth - 1), ($y + $barHeight), $gdForegroundColor);
@@ -82,7 +85,7 @@ public function getBarcode($barcode, $type, int $widthFactor = 2, int $height =
             $positionHorizontal += $barWidth;
         }
 
-        if ($this->useImagick && isset($imagickBarsShape)) {
+        if ($this->useImagick) {
             $image = $this->createImagickImageObject($width, $height);
             $image->drawImage($imagickBarsShape);
             return $image->getImageBlob();