Record::addBalances() - Code Metrics - Inspection of "Add opening balance code PRCD (#66)" - genkgo/camt - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6c2cde...d72bee )

by Frederik

created 2017-12-07 13:32 UTC

Record::addBalances() C

↳ Parent: Record

Complexity

Conditions	7
Paths	9

Size

Total Lines	35
Code Lines	22

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	23
CRAP Score	7

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	35
ccs	23
cts	23
cp	1
rs	6.7272
cc	7
eloc	22
nc	9
nop	2
crap	7

<?php

namespace Genkgo\Camt\Decoder;

use Genkgo\Camt\DTO;
use Genkgo\Camt\Util\StringToUnits;
use Money\Money;
use Money\Currency;
use \SimpleXMLElement;

class Record
{
    /**
     * @var Entry
     */
    private $entryDecoder;
    /**
     * @var DateDecoderInterface
     */
    private $dateDecoder;

    /**
     * Record constructor.
     * @param Entry $entryDecoder
     * @param DateDecoderInterface $dateDecoder
     */
    public function __construct(Entry $entryDecoder, DateDecoderInterface $dateDecoder)
    {
        $this->entryDecoder = $entryDecoder;
        $this->dateDecoder = $dateDecoder;
    }

    /**
     * @param DTO\Record       $record
     * @param SimpleXMLElement $xmlRecord
     */
    public function addBalances(DTO\Record $record, SimpleXMLElement $xmlRecord)
    {
        $xmlBalances = $xmlRecord->Bal;

        foreach ($xmlBalances as $xmlBalance) {
            $amount = StringToUnits::convert((string) $xmlBalance->Amt);
            $currency = (string)$xmlBalance->Amt['Ccy'];
            $date = (string)$xmlBalance->Dt->Dt;

            if ((string) $xmlBalance->CdtDbtInd === 'DBIT') {
                $amount = $amount * -1;
            }

            if (isset($xmlBalance->Tp) && isset($xmlBalance->Tp->CdOrPrtry)) {
                $code = (string) $xmlBalance->Tp->CdOrPrtry->Cd;

                if (in_array($code, ['OPBD', 'PRCD'])) {
                    $record->addBalance(DTO\Balance::opening(
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                        new Money(
                            $amount,
                            new Currency($currency)
                        ),
                        $this->dateDecoder->decode($date)
                    ));
                } elseif ($code === 'CLBD') {
                    $record->addBalance(DTO\Balance::closing(
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                        new Money(
                            $amount,
                            new Currency($currency)
                        ),
                        $this->dateDecoder->decode($date)
                    ));
                }
            }
        }
    }

    /**
     * @param DTO\Record       $record
     * @param SimpleXMLElement $xmlRecord
     */
    public function addEntries(DTO\Record $record, SimpleXMLElement $xmlRecord)
    {
        $index = 0;
        $xmlEntries = $xmlRecord->Ntry;

        foreach ($xmlEntries as $xmlEntry) {
            $amount      = StringToUnits::convert((string) $xmlEntry->Amt);
            $currency    = (string)$xmlEntry->Amt['Ccy'];
            $bookingDate = ((string) $xmlEntry->BookgDt->Dt) ?: (string) $xmlEntry->BookgDt->DtTm;
            $valueDate   = ((string) $xmlEntry->ValDt->Dt) ?: (string) $xmlEntry->ValDt->DtTm;
            $additionalInfo = ((string) $xmlEntry->AddtlNtryInf) ?: (string) $xmlEntry->AddtlNtryInf;

            if ((string) $xmlEntry->CdtDbtInd === 'DBIT') {
                $amount = $amount * -1;
            }

            $entry = new DTO\Entry(
                $record,
                $index,
                new Money($amount, new Currency($currency)),
                $this->dateDecoder->decode($bookingDate),
                $this->dateDecoder->decode($valueDate),
                $additionalInfo
            );

            if (isset($xmlEntry->RvslInd) && (string) $xmlEntry->RvslInd === 'true') {
                $entry->setReversalIndicator(true);
            }

            if (isset($xmlEntry->NtryRef) && (string) $xmlEntry->NtryRef) {
                $entry->setReference((string) $xmlEntry->NtryRef);
            }

            if (isset($xmlEntry->AcctSvcrRef) && (string) $xmlEntry->AcctSvcrRef) {
                $entry->setAccountServicerReference((string) $xmlEntry->AcctSvcrRef);
            }

            if (isset($xmlEntry->NtryDtls->Btch->PmtInfId) && (string) $xmlEntry->NtryDtls->Btch->PmtInfId) {
                $entry->setBatchPaymentId((string) $xmlEntry->NtryDtls->Btch->PmtInfId);
            }

            if (isset($xmlEntry->NtryDtls->TxDtls->Refs->PmtInfId) && (string) $xmlEntry->NtryDtls->TxDtls->Refs->PmtInfId) {
                $entry->setBatchPaymentId((string) $xmlEntry->NtryDtls->TxDtls->Refs->PmtInfId);
            }

            if (isset($xmlEntry->BkTxCd)) {
                $bankTransactionCode = new DTO\BankTransactionCode();

                if (isset($xmlEntry->BkTxCd->Prtry)) {
                    $proprietaryBankTransactionCode = new DTO\ProprietaryBankTransactionCode(
                        (string)$xmlEntry->BkTxCd->Prtry->Cd,
                        (string)$xmlEntry->BkTxCd->Prtry->Issr
                    );

                    $bankTransactionCode->setProprietary($proprietaryBankTransactionCode);
                }

                if (isset($xmlEntry->BkTxCd->Domn)) {
                    $domainBankTransactionCode = new DTO\DomainBankTransactionCode(
                        (string)$xmlEntry->BkTxCd->Domn->Cd
                    );

                    if (isset($xmlEntry->BkTxCd->Domn->Fmly)) {
                        $domainFamilyBankTransactionCode = new DTO\DomainFamilyBankTransactionCode(
                            (string)$xmlEntry->BkTxCd->Domn->Fmly->Cd,
                            (string)$xmlEntry->BkTxCd->Domn->Fmly->SubFmlyCd
                        );

                        $domainBankTransactionCode->setFamily($domainFamilyBankTransactionCode);
                    }

                    $bankTransactionCode->setDomain($domainBankTransactionCode);
                }

                $entry->setBankTransactionCode($bankTransactionCode);
            }

            if (isset($xmlEntry->Chrgs)) {
                $charges = new DTO\Charges();

                if (isset($xmlEntry->Chrgs->TtlChrgsAndTaxAmt) && (string) $xmlEntry->Chrgs->TtlChrgsAndTaxAmt) {
                    $amount      = StringToUnits::convert((string) $xmlEntry->Chrgs->TtlChrgsAndTaxAmt);
                    $currency    = (string)$xmlEntry->Chrgs->TtlChrgsAndTaxAmt['Ccy'];

                    $charges->setTotalChargesAndTaxAmount(new Money($amount, new Currency($currency)));
                }

                $chargesRecords = $xmlEntry->Chrgs->Rcrd;
                if ($chargesRecords) {
                    foreach ($chargesRecords as $chargesRecord) {
                        $chargesDetail = new DTO\ChargesRecord();

                        if (isset($chargesRecord->Amt) && (string) $chargesRecord->Amt) {
                            $amount      = StringToUnits::convert((string) $chargesRecord->Amt);
                            $currency    = (string)$chargesRecord->Amt['Ccy'];

                            if ((string) $chargesRecord->CdtDbtInd === 'DBIT') {
                                $amount = $amount * -1;
                            }

                            $chargesDetail->setAmount(new Money($amount, new Currency($currency)));
                        }
                        if (isset($chargesRecord->CdtDbtInd) && (string) $chargesRecord->CdtDbtInd === 'true') {
                            $chargesDetail->setChargesIncluded­Indicator(true);
                        }
                        if (isset($chargesRecord->Tp->Prtry->Id) && (string) $chargesRecord->Tp->Prtry->Id) {
                            $chargesDetail->setIdentification((string) $chargesRecord->Tp->Prtry->Id);
                        }
                        $charges->addRecord($chargesDetail);
                    }
                }
                $entry->setCharges($charges);
            }

            $this->entryDecoder->addTransactionDetails($entry, $xmlEntry);

            $record->addEntry($entry);
            $index++;
        }
    }
}


Push — master ( 6c2cde...d72bee )

Record::addBalances() C

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

1		<?php
2
3		namespace Genkgo\Camt\Decoder;
4
5		use Genkgo\Camt\DTO;
6		use Genkgo\Camt\Util\StringToUnits;
7		use Money\Money;
8		use Money\Currency;
9		use \SimpleXMLElement;
10
11		class Record
12		{
13		/**
14		* @var Entry
15		*/
16		private $entryDecoder;
17		/**
18		* @var DateDecoderInterface
19		*/
20		private $dateDecoder;
21
22		/**
23		* Record constructor.
24		* @param Entry $entryDecoder
25		* @param DateDecoderInterface $dateDecoder
26		*/
27	31	public function __construct(Entry $entryDecoder, DateDecoderInterface $dateDecoder)
28		{
29	31	$this->entryDecoder = $entryDecoder;
30	31	$this->dateDecoder = $dateDecoder;
31	31	}
32
33		/**
34		* @param DTO\Record $record
35		* @param SimpleXMLElement $xmlRecord
36		*/
37	19	public function addBalances(DTO\Record $record, SimpleXMLElement $xmlRecord)
38		{
39	19	$xmlBalances = $xmlRecord->Bal;
		0 ignored issues – show Bug introduced 2016-06-14 09:16 UTC by Report Bug Copy Issue Report The property `Bal` does not seem to exist in `SimpleXMLElement`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
40	19	foreach ($xmlBalances as $xmlBalance) {
41	14	$amount = StringToUnits::convert((string) $xmlBalance->Amt);
42	14	$currency = (string)$xmlBalance->Amt['Ccy'];
43	14	$date = (string)$xmlBalance->Dt->Dt;
44
45	14	if ((string) $xmlBalance->CdtDbtInd === 'DBIT') {
46	9	$amount = $amount * -1;
47		}
48
49	14	if (isset($xmlBalance->Tp) && isset($xmlBalance->Tp->CdOrPrtry)) {
50	14	$code = (string) $xmlBalance->Tp->CdOrPrtry->Cd;
51
52	14	if (in_array($code, ['OPBD', 'PRCD'])) {
53	11	$record->addBalance(DTO\Balance::opening(
		0 ignored issues – show Bug introduced 2017-10-20 11:01 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Genkgo\Camt\DTO\Record` as the method `addBalance()` does only exist in the following sub-classes of `Genkgo\Camt\DTO\Record`: `Genkgo\Camt\Camt052\DTO\Report`, `Genkgo\Camt\Camt053\DTO\Statement`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
54	11	new Money(
55	11	$amount,
56	11	new Currency($currency)
57		),
58	11	$this->dateDecoder->decode($date)
59		));
60	13	} elseif ($code === 'CLBD') {
61	10	$record->addBalance(DTO\Balance::closing(
		0 ignored issues – show Bug introduced 2017-10-20 11:01 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Genkgo\Camt\DTO\Record` as the method `addBalance()` does only exist in the following sub-classes of `Genkgo\Camt\DTO\Record`: `Genkgo\Camt\Camt052\DTO\Report`, `Genkgo\Camt\Camt053\DTO\Statement`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
62	10	new Money(
63	10	$amount,
64	10	new Currency($currency)
65		),
66	14	$this->dateDecoder->decode($date)
67		));
68		}
69		}
70		}
71	19	}
72
73		/**
74		* @param DTO\Record $record
75		* @param SimpleXMLElement $xmlRecord
76		*/
77	22	public function addEntries(DTO\Record $record, SimpleXMLElement $xmlRecord)
78		{
79	22	$index = 0;
80	22	$xmlEntries = $xmlRecord->Ntry;
		0 ignored issues – show Bug introduced 2016-06-14 09:16 UTC by Report Bug Copy Issue Report The property `Ntry` does not seem to exist in `SimpleXMLElement`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
81	22	foreach ($xmlEntries as $xmlEntry) {
82	21	$amount = StringToUnits::convert((string) $xmlEntry->Amt);
83	21	$currency = (string)$xmlEntry->Amt['Ccy'];
84	21	$bookingDate = ((string) $xmlEntry->BookgDt->Dt) ?: (string) $xmlEntry->BookgDt->DtTm;
85	21	$valueDate = ((string) $xmlEntry->ValDt->Dt) ?: (string) $xmlEntry->ValDt->DtTm;
86	21	$additionalInfo = ((string) $xmlEntry->AddtlNtryInf) ?: (string) $xmlEntry->AddtlNtryInf;
87
88	21	if ((string) $xmlEntry->CdtDbtInd === 'DBIT') {
89	12	$amount = $amount * -1;
90		}
91
92	21	$entry = new DTO\Entry(
93	21	$record,
94	21	$index,
95	21	new Money($amount, new Currency($currency)),
96	21	$this->dateDecoder->decode($bookingDate),
97	21	$this->dateDecoder->decode($valueDate),
98	21	$additionalInfo
99		);
100
101	21	if (isset($xmlEntry->RvslInd) && (string) $xmlEntry->RvslInd === 'true') {
102	1	$entry->setReversalIndicator(true);
103		}
104
105	21	if (isset($xmlEntry->NtryRef) && (string) $xmlEntry->NtryRef) {
106	1	$entry->setReference((string) $xmlEntry->NtryRef);
107		}
108
109	21	if (isset($xmlEntry->AcctSvcrRef) && (string) $xmlEntry->AcctSvcrRef) {
110	18	$entry->setAccountServicerReference((string) $xmlEntry->AcctSvcrRef);
111		}
112
113	21	if (isset($xmlEntry->NtryDtls->Btch->PmtInfId) && (string) $xmlEntry->NtryDtls->Btch->PmtInfId) {
114	11	$entry->setBatchPaymentId((string) $xmlEntry->NtryDtls->Btch->PmtInfId);
115		}
116
117	21	if (isset($xmlEntry->NtryDtls->TxDtls->Refs->PmtInfId) && (string) $xmlEntry->NtryDtls->TxDtls->Refs->PmtInfId) {
118	3	$entry->setBatchPaymentId((string) $xmlEntry->NtryDtls->TxDtls->Refs->PmtInfId);
119		}
120
121	21	if (isset($xmlEntry->BkTxCd)) {
122	20	$bankTransactionCode = new DTO\BankTransactionCode();
123
124	20	if (isset($xmlEntry->BkTxCd->Prtry)) {
125	19	$proprietaryBankTransactionCode = new DTO\ProprietaryBankTransactionCode(
126	19	(string)$xmlEntry->BkTxCd->Prtry->Cd,
127	19	(string)$xmlEntry->BkTxCd->Prtry->Issr
128		);
129
130	19	$bankTransactionCode->setProprietary($proprietaryBankTransactionCode);
131		}
132
133	20	if (isset($xmlEntry->BkTxCd->Domn)) {
134	17	$domainBankTransactionCode = new DTO\DomainBankTransactionCode(
135	17	(string)$xmlEntry->BkTxCd->Domn->Cd
136		);
137
138	17	if (isset($xmlEntry->BkTxCd->Domn->Fmly)) {
139	17	$domainFamilyBankTransactionCode = new DTO\DomainFamilyBankTransactionCode(
140	17	(string)$xmlEntry->BkTxCd->Domn->Fmly->Cd,
141	17	(string)$xmlEntry->BkTxCd->Domn->Fmly->SubFmlyCd
142		);
143
144	17	$domainBankTransactionCode->setFamily($domainFamilyBankTransactionCode);
145		}
146
147	17	$bankTransactionCode->setDomain($domainBankTransactionCode);
148		}
149
150	20	$entry->setBankTransactionCode($bankTransactionCode);
151		}
152
153	21	if (isset($xmlEntry->Chrgs)) {
154		$charges = new DTO\Charges();
155
156		if (isset($xmlEntry->Chrgs->TtlChrgsAndTaxAmt) && (string) $xmlEntry->Chrgs->TtlChrgsAndTaxAmt) {
157		$amount = StringToUnits::convert((string) $xmlEntry->Chrgs->TtlChrgsAndTaxAmt);
158		$currency = (string)$xmlEntry->Chrgs->TtlChrgsAndTaxAmt['Ccy'];
159
160		$charges->setTotalChargesAndTaxAmount(new Money($amount, new Currency($currency)));
161		}
162
163		$chargesRecords = $xmlEntry->Chrgs->Rcrd;
164		if ($chargesRecords) {
165		foreach ($chargesRecords as $chargesRecord) {
166		$chargesDetail = new DTO\ChargesRecord();
167
168		if (isset($chargesRecord->Amt) && (string) $chargesRecord->Amt) {
169		$amount = StringToUnits::convert((string) $chargesRecord->Amt);
170		$currency = (string)$chargesRecord->Amt['Ccy'];
171
172		if ((string) $chargesRecord->CdtDbtInd === 'DBIT') {
173		$amount = $amount * -1;
174		}
175
176		$chargesDetail->setAmount(new Money($amount, new Currency($currency)));
177		}
178		if (isset($chargesRecord->CdtDbtInd) && (string) $chargesRecord->CdtDbtInd === 'true') {
179		$chargesDetail->setChargesIncludedIndicator(true);
180		}
181		if (isset($chargesRecord->Tp->Prtry->Id) && (string) $chargesRecord->Tp->Prtry->Id) {
182		$chargesDetail->setIdentification((string) $chargesRecord->Tp->Prtry->Id);
183		}
184		$charges->addRecord($chargesDetail);
185		}
186		}
187		$entry->setCharges($charges);
188		}
189
190	21	$this->entryDecoder->addTransactionDetails($entry, $xmlEntry);
191
192	21	$record->addEntry($entry);
193	21	$index++;
194		}
195	22	}
196		}
197

genkgo / camt

Push — master ( 6c2cde...d72bee )

Record::addBalances() C

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like