CreditTransfer::getAmount() - Code Metrics - Inspection of "Fix Scrutinizer configuration" - z38/swiss-payment - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2b893f...67432b )

by z38

created 2015-12-31 15:09 UTC

CreditTransfer::getAmount() A

↳ Parent: CreditTransfer

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Z38\SwissPayment\TransactionInformation;

use Z38\SwissPayment\Money\Money;
use Z38\SwissPayment\PostalAddressInterface;

/**
 * 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
     */
    protected $creditorAddress;

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

    /**
     * @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 $creditorAddress Address of the creditor
     */
    public function __construct($instructionId, $endToEndId, Money $amount, $creditorName, PostalAddressInterface $creditorAddress)
    {
        $this->instructionId = (string) $instructionId;
        $this->endToEndId = (string) $endToEndId;
        $this->amount = $amount;
        $this->creditorName = (string) $creditorName;
        $this->creditorAddress = $creditorAddress;
        $this->remittanceInformation = null;
    }

    /**
     * Sets the unstructured remittance information
     *
     * @param string|null $remittanceInformation
     *
     * @return CreditTransfer This credit transfer
     */
    public function setRemittanceInformation($remittanceInformation)
    {
        $this->remittanceInformation = $remittanceInformation;

        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
     *
     * @return \DOMElement The built DOM tree
     */
    abstract public function asDom(\DOMDocument $doc);

    /**
     * Builds a DOM tree of this transaction and adds header nodes
     *
     * @param \DOMDocument $doc
     * @param string|null  $localInstrument Local Instrument
     * @param string|null  $serviceLevel
     *
     * @return \DOMNode The built DOM node
     */
    protected function buildHeader(\DOMDocument $doc, $localInstrument = null, $serviceLevel = null)
    {
        $root = $doc->createElement('CdtTrfTxInf');

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

        if (!empty($localInstrument) || !empty($serviceLevel)) {
            $paymentType = $doc->createElement('PmtTpInf');
            if (!empty($localInstrument)) {
                $localInstrumentNode = $doc->createElement('LclInstrm');
                $localInstrumentNode->appendChild($doc->createElement('Prtry', $localInstrument));
                $paymentType->appendChild($localInstrumentNode);
            }
            if (!empty($serviceLevel)) {
                $serviceLevelNode = $doc->createElement('SvcLvl');
                $serviceLevelNode->appendChild($doc->createElement('Cd', $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($doc->createElement('Nm', $this->creditorName));
        $creditor->appendChild($this->creditorAddress->asDom($doc));

        return $creditor;
    }

    /**
     * Indicates whether remittance information is set
     *
     * @return bool true if remittance information is set
     */
    protected function hasRemittanceInformation()
    {
        return !empty($this->remittanceInformation);
    }

    /**
     * Builds a DOM node of the Remittance Information field
     *
     * @param \DOMDocument $doc
     *
     * @return \DOMNode The built DOM node
     *
     * @throws \LogicException When no remittance information is set
     */
    protected function buildRemittanceInformation(\DOMDocument $doc)
    {
        if ($this->hasRemittanceInformation()) {
            $remittance = $doc->createElement('RmtInf');
            $remittance->appendChild($doc->createElement('Ustrd', $this->remittanceInformation));

            return $remittance;
        } else {
            throw new \LogicException('Can not build node without data.');
        }
    }
}


1		<?php
2
3		namespace Z38\SwissPayment\TransactionInformation;
4
5		use Z38\SwissPayment\Money\Money;
6		use Z38\SwissPayment\PostalAddressInterface;
7
8		/**
9		* CreditTransfer contains all the information about the beneficiary and further information about the transaction.
10		*/
11		abstract class CreditTransfer
12		{
13		/**
14		* @var string
15		*/
16		protected $instructionId;
17
18		/**
19		* @var string
20		*/
21		protected $endToEndId;
22
23		/**
24		* @var string
25		*/
26		protected $creditorName;
27
28		/**
29		* @var PostalAddressInterface
30		*/
31		protected $creditorAddress;
32
33		/**
34		* @var Money
35		*/
36		protected $amount;
37
38		/**
39		* @var string\|null
40		*/
41		protected $remittanceInformation;
42
43		/**
44		* Constructor
45		*
46		* @param string $instructionId Identifier of the instruction (should be unique within the message)
47		* @param string $endToEndId End-To-End Identifier of the instruction (passed unchanged along the complete processing chain)
48		* @param Money $amount Amount of money to be transferred
49		* @param string $creditorName Name of the creditor
50		* @param PostalAddressInterface $creditorAddress Address of the creditor
51		*/
52	2	public function __construct($instructionId, $endToEndId, Money $amount, $creditorName, PostalAddressInterface $creditorAddress)
53		{
54	2	$this->instructionId = (string) $instructionId;
55	2	$this->endToEndId = (string) $endToEndId;
56	2	$this->amount = $amount;
57	2	$this->creditorName = (string) $creditorName;
58	2	$this->creditorAddress = $creditorAddress;
59	2	$this->remittanceInformation = null;
60	2	}
61
62		/**
63		* Sets the unstructured remittance information
64		*
65		* @param string\|null $remittanceInformation
66		*
67		* @return CreditTransfer This credit transfer
68		*/
69		public function setRemittanceInformation($remittanceInformation)
70		{
71		$this->remittanceInformation = $remittanceInformation;
72
73		return $this;
74		}
75
76		/**
77		* Gets the instructed amount of this transaction
78		*
79		* @return Money The instructed amount
80		*/
81	2	public function getAmount()
82		{
83	2	return $this->amount;
84		}
85
86		/**
87		* Builds a DOM tree of this transaction
88		*
89		* @param \DOMDocument $doc
90		*
91		* @return \DOMElement The built DOM tree
92		*/
93		abstract public function asDom(\DOMDocument $doc);
94
95		/**
96		* Builds a DOM tree of this transaction and adds header nodes
97		*
98		* @param \DOMDocument $doc
99		* @param string\|null $localInstrument Local Instrument
100		* @param string\|null $serviceLevel
101		*
102		* @return \DOMNode The built DOM node
103		*/
104	2	protected function buildHeader(\DOMDocument $doc, $localInstrument = null, $serviceLevel = null)
105		{
106	2	$root = $doc->createElement('CdtTrfTxInf');
107
108	2	$id = $doc->createElement('PmtId');
109	2	$id->appendChild($doc->createElement('InstrId', $this->instructionId));
110	2	$id->appendChild($doc->createElement('EndToEndId', $this->endToEndId));
111	2	$root->appendChild($id);
112
113	2	if (!empty($localInstrument) \|\| !empty($serviceLevel)) {
114	2	$paymentType = $doc->createElement('PmtTpInf');
115	2	if (!empty($localInstrument)) {
116	2	$localInstrumentNode = $doc->createElement('LclInstrm');
117	2	$localInstrumentNode->appendChild($doc->createElement('Prtry', $localInstrument));
118	2	$paymentType->appendChild($localInstrumentNode);
119	2	}
120	2	if (!empty($serviceLevel)) {
121	2	$serviceLevelNode = $doc->createElement('SvcLvl');
122	2	$serviceLevelNode->appendChild($doc->createElement('Cd', $serviceLevel));
123	2	$paymentType->appendChild($serviceLevelNode);
124	2	}
125	2	$root->appendChild($paymentType);
126	2	}
127
128	2	$amount = $doc->createElement('Amt');
129	2	$instdAmount = $doc->createElement('InstdAmt', $this->amount->format());
130	2	$instdAmount->setAttribute('Ccy', $this->amount->getCurrency());
131	2	$amount->appendChild($instdAmount);
132	2	$root->appendChild($amount);
133
134	2	return $root;
135		}
136
137		/**
138		* Builds a DOM node of the Creditor field
139		*
140		* @param \DOMDocument $doc
141		*
142		* @return \DOMNode The built DOM node
143		*/
144	2	protected function buildCreditor(\DOMDocument $doc)
145		{
146	2	$creditor = $doc->createElement('Cdtr');
147	2	$creditor->appendChild($doc->createElement('Nm', $this->creditorName));
148	2	$creditor->appendChild($this->creditorAddress->asDom($doc));
149
150	2	return $creditor;
151		}
152
153		/**
154		* Indicates whether remittance information is set
155		*
156		* @return bool true if remittance information is set
157		*/
158	2	protected function hasRemittanceInformation()
159		{
160	2	return !empty($this->remittanceInformation);
161		}
162
163		/**
164		* Builds a DOM node of the Remittance Information field
165		*
166		* @param \DOMDocument $doc
167		*
168		* @return \DOMNode The built DOM node
169		*
170		* @throws \LogicException When no remittance information is set
171		*/
172		protected function buildRemittanceInformation(\DOMDocument $doc)
173		{
174		if ($this->hasRemittanceInformation()) {
175		$remittance = $doc->createElement('RmtInf');
176		$remittance->appendChild($doc->createElement('Ustrd', $this->remittanceInformation));
177
178		return $remittance;
179		} else {
180		throw new \LogicException('Can not build node without data.');
181		}
182		}
183		}
184

z38 / swiss-payment

Push — master ( 2b893f...67432b )

CreditTransfer::getAmount() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like