Merge pull request #272 from sprain/code-improvements

Minor code improvements
sprain · Dec 7, 2024 · bf317d5 · bf317d5
2 parents 5881f1c + 63ea4dd
commit bf317d5
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 12 deletions.
diff --git a/src/PaymentPart/Output/AbstractOutput.php b/src/PaymentPart/Output/AbstractOutput.php
@@ -32,7 +32,7 @@ public function getLanguage(): ?string
     }
 
     /**
-     * @deprecated Will be removed in next major release. Use setDisplayOptions() instead.
+     * @deprecated Will be removed in v5. Use setDisplayOptions() instead.
      */
     public function setPrintable(bool $printable): static
     {
@@ -42,7 +42,7 @@ public function setPrintable(bool $printable): static
     }
 
     /**
-     * @deprecated Will be removed in next major release. Use getDisplayOptions() instead.
+     * @deprecated Will be removed in v5. Use getDisplayOptions() instead.
      */
     public function isPrintable(): bool
     {

diff --git a/src/Reference/QrPaymentReferenceGenerator.php b/src/Reference/QrPaymentReferenceGenerator.php
@@ -14,34 +14,45 @@ final class QrPaymentReferenceGenerator implements SelfValidatableInterface
 {
     use SelfValidatableTrait;
 
-    private ?string $customerIdentificationNumber = null;
-    private string $referenceNumber;
-
     public static function generate(?string $customerIdentificationNumber, string $referenceNumber): string
     {
         $qrPaymentReferenceGenerator = new self($customerIdentificationNumber, $referenceNumber);
 
         return $qrPaymentReferenceGenerator->doGenerate();
     }
 
-    public function __construct(?string $customerIdentificationNumber, string $referenceNumber)
-    {
+    /**
+     * @internal Will be made private in v5. Use QrPaymentReferenceGenerator::generate() instead.
+     */
+    public function __construct(
+        private ?string $customerIdentificationNumber,
+        private string $referenceNumber
+    ) {
         if (null !== $customerIdentificationNumber) {
             $this->customerIdentificationNumber = StringModifier::stripWhitespace($customerIdentificationNumber);
         }
         $this->referenceNumber = StringModifier::stripWhitespace($referenceNumber);
     }
 
+    /**
+     * @deprecated Will be removed in v5.
+     */
     public function getCustomerIdentificationNumber(): ?string
     {
         return $this->customerIdentificationNumber;
     }
 
-    public function getReferenceNumber(): ?string
+    /**
+     * @deprecated Will be removed in v5.
+     */
+    public function getReferenceNumber(): string
     {
         return $this->referenceNumber;
     }
 
+    /**
+     * @internal Will be made private in v5. Use QrPaymentReferenceGenerator::generate() instead.
+     */
     public function doGenerate(): string
     {
         if (!$this->isValid()) {
@@ -53,7 +64,7 @@ public function doGenerate(): string
         $completeReferenceNumber  = $this->getCustomerIdentificationNumber();
 
         $strlen = $completeReferenceNumber ? strlen($completeReferenceNumber) : 0;
-        $completeReferenceNumber .= str_pad((string) $this->getReferenceNumber(), 26 - $strlen, '0', STR_PAD_LEFT);
+        $completeReferenceNumber .= str_pad($this->getReferenceNumber(), 26 - $strlen, '0', STR_PAD_LEFT);
         $completeReferenceNumber .= $this->modulo10($completeReferenceNumber);
 
         return $completeReferenceNumber;

diff --git a/src/Reference/RfCreditorReferenceGenerator.php b/src/Reference/RfCreditorReferenceGenerator.php
@@ -14,16 +14,17 @@ final class RfCreditorReferenceGenerator implements SelfValidatableInterface
 {
     use SelfValidatableTrait;
 
-    private string $reference;
-
     public static function generate(string $reference): string
     {
         $generator = new self($reference);
 
         return $generator->doGenerate();
     }
 
-    public function __construct(string $reference)
+    /**
+     * @internal Will be made private in v5. Use RfCreditorReferenceGenerator::generate() instead.
+     */
+    public function __construct(private string $reference)
     {
         $this->reference = StringModifier::stripWhitespace($reference);
     }