More typehints

casperbakker · casperbakker · commit 460f3eee050c · 2024-03-31T21:24:21.000+02:00
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
diff --git a/src/Barcode.php b/src/Barcode.php
@@ -14,7 +14,7 @@ public function __construct(string $barcode)
         $this->barcode = $barcode;
     }
 
-    public function addBar(BarcodeBar $bar)
+    public function addBar(BarcodeBar $bar): void
     {
         $this->bars[] = $bar;
         $this->width += $bar->getWidth();
diff --git a/src/BarcodeBar.php b/src/BarcodeBar.php
@@ -2,7 +2,7 @@
 
 namespace Picqer\Barcode;
 
-class BarcodeBar
+readonly class BarcodeBar
 {
     protected int $width;
     protected int $height;
diff --git a/src/BarcodeGenerator.php b/src/BarcodeGenerator.php
@@ -45,6 +45,7 @@
 use Picqer\Barcode\Types\TypeEan13;
 use Picqer\Barcode\Types\TypeEan8;
 use Picqer\Barcode\Types\TypeIntelligentMailBarcode;
+use Picqer\Barcode\Types\TypeInterface;
 use Picqer\Barcode\Types\TypeInterleaved25;
 use Picqer\Barcode\Types\TypeInterleaved25Checksum;
 use Picqer\Barcode\Types\TypeITF14;
@@ -101,14 +102,17 @@ abstract class BarcodeGenerator
     const TYPE_PHARMA_CODE = 'PHARMA';
     const TYPE_PHARMA_CODE_TWO_TRACKS = 'PHARMA2T';
 
+    /**
+     * @throws UnknownTypeException
+     */
     protected function getBarcodeData(string $code, string $type): Barcode
     {
         $barcodeDataBuilder = $this->createDataBuilderForType($type);
 
         return $barcodeDataBuilder->getBarcode($code);
     }
 
-    protected function createDataBuilderForType(string $type)
+    protected function createDataBuilderForType(string $type): TypeInterface
     {
         switch (strtoupper($type)) {
             case self::TYPE_CODE_32:
diff --git a/src/BarcodeGeneratorDynamicHTML.php b/src/BarcodeGeneratorDynamicHTML.php
@@ -2,6 +2,8 @@
 
 namespace Picqer\Barcode;
 
+use Picqer\Barcode\Exceptions\UnknownTypeException;
+
 class BarcodeGeneratorDynamicHTML extends BarcodeGenerator
 {
     /**
@@ -12,6 +14,7 @@ class BarcodeGeneratorDynamicHTML extends BarcodeGenerator
      * @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.
+     * @throws UnknownTypeException
      */
     public function getBarcode(string $barcode, $type, string $foregroundColor = 'black'): string
     {
diff --git a/src/BarcodeGeneratorHTML.php b/src/BarcodeGeneratorHTML.php
@@ -2,6 +2,8 @@
 
 namespace Picqer\Barcode;
 
+use Picqer\Barcode\Exceptions\UnknownTypeException;
+
 class BarcodeGeneratorHTML extends BarcodeGenerator
 {
     /**
@@ -14,6 +16,7 @@ class BarcodeGeneratorHTML extends BarcodeGenerator
      * @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.
+     * @throws UnknownTypeException
      */
     public function getBarcode(string $barcode, $type, int $widthFactor = 2, int $height = 30, string $foregroundColor = 'black'): string
     {
diff --git a/src/BarcodeGeneratorJPG.php b/src/BarcodeGeneratorJPG.php
@@ -2,6 +2,8 @@
 
 namespace Picqer\Barcode;
 
+use Picqer\Barcode\Exceptions\UnknownTypeException;
+
 class BarcodeGeneratorJPG extends BarcodeGenerator
 {
     protected ?bool $useImagick = null;
@@ -15,6 +17,7 @@ class BarcodeGeneratorJPG extends BarcodeGenerator
      * @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.
+     * @throws UnknownTypeException
      */
     public function getBarcode(string $barcode, $type, int $widthFactor = 2, int $height = 30, array $foregroundColor = [0, 0, 0]): string
     {
@@ -37,15 +40,15 @@ public function getBarcode(string $barcode, $type, int $widthFactor = 2, int $he
     /**
      * Force the use of Imagick image extension
      */
-    public function useImagick()
+    public function useImagick(): void
     {
         $this->useImagick = true;
     }
 
     /**
      * Force the use of the GD image library
      */
-    public function useGd()
+    public function useGd(): void
     {
         $this->useImagick = false;
     }
diff --git a/src/BarcodeGeneratorPNG.php b/src/BarcodeGeneratorPNG.php
@@ -2,6 +2,8 @@
 
 namespace Picqer\Barcode;
 
+use Picqer\Barcode\Exceptions\UnknownTypeException;
+
 class BarcodeGeneratorPNG extends BarcodeGenerator
 {
     protected ?bool $useImagick = null;
@@ -15,6 +17,7 @@ class BarcodeGeneratorPNG extends BarcodeGenerator
      * @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.
+     * @throws UnknownTypeException
      */
     public function getBarcode(string $barcode, $type, int $widthFactor = 2, int $height = 30, array $foregroundColor = [0, 0, 0]): string
     {
@@ -37,15 +40,15 @@ public function getBarcode(string $barcode, $type, int $widthFactor = 2, int $he
     /**
      * Force the use of Imagick image extension
      */
-    public function useImagick()
+    public function useImagick(): void
     {
         $this->useImagick = true;
     }
 
     /**
      * Force the use of the GD image library
      */
-    public function useGd()
+    public function useGd(): void
     {
         $this->useImagick = false;
     }
diff --git a/src/BarcodeGeneratorSVG.php b/src/BarcodeGeneratorSVG.php
@@ -2,6 +2,8 @@
 
 namespace Picqer\Barcode;
 
+use Picqer\Barcode\Exceptions\UnknownTypeException;
+
 class BarcodeGeneratorSVG extends BarcodeGenerator
 {
     /**
@@ -14,6 +16,7 @@ class BarcodeGeneratorSVG extends BarcodeGenerator
      * @param $foregroundColor (string) Foreground color (in SVG format) for bar elements (background is transparent).
      * @return string SVG code.
      * @public
+     * @throws UnknownTypeException
      */
     public function getBarcode(string $barcode, $type, float $widthFactor = 2, float $height = 30, string $foregroundColor = 'black'): string
     {
diff --git a/src/Types/TypeCodabar.php b/src/Types/TypeCodabar.php
@@ -13,7 +13,7 @@
 
 class TypeCodabar implements TypeInterface
 {
-    protected $conversionTable = [
+    protected array $conversionTable = [
         '0' => '11111221',
         '1' => '11112211',
         '2' => '11121121',
diff --git a/src/Types/TypeCode11.php b/src/Types/TypeCode11.php
@@ -13,7 +13,7 @@
 
 class TypeCode11 implements TypeInterface
 {
-    protected $conversionTable = [
+    protected array $conversionTable = [
         '0' => '111121',
         '1' => '211121',
         '2' => '121121',
diff --git a/src/Types/TypeCode128.php b/src/Types/TypeCode128.php
@@ -18,9 +18,9 @@
 
 class TypeCode128 implements TypeInterface
 {
-    protected $type = null;
+    protected ?string $type = null;
 
-    protected $conversionTable = [
+    protected array $conversionTable = [
         '212222', /* 00 */
         '222122', /* 01 */
         '222221', /* 02 */
@@ -383,7 +383,7 @@ public function getBarcode(string $code): Barcode
      * @return array sequence
      * @protected
      */
-    protected function get128ABsequence($code)
+    protected function get128ABsequence($code): array
     {
         $len = strlen($code);
         $sequence = [];
diff --git a/src/Types/TypeCode128A.php b/src/Types/TypeCode128A.php
@@ -12,5 +12,5 @@
 
 class TypeCode128A extends TypeCode128
 {
-    protected $type = 'A';
+    protected ?string $type = 'A';
 }
diff --git a/src/Types/TypeCode128B.php b/src/Types/TypeCode128B.php
@@ -12,5 +12,5 @@
 
 class TypeCode128B extends TypeCode128
 {
-    protected $type = 'B';
+    protected ?string $type = 'B';
 }
diff --git a/src/Types/TypeCode128C.php b/src/Types/TypeCode128C.php
@@ -12,5 +12,5 @@
 
 class TypeCode128C extends TypeCode128
 {
-    protected $type = 'C';
+    protected ?string $type = 'C';
 }
diff --git a/src/Types/TypeCode32.php b/src/Types/TypeCode32.php
@@ -13,7 +13,7 @@
  */
 class TypeCode32 extends TypeCode39
 {
-    protected $conversionTable32 = [
+    protected array $conversionTable32 = [
         '0' => '0',
         '1' => '1',
         '2' => '2',
diff --git a/src/Types/TypeCode39.php b/src/Types/TypeCode39.php
@@ -14,10 +14,10 @@
 
 class TypeCode39 implements TypeInterface
 {
-    protected $extended = false;
-    protected $checksum = false;
+    protected bool $extended = false;
+    protected bool $checksum = false;
 
-    protected $conversionTable = [
+    protected array $conversionTable = [
         '0' => '111331311',
         '1' => '311311113',
         '2' => '113311113',
@@ -113,10 +113,11 @@ public function getBarcode(string $code): Barcode
      * Encode a string to be used for CODE 39 Extended mode.
      *
      * @param string $code code to represent.
-     * @return bool|string encoded string.
+     * @return string encoded string.
      * @protected
+     * @throws InvalidCharacterException
      */
-    protected function encode_code39_ext($code)
+    protected function encode_code39_ext(string $code): string
     {
         $encode = [
             chr(0) => '%U',
diff --git a/src/Types/TypeCode39Checksum.php b/src/Types/TypeCode39Checksum.php
@@ -9,6 +9,6 @@
 
 class TypeCode39Checksum extends TypeCode39
 {
-    protected $extended = false;
-    protected $checksum = true;
+    protected bool $extended = false;
+    protected bool $checksum = true;
 }
diff --git a/src/Types/TypeCode39Extended.php b/src/Types/TypeCode39Extended.php
@@ -9,6 +9,6 @@
 
 class TypeCode39Extended extends TypeCode39
 {
-    protected $extended = true;
-    protected $checksum = false;
+    protected bool $extended = true;
+    protected bool $checksum = false;
 }
diff --git a/src/Types/TypeCode39ExtendedChecksum.php b/src/Types/TypeCode39ExtendedChecksum.php
@@ -9,6 +9,6 @@
 
 class TypeCode39ExtendedChecksum extends TypeCode39
 {
-    protected $extended = true;
-    protected $checksum = true;
+    protected bool $extended = true;
+    protected bool $checksum = true;
 }
diff --git a/src/Types/TypeCode93.php b/src/Types/TypeCode93.php
@@ -15,7 +15,7 @@
 
 class TypeCode93 implements TypeInterface
 {
-    protected $conversionTable = [
+    protected array $conversionTable = [
         48 => '131112', // 0
         49 => '111213', // 1
         50 => '111312', // 2
@@ -246,7 +246,7 @@ public function getBarcode(string $code): Barcode
      * @return string checksum code.
      * @protected
      */
-    protected function checksum_code93($code)
+    protected function checksum_code93(string $code): string
     {
         $chars = ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', '-', '.', ' ', '$', '/', '+', '%', 'a', 'b', 'c', 'd'];
 
@@ -280,8 +280,6 @@ protected function checksum_code93($code)
         $check %= 47;
         $k = $chars[$check];
 
-        $checksum = $c . $k;
-
-        return $checksum;
+        return $c . $k;
     }
 }
diff --git a/src/Types/TypeEanUpcBase.php b/src/Types/TypeEanUpcBase.php
@@ -211,7 +211,7 @@ protected function calculateChecksumDigit(string $code): int
         // calculate check digit
         $sum_a = 0;
         for ($i = 1; $i < $this->length - 1; $i += 2) {
-            $sum_a += $code[$i];
+            $sum_a += intval($code[$i]);
         }
         if ($this->length > 12) {
             $sum_a *= 3;
diff --git a/src/Types/TypeInterleaved25Checksum.php b/src/Types/TypeInterleaved25Checksum.php
@@ -75,11 +75,11 @@ protected function getChecksum(string $code): string
         $len = strlen($code);
         $sum = 0;
         for ($i = 0; $i < $len; $i += 2) {
-            $sum += $code[$i];
+            $sum += intval($code[$i]);
         }
         $sum *= 3;
         for ($i = 1; $i < $len; $i += 2) {
-            $sum += ($code[$i]);
+            $sum += intval($code[$i]);
         }
         $r = $sum % 10;
         if ($r > 0) {
diff --git a/src/Types/TypeMsi.php b/src/Types/TypeMsi.php
@@ -13,5 +13,5 @@
 
 class TypeMsi extends TypeMsiChecksum
 {
-    protected $checksum = false;
+    protected bool $checksum = false;
 }
diff --git a/src/Types/TypeMsiChecksum.php b/src/Types/TypeMsiChecksum.php
@@ -17,7 +17,7 @@
 
 class TypeMsiChecksum implements TypeInterface
 {
-    protected $checksum = true;
+    protected bool $checksum = true;
 
     public function getBarcode(string $code): Barcode
     {
diff --git a/src/Types/TypePlanet.php b/src/Types/TypePlanet.php
@@ -13,7 +13,7 @@
 
 class TypePlanet extends TypePostnet
 {
-    protected $barlen = [
+    protected array $barlen = [
         0 => [1, 1, 2, 2, 2],
         1 => [2, 2, 2, 1, 1],
         2 => [2, 2, 1, 2, 1],
diff --git a/src/Types/TypePostnet.php b/src/Types/TypePostnet.php
@@ -16,7 +16,7 @@
 
 class TypePostnet implements TypeInterface
 {
-    protected $barlen = [
+    protected array $barlen = [
         0 => [2, 2, 1, 1, 1],
         1 => [1, 1, 1, 2, 2],
         2 => [1, 1, 2, 1, 2],
diff --git a/src/Types/TypeStandard2of5.php b/src/Types/TypeStandard2of5.php
diff --git a/src/Types/TypeStandard2of5Checksum.php b/src/Types/TypeStandard2of5Checksum.php
diff --git a/src/Types/TypeTelepen.php b/src/Types/TypeTelepen.php
diff --git a/src/Types/TypeUpcExtension2.php b/src/Types/TypeUpcExtension2.php
diff --git a/src/Types/TypeUpcExtension5.php b/src/Types/TypeUpcExtension5.php

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ public function __construct(string $barcode)`
`14`	`14`	`$this->barcode = $barcode;`
`15`	`15`	`}`
`16`	`16`
`17`		`- public function addBar(BarcodeBar $bar)`
	`17`	`+ public function addBar(BarcodeBar $bar): void`
`18`	`18`	`{`
`19`	`19`	`$this->bars[] = $bar;`
`20`	`20`	`$this->width += $bar->getWidth();`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace Picqer\Barcode;`
`4`	`4`
`5`		`-class BarcodeBar`
	`5`	`+readonly class BarcodeBar`
`6`	`6`	`{`
`7`	`7`	`protected int $width;`
`8`	`8`	`protected int $height;`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,8 @@`
`2`	`2`
`3`	`3`	`namespace Picqer\Barcode;`
`4`	`4`
	`5`	`+use Picqer\Barcode\Exceptions\UnknownTypeException;`
	`6`	`+`
`5`	`7`	`class BarcodeGeneratorDynamicHTML extends BarcodeGenerator`
`6`	`8`	`{`
`7`	`9`	`/**`
`@@ -12,6 +14,7 @@ class BarcodeGeneratorDynamicHTML extends BarcodeGenerator`
`12`	`14`	`* @param BarcodeGenerator::TYPE_* $type (string) type of barcode`
`13`	`15`	`* @param string $foregroundColor Foreground color for bar elements as '#333' or 'orange' for example (background is transparent).`
`14`	`16`	`* @return string HTML code.`
	`17`	`+ * @throws UnknownTypeException`
`15`	`18`	`*/`
`16`	`19`	`public function getBarcode(string $barcode, $type, string $foregroundColor = 'black'): string`
`17`	`20`	`{`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`
`14`	`14`	`class TypeCodabar implements TypeInterface`
`15`	`15`	`{`
`16`		`- protected $conversionTable = [`
	`16`	`+ protected array $conversionTable = [`
`17`	`17`	`'0' => '11111221',`
`18`	`18`	`'1' => '11112211',`
`19`	`19`	`'2' => '11121121',`