Modernize code base

composer.json

@@ -51,7 +51,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "4.x-dev"
+            "dev-master": "5.x-dev"
         }
     }
 }

src/Bacon/ErrorCorrectionLevelConverter.php

@@ -4,27 +4,18 @@
 
 namespace Endroid\QrCode\Bacon;
 
-use BaconQrCode\Common\ErrorCorrectionLevel;
-use Endroid\QrCode\ErrorCorrectionLevel\ErrorCorrectionLevelHigh;
-use Endroid\QrCode\ErrorCorrectionLevel\ErrorCorrectionLevelInterface;
-use Endroid\QrCode\ErrorCorrectionLevel\ErrorCorrectionLevelLow;
-use Endroid\QrCode\ErrorCorrectionLevel\ErrorCorrectionLevelMedium;
-use Endroid\QrCode\ErrorCorrectionLevel\ErrorCorrectionLevelQuartile;
+use BaconQrCode\Common\ErrorCorrectionLevel as BaconErrorCorrectionLevel;
+use Endroid\QrCode\ErrorCorrectionLevel;
 
 final class ErrorCorrectionLevelConverter
 {
-    public static function convertToBaconErrorCorrectionLevel(ErrorCorrectionLevelInterface $errorCorrectionLevel): ErrorCorrectionLevel
+    public static function convertToBaconErrorCorrectionLevel(ErrorCorrectionLevel $errorCorrectionLevel): BaconErrorCorrectionLevel
     {
-        if ($errorCorrectionLevel instanceof ErrorCorrectionLevelLow) {
-            return ErrorCorrectionLevel::valueOf('L');
-        } elseif ($errorCorrectionLevel instanceof ErrorCorrectionLevelMedium) {
-            return ErrorCorrectionLevel::valueOf('M');
-        } elseif ($errorCorrectionLevel instanceof ErrorCorrectionLevelQuartile) {
-            return ErrorCorrectionLevel::valueOf('Q');
-        } elseif ($errorCorrectionLevel instanceof ErrorCorrectionLevelHigh) {
-            return ErrorCorrectionLevel::valueOf('H');
-        }
-
-        throw new \Exception('Error correction level could not be converted');
+        return match ($errorCorrectionLevel) {
+            ErrorCorrectionLevel::Low => BaconErrorCorrectionLevel::valueOf('L'),
+            ErrorCorrectionLevel::Medium => BaconErrorCorrectionLevel::valueOf('M'),
+            ErrorCorrectionLevel::Quartile => BaconErrorCorrectionLevel::valueOf('Q'),
+            ErrorCorrectionLevel::High => BaconErrorCorrectionLevel::valueOf('H')
+        };
     }
 }

src/Builder/Builder.php

@@ -6,16 +6,19 @@
 
 use Endroid\QrCode\Color\ColorInterface;
 use Endroid\QrCode\Encoding\EncodingInterface;
+use Endroid\QrCode\ErrorCorrectionLevel;
 use Endroid\QrCode\ErrorCorrectionLevel\ErrorCorrectionLevelInterface;
 use Endroid\QrCode\Exception\ValidationException;
 use Endroid\QrCode\Label\Alignment\LabelAlignmentInterface;
 use Endroid\QrCode\Label\Font\FontInterface;
 use Endroid\QrCode\Label\Label;
+use Endroid\QrCode\Label\LabelAlignment;
 use Endroid\QrCode\Label\LabelInterface;
 use Endroid\QrCode\Label\Margin\MarginInterface;
 use Endroid\QrCode\Logo\Logo;
 use Endroid\QrCode\Logo\LogoInterface;
 use Endroid\QrCode\QrCode;
+use Endroid\QrCode\RoundBlockSizeMode;
 use Endroid\QrCode\RoundBlockSizeMode\RoundBlockSizeModeInterface;
 use Endroid\QrCode\Writer\PngWriter;
 use Endroid\QrCode\Writer\Result\ResultInterface;
@@ -100,7 +103,7 @@ public function encoding(EncodingInterface $encoding): BuilderInterface
         return $this;
     }
 
-    public function errorCorrectionLevel(ErrorCorrectionLevelInterface $errorCorrectionLevel): BuilderInterface
+    public function errorCorrectionLevel(ErrorCorrectionLevel $errorCorrectionLevel): BuilderInterface
     {
         $this->options['errorCorrectionLevel'] = $errorCorrectionLevel;
 
@@ -121,7 +124,7 @@ public function margin(int $margin): BuilderInterface
         return $this;
     }
 
-    public function roundBlockSizeMode(RoundBlockSizeModeInterface $roundBlockSizeMode): BuilderInterface
+    public function roundBlockSizeMode(RoundBlockSizeMode $roundBlockSizeMode): BuilderInterface
     {
         $this->options['roundBlockSizeMode'] = $roundBlockSizeMode;
 
@@ -184,7 +187,7 @@ public function labelFont(FontInterface $labelFont): BuilderInterface
         return $this;
     }
 
-    public function labelAlignment(LabelAlignmentInterface $labelAlignment): BuilderInterface
+    public function labelAlignment(LabelAlignment $labelAlignment): BuilderInterface
     {
         $this->options['labelAlignment'] = $labelAlignment;
 

src/Builder/BuilderInterface.php

@@ -6,11 +6,11 @@
 
 use Endroid\QrCode\Color\ColorInterface;
 use Endroid\QrCode\Encoding\EncodingInterface;
-use Endroid\QrCode\ErrorCorrectionLevel\ErrorCorrectionLevelInterface;
-use Endroid\QrCode\Label\Alignment\LabelAlignmentInterface;
+use Endroid\QrCode\ErrorCorrectionLevel;
 use Endroid\QrCode\Label\Font\FontInterface;
+use Endroid\QrCode\Label\LabelAlignment;
 use Endroid\QrCode\Label\Margin\MarginInterface;
-use Endroid\QrCode\RoundBlockSizeMode\RoundBlockSizeModeInterface;
+use Endroid\QrCode\RoundBlockSizeMode;
 use Endroid\QrCode\Writer\Result\ResultInterface;
 use Endroid\QrCode\Writer\WriterInterface;
 
@@ -27,13 +27,13 @@ public function data(string $data): BuilderInterface;
 
     public function encoding(EncodingInterface $encoding): BuilderInterface;
 
-    public function errorCorrectionLevel(ErrorCorrectionLevelInterface $errorCorrectionLevel): BuilderInterface;
+    public function errorCorrectionLevel(ErrorCorrectionLevel $errorCorrectionLevel): BuilderInterface;
 
     public function size(int $size): BuilderInterface;
 
     public function margin(int $margin): BuilderInterface;
 
-    public function roundBlockSizeMode(RoundBlockSizeModeInterface $roundBlockSizeMode): BuilderInterface;
+    public function roundBlockSizeMode(RoundBlockSizeMode $roundBlockSizeMode): BuilderInterface;
 
     public function foregroundColor(ColorInterface $foregroundColor): BuilderInterface;
 
@@ -51,7 +51,7 @@ public function labelText(string $labelText): BuilderInterface;
 
     public function labelFont(FontInterface $labelFont): BuilderInterface;
 
-    public function labelAlignment(LabelAlignmentInterface $labelAlignment): BuilderInterface;
+    public function labelAlignment(LabelAlignment $labelAlignment): BuilderInterface;
 
     public function labelMargin(MarginInterface $labelMargin): BuilderInterface;
 

src/Color/Color.php

@@ -7,10 +7,10 @@
 final class Color implements ColorInterface
 {
     public function __construct(
-        private int $red,
-        private int $green,
-        private int $blue,
-        private int $alpha = 0
+        private readonly int $red,
+        private readonly int $green,
+        private readonly int $blue,
+        private readonly int $alpha = 0
     ) {
     }
 

src/Encoding/Encoding.php

@@ -7,7 +7,7 @@
 final class Encoding implements EncodingInterface
 {
     public function __construct(
-        private string $value
+        private readonly string $value
     ) {
         if (!in_array($value, mb_list_encodings())) {
             throw new \Exception(sprintf('Invalid encoding "%s"', $value));

src/Encoding/EncodingInterface.php

@@ -4,7 +4,7 @@
 
 namespace Endroid\QrCode\Encoding;
 
-interface EncodingInterface
+interface EncodingInterface extends \Stringable
 {
     public function __toString(): string;
 }

src/ErrorCorrectionLevel.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Endroid\QrCode;
+
+enum ErrorCorrectionLevel: string
+{
+    case High = 'high';
+    case Low = 'low';
+    case Medium = 'medium';
+    case Quartile = 'quartile';
+}

src/ImageData/LabelImageData.php

@@ -6,11 +6,11 @@
 
 use Endroid\QrCode\Label\LabelInterface;
 
-class LabelImageData
+final class LabelImageData
 {
     private function __construct(
-        private int $width,
-        private int $height
+        private readonly int $width,
+        private readonly int $height
     ) {
     }
 

src/ImageData/LogoImageData.php

@@ -6,15 +6,15 @@
 
 use Endroid\QrCode\Logo\LogoInterface;
 
-class LogoImageData
+final class LogoImageData
 {
     private function __construct(
-        private string $data,
+        private readonly string $data,
         private \GdImage|null $image,
-        private string $mimeType,
-        private int $width,
-        private int $height,
-        private bool $punchoutBackground
+        private readonly string $mimeType,
+        private readonly int $width,
+        private readonly int $height,
+        private readonly bool $punchoutBackground
     ) {
     }
 

src/Label/Font/Font.php

@@ -7,8 +7,8 @@
 final class Font implements FontInterface
 {
     public function __construct(
-        private string $path,
-        private int $size = 16
+        private readonly string $path,
+        private readonly int $size = 16
     ) {
         $this->assertValidPath($path);
     }

src/Label/Label.php

@@ -6,31 +6,20 @@
 
 use Endroid\QrCode\Color\Color;
 use Endroid\QrCode\Color\ColorInterface;
-use Endroid\QrCode\Label\Alignment\LabelAlignmentCenter;
-use Endroid\QrCode\Label\Alignment\LabelAlignmentInterface;
 use Endroid\QrCode\Label\Font\Font;
 use Endroid\QrCode\Label\Font\FontInterface;
 use Endroid\QrCode\Label\Margin\Margin;
 use Endroid\QrCode\Label\Margin\MarginInterface;
 
 final class Label implements LabelInterface
 {
-    private FontInterface $font;
-    private LabelAlignmentInterface $alignment;
-    private MarginInterface $margin;
-    private ColorInterface $textColor;
-
     public function __construct(
         private string $text,
-        FontInterface $font = null,
-        LabelAlignmentInterface $alignment = null,
-        MarginInterface $margin = null,
-        ColorInterface $textColor = null
+        private FontInterface $font = new Font(__DIR__.'/../../assets/noto_sans.otf', 16),
+        private LabelAlignment $alignment = LabelAlignment::Center,
+        private MarginInterface $margin = new Margin(0, 10, 10, 10),
+        private ColorInterface $textColor = new Color(0, 0, 0)
     ) {
-        $this->font = $font ?? new Font(__DIR__.'/../../assets/noto_sans.otf', 16);
-        $this->alignment = $alignment ?? new LabelAlignmentCenter();
-        $this->margin = $margin ?? new Margin(0, 10, 10, 10);
-        $this->textColor = $textColor ?? new Color(0, 0, 0);
     }
 
     public static function create(string $text): self
@@ -62,12 +51,12 @@ public function setFont(FontInterface $font): self
         return $this;
     }
 
-    public function getAlignment(): LabelAlignmentInterface
+    public function getAlignment(): LabelAlignment
     {
         return $this->alignment;
     }
 
-    public function setAlignment(LabelAlignmentInterface $alignment): self
+    public function setAlignment(LabelAlignment $alignment): self
     {
         $this->alignment = $alignment;
 

src/Label/LabelAlignment.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Endroid\QrCode\Label;
+
+enum LabelAlignment: string
+{
+    case Center = 'center';
+    case Left = 'left';
+    case Right = 'right';
+}

src/Label/LabelInterface.php

@@ -5,7 +5,6 @@
 namespace Endroid\QrCode\Label;
 
 use Endroid\QrCode\Color\ColorInterface;
-use Endroid\QrCode\Label\Alignment\LabelAlignmentInterface;
 use Endroid\QrCode\Label\Font\FontInterface;
 use Endroid\QrCode\Label\Margin\MarginInterface;
 
@@ -15,7 +14,7 @@ public function getText(): string;
 
     public function getFont(): FontInterface;
 
-    public function getAlignment(): LabelAlignmentInterface;
+    public function getAlignment(): LabelAlignment;
 
     public function getMargin(): MarginInterface;