fix incorrect data being generated (fixes #43) (#45)

* fix incorrect data being generated (fixes #43)

* fix test

* fix return type

Author: RikudouSage

README.md

@@ -9,8 +9,6 @@ Currently used in Germany, Austria, Netherlands, Finland and Belgium.
 
 > See also QR code payment generator for [Czech](https://github.com/RikudouSage/QrPaymentCZ) or [Slovak](https://github.com/RikudouSage/QrPaymentSK) accounts
 
-> Using Symfony? See the [QR Payment Bundle](https://github.com/RikudouSage/QrPaymentBundle).
-
 ## Installation
 
 Via composer: `composer require rikudou/euqrpayment`
@@ -77,6 +75,7 @@ $payment
     ->setAmount(100)
     ->setPurpose(Purpose::ACCOUNT_MANAGEMENT)
     ->setRemittanceText("Invoice ID: XXX")
+    ->setCreditorReference('RF123456') // setting both creditor reference and remittance text will actually result in exception
     ->setInformation("This is some note")
     ->setCurrency("EUR");
 
@@ -100,12 +99,14 @@ than 70 characters
 - `setPurpose()` - `InvalidArgumentException` - if the purpose is longer than 4 characters
 - `setRemittanceText()` - `InvalidArgumentException` - if the remittance text is longer
 than 140 characters
+- `setCreditorReference()` - `InvalidArgumentException` - if the creditor reference is longer
+  than 35 characters
 - `setInformation()` and `setComment()` - `InvalidArgumentException` - if the comment is longer
 than 70 characters
 - `setCurrency()` - `InvalidArgumentException` - if the currency is not exactly 3 characters
 long
 - `getQrString()` - `LogicException` - if the beneficiary name is missing or if the
-resulting string is bigger than 331 bytes
+resulting string is bigger than 331 bytes or if both remittance text and creditor reference are set
 - `getQrImage()` - `LogicException` - if the `endroid/qr-code` library is not installed
 
 ## List of public methods
@@ -312,6 +313,27 @@ $payment = new QrPayment("CZ5530300000001325090010");
 $payment->getRemittanceText();
 ```
 
+### getCreditorReference()
+
+Returns the structured creditor reference. Defaults to empty string.
+
+**Returns**
+
+`string`
+
+**Example**
+
+```php
+<?php
+
+use rikudou\EuQrPayment\QrPayment;
+
+$payment = new QrPayment("CZ5530300000001325090010");
+$payment->setCreditorReference('RF123456');
+// do other stuff
+echo $payment->getCreditorReference();
+```
+
 ### getInformation() or getComment()
 
 Returns the information (comment) of the payment.
@@ -479,6 +501,8 @@ $payment->setPurpose(Purpose::TRUST_FUND);
 
 The payment reference, up to 140 characters.
 
+> Note: You cannot set both remittance text and creditor reference
+
 **Params**
 
 - `string $remittanceText` - the remittance text
@@ -498,6 +522,31 @@ $payment = new QrPayment("CZ5530300000001325090010");
 $payment->setRemittanceText("Invoice ID: ###");
 ```
 
+### setCreditorReference()
+
+The structured creditor reference (ISO 11649), up to 35 characters.
+
+> Note: You cannot set both remittance text and creditor reference
+
+**Params**
+
+- `string $creditorReference` - the remittance text
+
+**Returns**
+
+`$this`
+
+**Example**
+
+```php
+<?php
+
+use rikudou\EuQrPayment\QrPayment;
+
+$payment = new QrPayment("CZ5530300000001325090010");
+$payment->setCreditorReference("RF123456");
+```
+
 ### setInformation() or setComment()
 
 Comment for the payment, up to 70 characters. `setComment()` is alias to `setInformation()`.
@@ -588,6 +637,7 @@ My Cool Company
 CZ5530300000001325090010
 EUR100
 ACCT
+
 Invoice ID: XXX
 This is some note"
  */

src/QrPayment.php

@@ -47,6 +47,11 @@ final class QrPayment implements QrPaymentInterface
      */
     private $purpose = '';
 
+    /**
+     * @var string
+     */
+    private $creditorReference = '';
+
     /**
      * @var string
      */
@@ -236,20 +241,20 @@ public function setPurpose(string $purpose): QrPayment
     /**
      * @return string
      */
-    public function getRemittanceText(): string
+    public function getCreditorReference(): string
     {
-        return $this->remittanceText;
+        return $this->creditorReference;
     }
 
     /**
-     * @param string $remittanceText
+     * @param string $creditorReference
      *
      * @return QrPayment
      */
-    public function setRemittanceText(string $remittanceText): QrPayment
+    public function setCreditorReference(string $creditorReference): QrPayment
     {
-        $this->checkLength($remittanceText, 140);
-        $this->remittanceText = $remittanceText;
+        $this->checkLength($creditorReference, 35);
+        $this->creditorReference = $creditorReference;
 
         return $this;
     }
@@ -320,7 +325,7 @@ public function setCurrency(string $currency): QrPayment
 
     public function getQrString(): string
     {
-        $this->checkRequiredParameters();
+        $this->checkParameterValidity();
 
         $result = [];
         if ($validator = $this->getIban()->getValidator()) {
@@ -346,6 +351,7 @@ public function getQrString(): string
         $result[] = $this->getIban()->asString();
         $result[] = $amount ? $this->getCurrency() . $amount : '';
         $result[] = $this->getPurpose();
+        $result[] = $this->getCreditorReference();
         $result[] = $this->getRemittanceText();
         $result[] = $this->getInformation();
         foreach ($this->configuration->getCustomData() as $customDatum) {
@@ -416,6 +422,19 @@ public function getDueDate(): DateTimeInterface
         throw new UnsupportedMethodException('The European standard does not support setting due date');
     }
 
+    public function getRemittanceText(): string
+    {
+        return $this->remittanceText;
+    }
+
+    public function setRemittanceText(string $remittanceText): QrPayment
+    {
+        $this->checkLength($remittanceText, 140);
+        $this->remittanceText = $remittanceText;
+
+        return $this;
+    }
+
     /**
      * @param string $string
      * @param int    $max
@@ -429,10 +448,13 @@ private function checkLength(string $string, int $max, int $min = 1): void
         }
     }
 
-    private function checkRequiredParameters(): void
+    private function checkParameterValidity(): void
     {
         if (!$this->getBeneficiaryName()) {
             throw new \LogicException('The beneficiary name is a mandatory parameter');
         }
+        if ($this->getCreditorReference() && $this->getRemittanceText()) {
+            throw new \LogicException('Only creditor reference or remittance text or neither can be set but not both');
+        }
     }
 }

tests/Config/AbstractConfigurationTest.php

@@ -51,7 +51,7 @@ public function testGetCustomData()
     {
         // test default
         $instance = $this->getInstance();
-        self::assertCount(11, $this->getLines($instance));
+        self::assertCount(12, $this->getLines($instance));
 
         $config = new class extends AbstractConfiguration {
             public function getCustomData(): iterable
@@ -61,9 +61,9 @@ public function getCustomData(): iterable
             }
         };
         $instance = $this->getInstance($config);
-        self::assertCount(13, $this->getLines($instance));
-        self::assertEquals('A', $this->getLine($instance, 11));
-        self::assertEquals('B', $this->getLine($instance, 12));
+        self::assertCount(14, $this->getLines($instance));
+        self::assertEquals('A', $this->getLine($instance, 12));
+        self::assertEquals('B', $this->getLine($instance, 13));
     }
 
     public function testGetAmountPrecision()
@@ -164,7 +164,7 @@ public function getCustomData(): iterable
         $instance = $this->getInstance($config);
         $instance->setDueDate(new DateTimeImmutable('2025-01-01 12:00:00'));
         self::assertEquals('2025-01-01 12:00:00', $instance->getDueDate()->format('Y-m-d H:i:s'));
-        self::assertEquals('20250101', $this->getLine($instance, 11));
+        self::assertEquals('20250101', $this->getLine($instance, 12));
     }
 
     private function getInstance(AbstractConfiguration $configuration = null): QrPayment

tests/QrPaymentTest.php

@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: root
- * Date: 15.12.18
- * Time: 1:11.
- */
 
 namespace rikudou\EuQrPayment\Tests;
 
@@ -91,13 +85,34 @@ public function testGetQrString()
             ->setRemittanceText('Invoice ID: 1')
             ->setCharacterSet(CharacterSet::UTF_8);
 
-        $this->assertEquals("BCD\n002\n1\nSCT\nAIRACZPP\nMy Company\nCZ5530300000001325090010\nEUR10\nACCT\nInvoice ID: 1\nRandom comment", $payment->getQrString());
+        $this->assertEquals("BCD\n002\n1\nSCT\nAIRACZPP\nMy Company\nCZ5530300000001325090010\nEUR10\nACCT\n\nInvoice ID: 1\nRandom comment", $payment->getQrString());
 
         $payment = $this->getDefaultPayment();
-        $payment// no unnecessary parameters
+        $payment
+            ->setPurpose(Purpose::ACCOUNT_MANAGEMENT)
+            ->setBeneficiaryName('My Company')
+            ->setSwift('AIRACZPP')
+            ->setAmount(10)
+            ->setCurrency('EUR')
+            ->setComment('Random comment')
+            ->setCreditorReference('RF0000000')
+            ->setCharacterSet(CharacterSet::UTF_8);
+
+        $this->assertEquals("BCD\n002\n1\nSCT\nAIRACZPP\nMy Company\nCZ5530300000001325090010\nEUR10\nACCT\nRF0000000\n\nRandom comment", $payment->getQrString());
+
+        $payment = $this->getDefaultPayment();
+        $payment // no unnecessary parameters
         ->setBeneficiaryName('My Company');
 
-        $this->assertEquals("BCD\n002\n1\nSCT\n\nMy Company\nCZ5530300000001325090010\n\n\n\n", $payment->getQrString());
+        $this->assertEquals("BCD\n002\n1\nSCT\n\nMy Company\nCZ5530300000001325090010\n\n\n\n\n", $payment->getQrString());
+
+        $this->expectException(LogicException::class);
+        $payment = $this->getDefaultPayment();
+        $payment
+            ->setBeneficiaryName('My Company')
+            ->setRemittanceText('test')
+            ->setCreditorReference('RF123');
+        $payment->getQrString();
     }
 
     public function testGetQrStringNoBeneficiary()
@@ -366,6 +381,7 @@ public function testSetOptions()
             'amount' => 150.34,
             'purpose' => Purpose::ACCOUNT_OVERDRAFT_REPAYMENT,
             'remittanceText' => 'Some string',
+            'creditorReference' => 'Some creditor',
             'information' => 'Another string',
             'currency' => 'USD',
         ];
@@ -378,6 +394,7 @@ public function testSetOptions()
         self::assertEquals($options['amount'], $instance->getAmount());
         self::assertEquals($options['purpose'], $instance->getPurpose());
         self::assertEquals($options['remittanceText'], $instance->getRemittanceText());
+        self::assertEquals($options['creditorReference'], $instance->getCreditorReference());
         self::assertEquals($options['information'], $instance->getInformation());
         self::assertEquals($options['currency'], $instance->getCurrency());
     }
@@ -398,6 +415,21 @@ public function testSetOptionsNonexistentProperty()
         ]);
     }
 
+    public function testSetCreditorReference()
+    {
+        $strings = [
+            $this->getRandomString(10),
+            $this->getRandomString(35),
+            $this->getRandomString(36),
+        ];
+
+        $this->assertEquals($strings[0], $this->getDefaultPayment()->setCreditorReference($strings[0])->getCreditorReference());
+        $this->assertEquals($strings[1], $this->getDefaultPayment()->setCreditorReference($strings[1])->getCreditorReference());
+
+        $this->expectException(InvalidArgumentException::class);
+        $this->getDefaultPayment()->setCreditorReference($strings[2]);
+    }
+
     private function getDefaultPayment(): QrPayment
     {
         return new QrPayment('CZ5530300000001325090010');