Merge pull request #101 from RickJeroen/master

Added support for Free character field

Author: Willem Stuursma-Ruwen

src/BaseTransactionLine.php

@@ -6,6 +6,7 @@
 use PhpTwinfield\Enums\LineType;
 use PhpTwinfield\Transactions\TransactionLine;
 use PhpTwinfield\Transactions\TransactionLineFields\CommentField;
+use PhpTwinfield\Transactions\TransactionLineFields\FreeCharField;
 use PhpTwinfield\Transactions\TransactionLineFields\ThreeDimFields;
 use PhpTwinfield\Transactions\TransactionLineFields\ValueFields;
 use PhpTwinfield\Transactions\TransactionLineFields\VatTurnoverFields;
@@ -16,7 +17,6 @@
  * @todo $vatBaseValue Only if line type is detail. VAT amount in base currency.
  * @todo $vatRepValue Only if line type is detail. VAT amount in reporting currency.
  * @todo $destOffice Office code. Used for inter company transactions.
- * @todo $freeChar Free character field. Meaning differs per transaction type.
  * @todo $comment Comment set on the transaction line.
  * @todo $matches Contains matching information. Read-only attribute.
  *
@@ -28,6 +28,7 @@ abstract class BaseTransactionLine implements TransactionLine
     use ThreeDimFields;
     use VatTurnoverFields;
     use CommentField;
+    use FreeCharField;
 
     public const MATCHSTATUS_AVAILABLE    = 'available';
     public const MATCHSTATUS_MATCHED      = 'matched';

src/DomDocuments/TransactionsDocument.php

@@ -9,6 +9,7 @@
 use PhpTwinfield\Transactions\TransactionFields\DueDateField;
 use PhpTwinfield\Transactions\TransactionFields\InvoiceNumberField;
 use PhpTwinfield\Transactions\TransactionFields\PaymentReferenceField;
+use PhpTwinfield\Transactions\TransactionLineFields\FreeCharField;
 use PhpTwinfield\Transactions\TransactionLineFields\PerformanceFields;
 use PhpTwinfield\Transactions\TransactionLineFields\VatTotalFields;
 use PhpTwinfield\Util;
@@ -147,6 +148,15 @@ public function addTransaction(BaseTransaction $transaction)
                 }
             }
 
+            if (Util::objectUses(FreeCharField::class, $transactionLine)) {
+                /** @var FreeCharField $transactionLine */
+                $freeChar = $transactionLine->getFreeChar();
+                if (!empty($freeChar)) {
+                    $freeCharElement = $this->createNodeWithTextContent('freechar', $freeChar);
+                    $lineElement->appendChild($freeCharElement);
+                }
+            }
+
             if (Util::objectUses(VatTotalFields::class, $transactionLine)) {
                 /** @var VatTotalFields $transactionLine */
                 $vatTotal = $transactionLine->getVatTotal();

src/Transactions/BankTransactionLine/Base.php

@@ -10,6 +10,7 @@
 use PhpTwinfield\Transactions\TransactionFields\InvoiceNumberField;
 use PhpTwinfield\Transactions\TransactionLine;
 use PhpTwinfield\Transactions\TransactionLineFields\CommentField;
+use PhpTwinfield\Transactions\TransactionLineFields\FreeCharField;
 use PhpTwinfield\Transactions\TransactionLineFields\ThreeDimFields;
 use PhpTwinfield\Transactions\TransactionLineFields\ValueFields;
 use Webmozart\Assert\Assert;
@@ -19,6 +20,7 @@ abstract class Base implements TransactionLine
     use ValueFields;
     use ThreeDimFields;
     use CommentField;
+    use FreeCharField;
 
     /**
      * Note that the field is not in the documentation but it is in all the examples.
@@ -48,13 +50,6 @@ abstract class Base implements TransactionLine
      */
     private $destOffice;
 
-    /**
-     * Free character field. (1 char)
-     *
-     * @var string
-     */
-    private $freeChar;
-
     /**
      * @var BankTransaction
      */
@@ -136,24 +131,6 @@ public function setDestOffice(Office $destOffice)
         return $this;
     }
 
-    /**
-     * @return string
-     */
-    public function getFreeChar(): ?string
-    {
-        return $this->freeChar;
-    }
-
-    /**
-     * @param string $freeChar
-     * @return $this
-     */
-    public function setFreeChar(string $freeChar)
-    {
-        $this->freeChar = $freeChar;
-        return $this;
-    }
-
     public function getId(): ?int
     {
         return $this->id;
@@ -185,4 +162,4 @@ protected function isIncomingTransactionType(): bool
     {
         return true;
     }
-}
+}

src/Transactions/TransactionLineFields/FreeCharField.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace PhpTwinfield\Transactions\TransactionLineFields;
+
+use Webmozart\Assert\Assert;
+
+trait FreeCharField
+{
+    /**
+     * If line type is total and filled with N the sales invoice is excluded from direct debit runs done in Twinfield.
+     *
+     * @var string|null
+     */
+    private $freeChar;
+
+    /**
+     * @return string|null
+     */
+    public function getFreeChar(): ?string
+    {
+        return $this->freeChar;
+    }
+
+    /**
+     * @param string|null $freeChar
+     * @return $this
+     */
+    public function setFreeChar(?string $freeChar): self
+    {
+        Assert::length($freeChar, 1);
+        $this->freeChar = $freeChar;
+
+        return $this;
+    }
+}