CreditTransfer::appendPurpose() - Code Metrics - Inspection of "PstlAdr field is optional is the Dbtr section for..." - z38/swiss-payment - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#28)

by z38

created 2018-07-16 13:13 UTC

CreditTransfer::appendPurpose() A

↳ Parent: CreditTransfer

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	7
cts	7
cp	1
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	2
crap	2

<?php

namespace Z38\SwissPayment\TransactionInformation;

use Z38\SwissPayment\Money\Money;
use Z38\SwissPayment\PaymentInformation\PaymentInformation;
use Z38\SwissPayment\PostalAddressInterface;
use Z38\SwissPayment\Text;

/**
 * CreditTransfer contains all the information about the beneficiary and further information about the transaction.
 */
abstract class CreditTransfer
{
    /**
     * @var string
     */
    protected $instructionId;

    /**
     * @var string
     */
    protected $endToEndId;

    /**
     * @var string
     */
    protected $creditorName;

    /**
     * @var PostalAddressInterface|null
     */
    protected $creditorAddress;

    /**
     * @var Money
     */
    protected $amount;

    /**
     * @var string|null
     */
    protected $localInstrument;

    /**
     * @var string|null
     */
    protected $serviceLevel;

    /**
     * @var PurposeCode|null
     */
    protected $purpose;

    /**
     * @var string|null
     */
    protected $remittanceInformation;

    /**
     * Constructor
     *
     * @param string                      $instructionId   Identifier of the instruction (should be unique within the message)
     * @param string                      $endToEndId      End-To-End Identifier of the instruction (passed unchanged along the complete processing chain)
     * @param Money                       $amount          Amount of money to be transferred
     * @param string                      $creditorName    Name of the creditor
     * @param PostalAddressInterface|null $creditorAddress Address of the creditor
     *
     * @throws \InvalidArgumentException When any of the inputs contain invalid characters or are too long.
     */
    public function __construct($instructionId, $endToEndId, Money $amount, $creditorName, PostalAddressInterface $creditorAddress = null)
    {
        $this->instructionId = Text::assertIdentifier($instructionId);
        $this->endToEndId = Text::assertIdentifier($endToEndId);
        $this->amount = $amount;
        $this->creditorName = Text::assert($creditorName, 70);
        $this->creditorAddress = $creditorAddress;
    }

    /**
     * Gets the local instrument
     *
     * @return string|null The local instrument
     */
    public function getLocalInstrument()
    {
        return $this->localInstrument;
    }

    /**
     * Gets the service level
     *
     * @return string|null The service level
     */
    public function getServiceLevel()
    {
        return $this->serviceLevel;
    }

    /**
     * Sets the purpose of the payment
     *
     * @param PurposeCode $purpose The purpose
     *
     * @return CreditTransfer This credit transfer
     */
    public function setPurpose(PurposeCode $purpose)
    {
        $this->purpose = $purpose;

        return $this;
    }

    /**
     * Sets the unstructured remittance information
     *
     * @param string|null $remittanceInformation
     *
     * @return CreditTransfer This credit transfer
     *
     * @throws \InvalidArgumentException When the information contains invalid characters or is too long.
     */
    public function setRemittanceInformation($remittanceInformation)
    {
        $this->remittanceInformation = Text::assertOptional($remittanceInformation, 140);

        return $this;
    }

    /**
     * Gets the instructed amount of this transaction
     *
     * @return Money The instructed amount
     */
    public function getAmount()
    {
        return $this->amount;
    }

    /**
     * Builds a DOM tree of this transaction
     *
     * @param \DOMDocument       $doc
     * @param PaymentInformation $paymentInformation Information on B-level
     *
     * @return \DOMElement The built DOM tree
     */
    abstract public function asDom(\DOMDocument $doc, PaymentInformation $paymentInformation);

    /**
     * Builds a DOM tree of this transaction and adds header nodes
     *
     * @param \DOMDocument       $doc
     * @param PaymentInformation $paymentInformation The corresponding B-level element
     *
     * @return \DOMNode The built DOM node
     */
    protected function buildHeader(\DOMDocument $doc, PaymentInformation $paymentInformation)
    {
        $root = $doc->createElement('CdtTrfTxInf');

        $id = $doc->createElement('PmtId');
        $id->appendChild(Text::xml($doc, 'InstrId', $this->instructionId));
        $id->appendChild(Text::xml($doc, 'EndToEndId', $this->endToEndId));
        $root->appendChild($id);

        if (!$paymentInformation->hasPaymentTypeInformation() && ($this->localInstrument !== null || $this->serviceLevel !== null)) {
            $paymentType = $doc->createElement('PmtTpInf');
            if ($this->localInstrument !== null) {
                $localInstrumentNode = $doc->createElement('LclInstrm');
                $localInstrumentNode->appendChild($doc->createElement('Prtry', $this->localInstrument));
                $paymentType->appendChild($localInstrumentNode);
            }
            if ($this->serviceLevel !== null) {
                $serviceLevelNode = $doc->createElement('SvcLvl');
                $serviceLevelNode->appendChild($doc->createElement('Cd', $this->serviceLevel));
                $paymentType->appendChild($serviceLevelNode);
            }
            $root->appendChild($paymentType);
        }

        $amount = $doc->createElement('Amt');
        $instdAmount = $doc->createElement('InstdAmt', $this->amount->format());
        $instdAmount->setAttribute('Ccy', $this->amount->getCurrency());
        $amount->appendChild($instdAmount);
        $root->appendChild($amount);

        return $root;
    }

    /**
     * Builds a DOM node of the Creditor field
     *
     * @param \DOMDocument $doc
     *
     * @return \DOMNode The built DOM node
     */
    protected function buildCreditor(\DOMDocument $doc)
    {
        $creditor = $doc->createElement('Cdtr');
        $creditor->appendChild(Text::xml($doc, 'Nm', $this->creditorName));
        if ($this->creditorAddress !== null) {
            $creditor->appendChild($this->creditorAddress->asDom($doc));
        }

        return $creditor;
    }

    /**
     * Appends the purpose to the transaction
     *
     * @param \DOMDocument $doc
     * @param \DOMElement  $transaction
     */
    protected function appendPurpose(\DOMDocument $doc, \DOMElement $transaction)
    {
        if ($this->purpose !== null) {
            $purposeNode = $doc->createElement('Purp');
            $purposeNode->appendChild($this->purpose->asDom($doc));
            $transaction->appendChild($purposeNode);
        }
    }

    /**
     * Appends the remittance information to the transaction
     *
     * @param \DOMDocument $doc
     * @param \DOMElement  $transaction
     */
    protected function appendRemittanceInformation(\DOMDocument $doc, \DOMElement $transaction)
    {
        if (!empty($this->remittanceInformation)) {
            $remittanceNode = $doc->createElement('RmtInf');
            $remittanceNode->appendChild(Text::xml($doc, 'Ustrd', $this->remittanceInformation));
            $transaction->appendChild($remittanceNode);
        }
    }
}


1		<?php
2
3		namespace Z38\SwissPayment\TransactionInformation;
4
5		use Z38\SwissPayment\Money\Money;
6		use Z38\SwissPayment\PaymentInformation\PaymentInformation;
7		use Z38\SwissPayment\PostalAddressInterface;
8		use Z38\SwissPayment\Text;
9
10		/**
11		* CreditTransfer contains all the information about the beneficiary and further information about the transaction.
12		*/
13		abstract class CreditTransfer
14		{
15		/**
16		* @var string
17		*/
18		protected $instructionId;
19
20		/**
21		* @var string
22		*/
23		protected $endToEndId;
24
25		/**
26		* @var string
27		*/
28		protected $creditorName;
29
30		/**
31		* @var PostalAddressInterface\|null
32		*/
33		protected $creditorAddress;
34
35		/**
36		* @var Money
37		*/
38		protected $amount;
39
40		/**
41		* @var string\|null
42		*/
43		protected $localInstrument;
44
45		/**
46		* @var string\|null
47		*/
48		protected $serviceLevel;
49
50		/**
51		* @var PurposeCode\|null
52		*/
53		protected $purpose;
54
55		/**
56		* @var string\|null
57		*/
58		protected $remittanceInformation;
59
60		/**
61		* Constructor
62		*
63		* @param string $instructionId Identifier of the instruction (should be unique within the message)
64		* @param string $endToEndId End-To-End Identifier of the instruction (passed unchanged along the complete processing chain)
65		* @param Money $amount Amount of money to be transferred
66		* @param string $creditorName Name of the creditor
67		* @param PostalAddressInterface\|null $creditorAddress Address of the creditor
68		*
69		* @throws \InvalidArgumentException When any of the inputs contain invalid characters or are too long.
70		*/
71	3	public function __construct($instructionId, $endToEndId, Money $amount, $creditorName, PostalAddressInterface $creditorAddress = null)
72		{
73	3	$this->instructionId = Text::assertIdentifier($instructionId);
74	3	$this->endToEndId = Text::assertIdentifier($endToEndId);
75	3	$this->amount = $amount;
76	3	$this->creditorName = Text::assert($creditorName, 70);
77	3	$this->creditorAddress = $creditorAddress;
78	3	}
79
80		/**
81		* Gets the local instrument
82		*
83		* @return string\|null The local instrument
84		*/
85	2	public function getLocalInstrument()
86		{
87	2	return $this->localInstrument;
88		}
89
90		/**
91		* Gets the service level
92		*
93		* @return string\|null The service level
94		*/
95	2	public function getServiceLevel()
96		{
97	2	return $this->serviceLevel;
98		}
99
100		/**
101		* Sets the purpose of the payment
102		*
103		* @param PurposeCode $purpose The purpose
104		*
105		* @return CreditTransfer This credit transfer
106		*/
107	3	public function setPurpose(PurposeCode $purpose)
108		{
109	3	$this->purpose = $purpose;
110
111	3	return $this;
112		}
113
114		/**
115		* Sets the unstructured remittance information
116		*
117		* @param string\|null $remittanceInformation
118		*
119		* @return CreditTransfer This credit transfer
120		*
121		* @throws \InvalidArgumentException When the information contains invalid characters or is too long.
122		*/
123		public function setRemittanceInformation($remittanceInformation)
124		{
125		$this->remittanceInformation = Text::assertOptional($remittanceInformation, 140);
126
127		return $this;
128		}
129
130		/**
131		* Gets the instructed amount of this transaction
132		*
133		* @return Money The instructed amount
134		*/
135	2	public function getAmount()
136		{
137	2	return $this->amount;
138		}
139
140		/**
141		* Builds a DOM tree of this transaction
142		*
143		* @param \DOMDocument $doc
144		* @param PaymentInformation $paymentInformation Information on B-level
145		*
146		* @return \DOMElement The built DOM tree
147		*/
148		abstract public function asDom(\DOMDocument $doc, PaymentInformation $paymentInformation);
149
150		/**
151		* Builds a DOM tree of this transaction and adds header nodes
152		*
153		* @param \DOMDocument $doc
154		* @param PaymentInformation $paymentInformation The corresponding B-level element
155		*
156		* @return \DOMNode The built DOM node
157		*/
158	2	protected function buildHeader(\DOMDocument $doc, PaymentInformation $paymentInformation)
159		{
160	2	$root = $doc->createElement('CdtTrfTxInf');
161
162	2	$id = $doc->createElement('PmtId');
163	2	$id->appendChild(Text::xml($doc, 'InstrId', $this->instructionId));
164	2	$id->appendChild(Text::xml($doc, 'EndToEndId', $this->endToEndId));
165	2	$root->appendChild($id);
166
167	2	if (!$paymentInformation->hasPaymentTypeInformation() && ($this->localInstrument !== null \|\| $this->serviceLevel !== null)) {
168	2	$paymentType = $doc->createElement('PmtTpInf');
169	2	if ($this->localInstrument !== null) {
170	2	$localInstrumentNode = $doc->createElement('LclInstrm');
171	2	$localInstrumentNode->appendChild($doc->createElement('Prtry', $this->localInstrument));
172	2	$paymentType->appendChild($localInstrumentNode);
173	2	}
174	2	if ($this->serviceLevel !== null) {
175	2	$serviceLevelNode = $doc->createElement('SvcLvl');
176	2	$serviceLevelNode->appendChild($doc->createElement('Cd', $this->serviceLevel));
177	2	$paymentType->appendChild($serviceLevelNode);
178	2	}
179	2	$root->appendChild($paymentType);
180	2	}
181
182	2	$amount = $doc->createElement('Amt');
183	2	$instdAmount = $doc->createElement('InstdAmt', $this->amount->format());
184	2	$instdAmount->setAttribute('Ccy', $this->amount->getCurrency());
185	2	$amount->appendChild($instdAmount);
186	2	$root->appendChild($amount);
187
188	2	return $root;
189		}
190
191		/**
192		* Builds a DOM node of the Creditor field
193		*
194		* @param \DOMDocument $doc
195		*
196		* @return \DOMNode The built DOM node
197		*/
198	2	protected function buildCreditor(\DOMDocument $doc)
199		{
200	2	$creditor = $doc->createElement('Cdtr');
201	2	$creditor->appendChild(Text::xml($doc, 'Nm', $this->creditorName));
202	2	if ($this->creditorAddress !== null) {
203	2	$creditor->appendChild($this->creditorAddress->asDom($doc));
204	2	}
205
206	2	return $creditor;
207		}
208
209		/**
210		* Appends the purpose to the transaction
211		*
212		* @param \DOMDocument $doc
213		* @param \DOMElement $transaction
214		*/
215	2	protected function appendPurpose(\DOMDocument $doc, \DOMElement $transaction)
216		{
217	2	if ($this->purpose !== null) {
218	2	$purposeNode = $doc->createElement('Purp');
219	2	$purposeNode->appendChild($this->purpose->asDom($doc));
220	2	$transaction->appendChild($purposeNode);
221	2	}
222	2	}
223
224		/**
225		* Appends the remittance information to the transaction
226		*
227		* @param \DOMDocument $doc
228		* @param \DOMElement $transaction
229		*/
230	2	protected function appendRemittanceInformation(\DOMDocument $doc, \DOMElement $transaction)
231		{
232	2	if (!empty($this->remittanceInformation)) {
233		$remittanceNode = $doc->createElement('RmtInf');
234		$remittanceNode->appendChild(Text::xml($doc, 'Ustrd', $this->remittanceInformation));
235		$transaction->appendChild($remittanceNode);
236		}
237	2	}
238		}
239

z38 / swiss-payment

Pull Request — master (#28)

CreditTransfer::appendPurpose() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like