Add possibility to show scissors instead of text if printable=false

src/PaymentPart/Output/AbstractOutput.php

@@ -35,6 +35,23 @@ public function getLanguage(): ?string
         return $this->language;
     }
 
+    /**
+     * @deprecated Will be removed in next major release. Use setPrintOptions() instead.
+     */
+    public function setPrintable(bool $printable): static
+    {
+        $this->printOptions->setPrintable($printable);
+        return $this;
+    }
+
+    /**
+     * @deprecated Will be removed in next major release. Use getPrintOptions() instead.
+     */
+    public function isPrintable(): bool
+    {
+        return $this->printOptions->isPrintable();
+    }
+
     public function setPrintOptions(PrintOptions $printOptions): static
     {
         $this->printOptions = $printOptions;

src/PaymentPart/Output/FpdfOutput/FpdfOutput.php

@@ -235,19 +235,19 @@ private function addSeparatorContentIfNotPrintable(): void
             return;
         }
 
-        if ($layout->getLineStyle() !== LineStyle::NONE) {
-            if ($layout->getLineStyle() === LineStyle::DASHED) {
+        if ($layout->getLineStyle() !== LineStyle::$NONE) {
+            if ($layout->getLineStyle() === LineStyle::$DASHED) {
                 if (!method_exists($this->fpdf, 'swissQrBillSetDash')) {
                     throw new MissingTraitException('Missing FpdfTrait in this fpdf instance. See fpdf-example.php within this library.');
                 }
             }
             $this->fpdf->SetLineWidth(0.1);
-            if ($layout->getLineStyle() === LineStyle::DASHED) {
+            if ($layout->getLineStyle() === LineStyle::$DASHED) {
                 $this->fpdf->swissQrBillSetDash(2, 1);
             }
             $this->fpdf->Line(2 + $this->offsetX, 193 + $this->offsetY, 208 + $this->offsetX, 193 + $this->offsetY);
             $this->fpdf->Line(62 + $this->offsetX, 193 + $this->offsetY, 62 + $this->offsetX, 296 + $this->offsetY);
-            if ($layout->getLineStyle() === LineStyle::DASHED) {
+            if ($layout->getLineStyle() === LineStyle::$DASHED) {
                 $this->fpdf->swissQrBillSetDash(0);
             }
         }
@@ -261,7 +261,7 @@ private function addSeparatorContentIfNotPrintable(): void
             if (!method_exists($this->fpdf, 'swissQrBillTextWithRotation')) {
                 throw new MissingTraitException('Missing FpdfTrait in this fpdf instance. See fpdf-example.php within this library.');
             }
-            if ($layout->getVerticalSeparatorSymbolPosition() === VerticalSeparatorSymbolPosition::TOP) {
+            if ($layout->getVerticalSeparatorSymbolPosition() === VerticalSeparatorSymbolPosition::$TOP) {
                 $this->fpdf->swissQrBillTextWithRotation(62 + $this->offsetX - 1.7, 193 + $this->offsetY + 4, self::FONT_UNICODE_CHAR_SCISSORS, -90);
             } else {
                 $this->fpdf->swissQrBillTextWithRotation(62 + $this->offsetX + 1.7, 193 + $this->offsetY + 90, self::FONT_UNICODE_CHAR_SCISSORS, 90);

src/PaymentPart/Output/FpdfOutput/FpdfTrait.php

@@ -2,17 +2,16 @@
 
 namespace Sprain\SwissQrBill\PaymentPart\Output\FpdfOutput;
 
+/**
+ * @internal DO NOT USE IT. Its purpose is only for the Swiss QR Bill library. Name and/or
+ * signature may change without any notification
+ */
 trait FpdfTrait
 {
     /**
      * Set dash line style for the next ->Line() command
-     * DO NOT USE IT. Its purpose is only for the Swiss QR Bill library. Name and/or
-     * signature may change without any notification.
      *
      * @see http://www.fpdf.org/en/script/script33.php
-     * @param float $black Width of black dash. 0 to reset to solid line
-     * @param ?float $white Width of white dash. Defaults to same as black
-     * @return void
      */
     public function swissQrBillSetDash(float $black = 0, ?float $white = null): void
     {
@@ -31,12 +30,6 @@ public function swissQrBillSetDash(float $black = 0, ?float $white = null): void
      * signature may change without any notification.
      *
      * @see http://www.fpdf.org/en/script/script31.php
-     * @param float $x
-     * @param float $y
-     * @param string $txt
-     * @param float $txtAngle
-     * @param float $fontAngle
-     * @return void
      */
     public function swissQrBillTextWithRotation(float $x, float $y, string $txt, float $txtAngle = 0, float $fontAngle = 0): void
     {

src/PaymentPart/Output/HtmlOutput/HtmlOutput.php

@@ -134,15 +134,15 @@ private function hideSeparatorContentIfPrintable(string $paymentPart): string
             if ($layout->hasSeparatorSymbol()) {
                 // draw scissors
                 $printableStyles = PrintableStylesTemplate::TEMPLATE_SCISSORS;
-                if ($layout->getVerticalSeparatorSymbolPosition() === VerticalSeparatorSymbolPosition::BOTTOM) {
+                if ($layout->getVerticalSeparatorSymbolPosition() === VerticalSeparatorSymbolPosition::$BOTTOM) {
                     // draw vertical scissors at bottom
                     $printableStyles .= PrintableStylesTemplate::TEMPLATE_VERTICAL_SCISSORS_DOWN;
                 }
             }
             if (!$layout->hasText()) {
-                // hide texte
+                // hide text
                 $printableStyles .= PrintableStylesTemplate::TEMPLATE_HIDE_TEXT;
-            } else if ($layout->hasTextDownArrows()) {
+            } elseif ($layout->hasTextDownArrows()) {
                 // text not hidden and draw text arrows
                 $printableStyles .= PrintableStylesTemplate::TEMPLATE_TEXT_DOWN_ARROWS;
             }

src/PaymentPart/Output/HtmlOutput/Template/PrintableStylesTemplate.php

@@ -68,7 +68,7 @@ class PrintableStylesTemplate
 }
 EOT;
 
-public const TEMPLATE_TEXT_DOWN_ARROWS = <<<EOT
+    public const TEMPLATE_TEXT_DOWN_ARROWS = <<<EOT
 #qr-bill-separate-info-text:before {
     display: inline-block;
     content: '\\25BC \\25BC \\25BC';

src/PaymentPart/Output/PrintOptions.php

@@ -2,28 +2,46 @@
 
 namespace Sprain\SwissQrBill\PaymentPart\Output;
 
-enum LineStyle
+/**
+ * @internal This class is meant to be an ENUM. But because it must be compatible
+ * with PHP 8.0, ENUMs should not be used, since they exist only from PHP 8.1
+ * The idea here is to have a usage as close as an ENUM.
+ *
+ * There would be two breaking changes for consumers:
+ * 1. remove the $ in front of the name: LineStyle::$SOLID becomes LineStyle::SOLID.
+ * 2. only an ENUM value could be given to the method setXXX(). Now, standard strings are also accepted
+ */
+final class LineStyle
 {
-    case SOLID;
-    case DASHED;
-    case NONE;
+    public static $SOLID = 'SOLID';
+    public static $DASHED = 'DASHED';
+    public static $NONE = 'NONE';
 }
 
-enum VerticalSeparatorSymbolPosition
+/**
+ * @internal See internal comment for LineStyle above
+ */
+final class VerticalSeparatorSymbolPosition
 {
-    case TOP;
-    case BOTTOM;
+    public static $TOP = 'TOP';
+    public static $BOTTOM = 'BOTTOM';
 }
 
 final class PrintOptions
 {
     private bool $printable = false;
     private bool $separatorSymbol = false;
-    private VerticalSeparatorSymbolPosition $verticalSeparatorSymbolPosition = VerticalSeparatorSymbolPosition::TOP;
+    private VerticalSeparatorSymbolPosition|string $verticalSeparatorSymbolPosition;
     private bool $textDownArrows = false;
-    private LineStyle $lineStyle = LineStyle::SOLID;
+    private LineStyle|string $lineStyle;
     private bool $text = true;
 
+    public function __construct()
+    {
+        $this->verticalSeparatorSymbolPosition = VerticalSeparatorSymbolPosition::$TOP;
+        $this->lineStyle = LineStyle::$SOLID;
+    }
+
     public function isPrintable(): bool
     {
         return $this->printable;
@@ -34,9 +52,9 @@ public function setPrintable(bool $value): static
         $this->printable = $value;
 
         if (!$this->printable) {
-            $this->lineStyle = $this->separatorSymbol ? LineStyle::DASHED : LineStyle::SOLID;
+            $this->lineStyle = $this->separatorSymbol ? LineStyle::$DASHED : LineStyle::$SOLID;
         } else {
-            $this->lineStyle = LineStyle::NONE;
+            $this->lineStyle = LineStyle::$NONE;
         }
         return $this;
     }
@@ -49,8 +67,11 @@ public function hasSeparatorSymbol(): bool
     public function setSeparatorSymbol(bool $value): static
     {
         $this->separatorSymbol = $value;
+        if ($this->separatorSymbol) {
+            $this->text = false;
+        }
         if (!$this->printable) {
-            $this->lineStyle = $this->separatorSymbol ? LineStyle::DASHED : LineStyle::SOLID;
+            $this->lineStyle = $this->separatorSymbol ? LineStyle::$DASHED : LineStyle::$SOLID;
         }
         return $this;
     }
@@ -74,21 +95,27 @@ public function hasText(): bool
     public function setText(bool $value): static
     {
         $this->text = $value;
+        if ($this->text) {
+            $this->separatorSymbol = false;
+        }
+        if (!$this->printable) {
+            $this->lineStyle = LineStyle::$SOLID;
+        }
         return $this;
     }
 
-    public function getVerticalSeparatorSymbolPosition(): VerticalSeparatorSymbolPosition
+    public function getVerticalSeparatorSymbolPosition(): VerticalSeparatorSymbolPosition|string
     {
         return $this->verticalSeparatorSymbolPosition;
     }
 
-    public function setVerticalSeparatorSymbolPosition(VerticalSeparatorSymbolPosition $value): static
+    public function setVerticalSeparatorSymbolPosition(VerticalSeparatorSymbolPosition|string $value): static
     {
         $this->verticalSeparatorSymbolPosition = $value;
         return $this;
     }
 
-    public function getLineStyle(): LineStyle
+    public function getLineStyle(): LineStyle|string
     {
         return $this->lineStyle;
     }

src/PaymentPart/Output/TcPdfOutput/TcPdfOutput.php

@@ -233,9 +233,9 @@ private function addSeparatorContentIfNotPrintable(): void
         $y = 193;
         $yend = 296;
 
-        if ($layout->getLineStyle() !== LineStyle::NONE) {
+        if ($layout->getLineStyle() !== LineStyle::$NONE) {
             $lineStyle = ['width' => 0.1, 'color' => [0, 0, 0]];
-            if ($layout->getLineStyle() === LineStyle::DASHED) {
+            if ($layout->getLineStyle() === LineStyle::$DASHED) {
                 $lineStyle['dash'] = '2';
             }
             $this->tcPdf->SetLineStyle($lineStyle);
@@ -250,7 +250,7 @@ private function addSeparatorContentIfNotPrintable(): void
             $this->setX($xstart + 3);
             $this->tcPdf->Cell(0, 10, self::FONT_UNICODE_CHAR_SCISSORS, 0, 0, 'L', false, '', 0, false, 'C');
             // vertical scissors
-            if ($layout->getVerticalSeparatorSymbolPosition() === VerticalSeparatorSymbolPosition::TOP) {
+            if ($layout->getVerticalSeparatorSymbolPosition() === VerticalSeparatorSymbolPosition::$TOP) {
                 $this->setY($y + 3);
                 $this->setX($xmiddle);
                 $this->tcPdf->StartTransform();

tests/PaymentPart/Output/FpdfOutput/FpdfOutputTest.php

@@ -42,19 +42,14 @@ public function testValidQrBills(string $name, QrBill $qrBill): void
                 'file' => dirname(dirname(dirname(__DIR__))) . '/TestData/FpdfOutput/' . $name . '.scissors.pdf'
             ],
             [
-                'layout' => (new PrintOptions())->setPrintable(false)->setSeparatorSymbol(true)->setVerticalSeparatorSymbolPosition(VerticalSeparatorSymbolPosition::BOTTOM),
+                'layout' => (new PrintOptions())->setPrintable(false)->setSeparatorSymbol(true)->setVerticalSeparatorSymbolPosition(VerticalSeparatorSymbolPosition::$BOTTOM),
                 'format' => QrCode::FILE_FORMAT_PNG,
                 'file' => __DIR__ . '/../../../TestData/FpdfOutput/' . $name . '.svg.scissorsdown.pdf'
             ],
             [
                 'layout' => (new PrintOptions())->setPrintable(false)->setText(true)->setTextDownArrows(true),
                 'format' => QrCode::FILE_FORMAT_PNG,
                 'file' => __DIR__ . '/../../../TestData/FpdfOutput/' . $name . '.svg.textarrows.pdf'
-            ],
-            [
-                'layout' => (new PrintOptions())->setPrintable(false)->setSeparatorSymbol(true)->setText(false),
-                'format' => QrCode::FILE_FORMAT_PNG,
-                'file' => __DIR__ . '/../../../TestData/FpdfOutput/' . $name . '.svg.textno.pdf'
             ]
         ];
 

tests/PaymentPart/Output/FpdfOutput/FpdiOutputTest.php

@@ -41,19 +41,14 @@ public function testValidQrBills(string $name, QrBill $qrBill): void
                 'file' => dirname(dirname(dirname(__DIR__))) . '/TestData/FpdfOutput/' . $name . '.scissors.pdf'
             ],
             [
-                'layout' => (new PrintOptions())->setPrintable(false)->setSeparatorSymbol(true)->setVerticalSeparatorSymbolPosition(VerticalSeparatorSymbolPosition::BOTTOM),
+                'layout' => (new PrintOptions())->setPrintable(false)->setSeparatorSymbol(true)->setVerticalSeparatorSymbolPosition(VerticalSeparatorSymbolPosition::$BOTTOM),
                 'format' => QrCode::FILE_FORMAT_PNG,
                 'file' => __DIR__ . '/../../../TestData/FpdfOutput/' . $name . '.svg.scissorsdown.pdf'
             ],
             [
                 'layout' => (new PrintOptions())->setPrintable(false)->setText(true)->setTextDownArrows(true),
                 'format' => QrCode::FILE_FORMAT_PNG,
                 'file' => __DIR__ . '/../../../TestData/FpdfOutput/' . $name . '.svg.textarrows.pdf'
-            ],
-            [
-                'layout' => (new PrintOptions())->setPrintable(false)->setSeparatorSymbol(true)->setText(false),
-                'format' => QrCode::FILE_FORMAT_PNG,
-                'file' => __DIR__ . '/../../../TestData/FpdfOutput/' . $name . '.svg.textno.pdf'
             ]
         ];
 

tests/PaymentPart/Output/HtmlOutput/HtmlOutputTest.php

@@ -38,7 +38,7 @@ public function testValidQrBills(string $name, QrBill $qrBill)
                 'file' => __DIR__ . '/../../../TestData/HtmlOutput/' . $name . $this->getCompact() . '.svg.scissors.html'
             ],
             [
-                'layout' => (new PrintOptions())->setPrintable(false)->setSeparatorSymbol(true)->setVerticalSeparatorSymbolPosition(VerticalSeparatorSymbolPosition::BOTTOM),
+                'layout' => (new PrintOptions())->setPrintable(false)->setSeparatorSymbol(true)->setVerticalSeparatorSymbolPosition(VerticalSeparatorSymbolPosition::$BOTTOM),
                 'format' => QrCode::FILE_FORMAT_SVG,
                 'file' => __DIR__ . '/../../../TestData/HtmlOutput/' . $name . '.svg.scissorsdown.html'
             ],
@@ -47,11 +47,6 @@ public function testValidQrBills(string $name, QrBill $qrBill)
                 'format' => QrCode::FILE_FORMAT_SVG,
                 'file' => __DIR__ . '/../../../TestData/HtmlOutput/' . $name . '.svg.textarrows.html'
             ],
-            [
-                'layout' => (new PrintOptions())->setPrintable(false)->setSeparatorSymbol(true)->setText(false),
-                'format' => QrCode::FILE_FORMAT_SVG,
-                'file' => __DIR__ . '/../../../TestData/HtmlOutput/' . $name . '.svg.textno.html'
-            ],
             /* PNGs do not create the same output in all environments
             [
                 'printable' => false,

tests/PaymentPart/Output/TcPdfOutput/FpdiOutputTest.php

@@ -37,7 +37,7 @@ public function testValidQrBills(string $name, QrBill $qrBill): void
                 'file' => __DIR__ . '/../../../TestData/TcPdfOutput/' . $name . '.svg.scissors.pdf'
             ],
             [
-                'layout' => (new PrintOptions())->setPrintable(false)->setSeparatorSymbol(true)->setVerticalSeparatorSymbolPosition(VerticalSeparatorSymbolPosition::BOTTOM),
+                'layout' => (new PrintOptions())->setPrintable(false)->setSeparatorSymbol(true)->setVerticalSeparatorSymbolPosition(VerticalSeparatorSymbolPosition::$BOTTOM),
                 'format' => QrCode::FILE_FORMAT_SVG,
                 'file' => __DIR__ . '/../../../TestData/TcPdfOutput/' . $name . '.svg.scissorsdown.pdf'
             ],
@@ -46,11 +46,6 @@ public function testValidQrBills(string $name, QrBill $qrBill): void
                 'format' => QrCode::FILE_FORMAT_SVG,
                 'file' => __DIR__ . '/../../../TestData/TcPdfOutput/' . $name . '.svg.textarrows.pdf'
             ],
-            [
-                'layout' => (new PrintOptions())->setPrintable(false)->setSeparatorSymbol(true)->setText(false),
-                'format' => QrCode::FILE_FORMAT_SVG,
-                'file' => __DIR__ . '/../../../TestData/TcPdfOutput/' . $name . '.svg.textno.pdf'
-            ],
             /* PNGs do not create the same output in all environments
             [
                 'printable' => false,

tests/PaymentPart/Output/TcPdfOutput/TcPdfOutputTest.php

@@ -36,7 +36,7 @@ public function testValidQrBills(string $name, QrBill $qrBill): void
                 'file' => __DIR__ . '/../../../TestData/TcPdfOutput/' . $name . '.svg.scissors.pdf'
             ],
             [
-                'layout' => (new PrintOptions())->setPrintable(false)->setSeparatorSymbol(true)->setVerticalSeparatorSymbolPosition(VerticalSeparatorSymbolPosition::BOTTOM),
+                'layout' => (new PrintOptions())->setPrintable(false)->setSeparatorSymbol(true)->setVerticalSeparatorSymbolPosition(VerticalSeparatorSymbolPosition::$BOTTOM),
                 'format' => QrCode::FILE_FORMAT_SVG,
                 'file' => __DIR__ . '/../../../TestData/TcPdfOutput/' . $name . '.svg.scissorsdown.pdf'
             ],
@@ -45,11 +45,6 @@ public function testValidQrBills(string $name, QrBill $qrBill): void
                 'format' => QrCode::FILE_FORMAT_SVG,
                 'file' => __DIR__ . '/../../../TestData/TcPdfOutput/' . $name . '.svg.textarrows.pdf'
             ],
-            [
-                'layout' => (new PrintOptions())->setPrintable(false)->setSeparatorSymbol(true)->setText(false),
-                'format' => QrCode::FILE_FORMAT_SVG,
-                'file' => __DIR__ . '/../../../TestData/TcPdfOutput/' . $name . '.svg.textno.pdf'
-            ],
             /* PNGs do not create the same output in all environments
             [
                 'printable' => false,

tests/TestData/HtmlOutput/qr-additional-information-compact.svg.scissors.html

@@ -200,6 +200,8 @@
     font-size: 16pt;
     top: -95mm;
     left: 54.5mm;
+}#qr-bill-separate-info-text {
+    display: none;
 }
 </style>
 

tests/TestData/HtmlOutput/qr-additional-information.svg.scissorsdown.html

@@ -208,6 +208,8 @@
     font-size: 16pt;
     top: -15mm;
     left: 54.7mm;
+}#qr-bill-separate-info-text {
+    display: none;
 }
 </style>