Support other barcodes (#32)

* Support other barcodes

* Add drawBarcode test

* Fix QR, Code39 an others

Author: erikn69

src/AbstractBuilder.php

@@ -138,6 +138,23 @@ abstract public function drawCircle(
         bool $invert = false
     ): void;
 
+    /**
+     * @param string $type Barcode type, from Zpl\Enums\Barcode values
+     * @param float $x X position in user units
+     * @param float $y Y position in user units
+     * @param float $height height of the barcode in user units
+     * @param string $data Data to draw the barcode
+     * @param bool $printData Whether to print the data or not
+     * @param bool $labelAbove Text data position above or not
+     * @param string $orientation The text orientation. Available options:
+     *                            N = normal
+     *                            R = rotated 90 degrees
+     *                            I = inverted 180 degrees
+     *                            B = bottom-up 270 degrees, read from bottom up
+     * @param int $size Scale of the barcode (1-9)
+     */
+    abstract public function drawBarcode(string $type, float $x, float $y, float $height, string $data, bool $printData = false, bool $labelAbove = false, string $orientation = 'N', int $size = 0): void;
+
     /**
      * @param float $x X position in user units
      * @param float $y Y position in user units

src/Enums/Barcode.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace Zpl\Enums;
+
+class Barcode
+{
+    const AZTEK = 'B0';
+    const CODE11 = 'B1';
+    const INTERLEAVED2 = 'B2';
+    const CODE39 = 'B3';
+    const CODE49 = 'B4';
+    const PLANET = 'B5';
+    const PDF417 = 'B7';
+    const EAN8 = 'B8';
+    const UPCE = 'B9';
+    const CODE93 = 'BA';
+    const CODABLOCK = 'BB';
+    const CODE128 = 'BC';
+    const UPS = 'BD';
+    const EAN13 = 'BE';
+    const MICROPDF417 = 'BF';
+    const INDUSTRIAL2 = 'BI';
+    const STANDARD2 = 'BJ';
+    const ANSI = 'BK';
+    const LOGMARS = 'BL';
+    const MSI = 'BM';
+    const PLESSEY = 'BP';
+    const QR = 'BQ';
+    const GS1 = 'BR';
+    const UPC_EAN = 'BS';
+    const TLC39 = 'BT';
+    const UPCA = 'BU';
+    const DATAMATRIX = 'BX';
+    const DEFAULT = 'BY';
+    const POSTAL = 'BZ';
+
+    /** @return array<string> **/
+    public static function values(): array
+    {
+        return (new \ReflectionClass(static::class))->getConstants();
+    }
+
+    public static function isValid(string $value): bool
+    {
+        return in_array($value, static::values(), true);
+    }
+
+    /** @throws \InvalidArgumentException */
+    public static function validate(string $value): void
+    {
+        $values = self::values();
+        if (in_array($value, $values, true)) {
+            return;
+        }
+
+        throw new \InvalidArgumentException('Valid values for barcode type are: ' . implode(',', $values));
+    }
+}

src/Enums/Orientation.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Zpl\Enums;
+
+class Orientation
+{
+    const NORMAL = 'N'; // normal as default
+    const ROTATED = 'R'; // rotated 90 degrees
+    const INVERTED = 'I'; // inverted 180 degrees
+    const BOTTOM_UP = 'B'; // bottom-up 270 degrees, read from bottom up
+
+    /** @return array<string> **/
+    public static function values(): array
+    {
+        return ['N', 'R', 'I', 'B'];
+    }
+
+    public static function isValid(string $value): bool
+    {
+        return in_array($value, static::values(), true);
+    }
+
+    /** @throws \InvalidArgumentException */
+    public static function validate(string $value): void
+    {
+        $values = self::values();
+        if (in_array($value, $values, true)) {
+            return;
+        }
+
+        throw new \InvalidArgumentException('Valid values for orientation are: ' . implode(',', $values));
+    }
+}

src/PdfBuilder.php

@@ -143,6 +143,16 @@ public function drawCode39(float $x, float $y, float $height, string $data, bool
         throw new BuilderException('Method not yet implemented');
     }
 
+    /**
+     * {@inheritDoc}
+     *
+     * @see \Zpl\AbstractBuilder::drawBarcode()
+     */
+    public function drawBarcode(string $type, float $x, float $y, float $height, string $data, bool $printData = false, bool $labelAbove = false, string $orientation = 'N', int $size = 0): void
+    {
+        throw new BuilderException('Method not yet implemented');
+    }
+
     /**
      * {@inheritDoc}
      *

src/ZplBuilder.php

@@ -3,6 +3,8 @@
 namespace Zpl;
 
 use Zpl\Commands\GraphicField;
+use Zpl\Enums\Barcode;
+use Zpl\Enums\Orientation;
 
 class ZplBuilder extends AbstractBuilder
 {
@@ -163,6 +165,7 @@ public function setDarkness(float $value): void
      */
     public function setOrientation(string $orientation = 'N'): void
     {
+        Orientation::validate($orientation);
         $this->commands[] = '^FW' . $orientation;
     }
 
@@ -182,7 +185,7 @@ public function invertLabelOrientation(bool $isInvert = true): void
      */
     public function drawText(float $x, float $y, string $text, string $orientation = 'N', bool $invert = false): void
     {
-        $this->commands[] = '^FW' . $orientation;
+        $this->setOrientation($orientation);
         $this->commands[] = '^FO' . $this->toDots($x) . ',' . $this->toDots($y);
         if ($invert === true) {
             $this->commands[] = '^FR';
@@ -297,33 +300,57 @@ public function drawCell(
     /**
      * {@inheritDoc}
      *
-     * @see \Zpl\AbstractBuilder::drawCode128()
+     * @see \Zpl\AbstractBuilder::drawBarcode()
      */
-    public function drawCode128(float $x, float $y, float $height, string $data, bool $printData = false, string $orientation = 'N', int $size = 0): void
+    public function drawBarcode(string $type, float $x, float $y, float $height, string $data, bool $printData = false, bool $labelAbove = false, string $orientation = 'N', int $size = 0): void
     {
-        $validOrientations = ['N', 'R', 'I', 'B'];
-        if (in_array($orientation, $validOrientations) === false) {
-            throw new \InvalidArgumentException('Valid values for orientation are: ' . implode(',', $validOrientations));
-        }
+        Barcode::validate($type);
+        Orientation::validate($orientation);
 
         $this->commands[] = '^FO' . $this->toDots($x) . ',' . $this->toDots($y);
         if ($size > 0 && $size <= 9) {
             $this->commands[] = '^BY' . $size;
         }
-        $this->commands[] = '^BC' . $orientation . ',' . $this->toDots($height) . ',' . ($printData === true ? 'Y' : 'N') . ',N,N,A';
+
+        $barcode = [strtoupper($type), $orientation, $this->toDots($height), $printData, $labelAbove, 'N', 'A'];
+        if (in_array($barcode[0], [Barcode::CODE39, Barcode::CODE11, Barcode::ANSI, Barcode::PLESSEY])) {
+            array_splice($barcode, 2, 0, 'N');
+        } elseif ($barcode[0] === Barcode::QR) {
+            array_splice($barcode, 2, 0, '2');
+            $data = 'QA,' . $data;
+            $barcode = array_slice($barcode, 0, 3);
+            $barcode[] = $height;
+        } elseif ($barcode[0] === Barcode::MSI) {
+            array_splice($barcode, 2, 0, 'B');
+        }
+        if (in_array($barcode[0], ['B1', 'B2', 'B5', 'B8', 'BE', 'BI', 'BU', 'BS'])) {
+            $barcode = array_slice($barcode, 0, 5);
+        } elseif (in_array($barcode[0], ['B3', 'B4', 'BA', 'BB', 'BD', 'BF', 'BJ', 'BK', 'BL', 'BM', 'BP'])) {
+            $barcode = array_slice($barcode, 0, 6);
+        }
+
+        $this->commands[] = $this->command($barcode);
         $this->commands[] = '^FD' . $data . '^FS';
     }
 
+    /**
+     * {@inheritDoc}
+     *
+     * @see \Zpl\AbstractBuilder::drawCode128()
+     */
+    public function drawCode128(float $x, float $y, float $height, string $data, bool $printData = false, string $orientation = 'N', int $size = 0): void
+    {
+        $this->drawBarcode(Barcode::CODE128, $x, $y, $height, $data, $printData, false, $orientation, $size);
+    }
+
     /**
      * {@inheritDoc}
      *
      * @see \Zpl\AbstractBuilder::drawQrCode()
      */
     public function drawQrCode(float $x, float $y, string $data, int $size = 10): void
     {
-        $this->commands[] = '^FO' . $this->toDots($x) . ',' . $this->toDots($y);
-        $this->commands[] = '^BQN,2,' . $size;
-        $this->commands[] = '^FDQA,' . $data . '^FS';
+        $this->drawBarcode(Barcode::QR, $x, $y, (float) $size, $data);
     }
 
     /**
@@ -333,12 +360,7 @@ public function drawQrCode(float $x, float $y, string $data, int $size = 10): vo
      */
     public function drawCode39(float $x, float $y, float $height, string $data, bool $printData = false, string $orientation = 'N', int $size = 0): void
     {
-        $this->commands[] = '^FO' . $this->toDots($x) . ',' . $this->toDots($y);
-        if ($size > 0 && $size <= 9) {
-            $this->commands[] = '^BY' . $size;
-        }
-        $this->commands[] = '^B3' . $orientation . ',N,' . $this->toDots($height) . ',' . ($printData === true ? 'Y' : 'N') . ',N';
-        $this->commands[] = '^FD' . $data . '^FS';
+        $this->drawBarcode(Barcode::CODE39, $x, $y, $height, $data, $printData, false, $orientation, $size);
     }
 
     /**

tests/ZplTest.php

@@ -154,6 +154,15 @@ public function drawQr(): void
         $this->assertEquals($this->getZpl(), "^XA\n^FO50,50\n^BQN,2,6\n^FDQA,https://example.com/product/ABC-123^FS\n^XZ\n");
     }
 
+    #[Test]
+    public function drawArbitraryBarcode(): void
+    {
+        $this->driver->drawBarcode('BC', 5, 50, 20, 'ABC123456789', true, true);
+        $this->driver->drawBarcode('B3', 5, 50, 20, '123456789', false, false, 'R', 5);
+
+        $this->assertEquals($this->getZpl(), "^XA\n^FO5,50\n^BCN,20,Y,Y,N,A\n^FDABC123456789^FS\n^FO5,50\n^BY5\n^B3R,N,20,N,N\n^FD123456789^FS\n^XZ\n");
+    }
+
     #[Test]
     public function drawGraphic(): void
     {