Move GdWriter to GdTrait

Author: endroid

src/Writer/AbstractGdWriter.php

@@ -4,31 +4,10 @@
 
 namespace Endroid\QrCode\Writer;
 
-use Endroid\QrCode\Label\LabelInterface;
-use Endroid\QrCode\Logo\LogoInterface;
-use Endroid\QrCode\QrCodeInterface;
-use Endroid\QrCode\Writer\Result\GdResult;
-use Endroid\QrCode\Writer\Result\ResultInterface;
-
 /**
- * @deprecated since 6.0, use GdWriter instead. This class will be removed in 7.0.
+ * @deprecated since 6.0, use GdTrait instead. This class will be removed in 7.0.
  */
 abstract readonly class AbstractGdWriter implements WriterInterface, ValidatingWriterInterface
 {
-    private GdWriter $gdWriter;
-
-    public function __construct()
-    {
-        $this->gdWriter = new GdWriter();
-    }
-
-    public function write(QrCodeInterface $qrCode, ?LogoInterface $logo = null, ?LabelInterface $label = null, array $options = []): GdResult
-    {
-        return $this->gdWriter->write($qrCode, $logo, $label, $options);
-    }
-
-    public function validateResult(ResultInterface $result, string $expectedData): void
-    {
-        $this->gdWriter->validateResult($result, $expectedData);
-    }
+    use GdTrait;
 }

src/Writer/GdWriter.php src/Writer/GdTrait.phpsrc/Writer/GdWriter.php renamed to src/Writer/GdTrait.php

@@ -18,7 +18,7 @@
 use Endroid\QrCode\Writer\Result\ResultInterface;
 use Zxing\QrReader;
 
-final readonly class GdWriter implements WriterInterface, ValidatingWriterInterface
+trait GdTrait
 {
     public function getMatrix(QrCodeInterface $qrCode): MatrixInterface
     {
@@ -27,7 +27,8 @@ public function getMatrix(QrCodeInterface $qrCode): MatrixInterface
         return $matrixFactory->create($qrCode);
     }
 
-    public function write(QrCodeInterface $qrCode, ?LogoInterface $logo = null, ?LabelInterface $label = null, array $options = []): GdResult
+    /** @param array<string, mixed> $options */
+    public function writeGd(QrCodeInterface $qrCode, ?LogoInterface $logo = null, ?LabelInterface $label = null, array $options = []): GdResult
     {
         if (!extension_loaded('gd')) {
             throw new \Exception('Unable to generate image: please check if the GD extension is enabled and configured correctly');

src/Writer/GifWriter.php

@@ -12,20 +12,12 @@
 
 final readonly class GifWriter implements WriterInterface, ValidatingWriterInterface
 {
-    public function __construct(
-        private GdWriter $gdWriter = new GdWriter(),
-    ) {
-    }
+    use GdTrait;
 
     public function write(QrCodeInterface $qrCode, ?LogoInterface $logo = null, ?LabelInterface $label = null, array $options = []): ResultInterface
     {
-        $gdResult = $this->gdWriter->write($qrCode, $logo, $label, $options);
+        $gdResult = $this->writeGd($qrCode, $logo, $label, $options);
 
         return new GifResult($gdResult->getMatrix(), $gdResult->getImage());
     }
-
-    public function validateResult(ResultInterface $result, string $expectedData): void
-    {
-        $this->gdWriter->validateResult($result, $expectedData);
-    }
 }

src/Writer/PngWriter.php

@@ -12,14 +12,11 @@
 
 final readonly class PngWriter implements WriterInterface, ValidatingWriterInterface
 {
+    use GdTrait;
+
     public const WRITER_OPTION_COMPRESSION_LEVEL = 'compression_level';
     public const WRITER_OPTION_NUMBER_OF_COLORS = 'number_of_colors';
 
-    public function __construct(
-        private GdWriter $gdWriter = new GdWriter(),
-    ) {
-    }
-
     public function write(QrCodeInterface $qrCode, ?LogoInterface $logo = null, ?LabelInterface $label = null, array $options = []): ResultInterface
     {
         if (!isset($options[self::WRITER_OPTION_COMPRESSION_LEVEL])) {
@@ -34,7 +31,7 @@ public function write(QrCodeInterface $qrCode, ?LogoInterface $logo = null, ?Lab
             };
         }
 
-        $gdResult = $this->gdWriter->write($qrCode, $logo, $label, $options);
+        $gdResult = $this->writeGd($qrCode, $logo, $label, $options);
 
         return new PngResult(
             $gdResult->getMatrix(),
@@ -43,9 +40,4 @@ public function write(QrCodeInterface $qrCode, ?LogoInterface $logo = null, ?Lab
             $options[self::WRITER_OPTION_NUMBER_OF_COLORS]
         );
     }
-
-    public function validateResult(ResultInterface $result, string $expectedData): void
-    {
-        $this->gdWriter->validateResult($result, $expectedData);
-    }
 }

src/Writer/WebPWriter.php

@@ -12,26 +12,18 @@
 
 final readonly class WebPWriter implements WriterInterface, ValidatingWriterInterface
 {
-    public const WRITER_OPTION_QUALITY = 'quality';
+    use GdTrait;
 
-    public function __construct(
-        private GdWriter $gdWriter = new GdWriter(),
-    ) {
-    }
+    public const WRITER_OPTION_QUALITY = 'quality';
 
     public function write(QrCodeInterface $qrCode, ?LogoInterface $logo = null, ?LabelInterface $label = null, array $options = []): ResultInterface
     {
         if (!isset($options[self::WRITER_OPTION_QUALITY])) {
             $options[self::WRITER_OPTION_QUALITY] = -1;
         }
 
-        $gdResult = $this->gdWriter->write($qrCode, $logo, $label, $options);
+        $gdResult = $this->writeGd($qrCode, $logo, $label, $options);
 
         return new WebPResult($gdResult->getMatrix(), $gdResult->getImage(), $options[self::WRITER_OPTION_QUALITY]);
     }
-
-    public function validateResult(ResultInterface $result, string $expectedData): void
-    {
-        $this->gdWriter->validateResult($result, $expectedData);
-    }
 }