Record::addEntries() - Code Metrics - Inspection of "Do not use current date for missing value and book..." - genkgo/camt - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#62)

unknown

created 2017-08-28 11:35 UTC

Record::addEntries() F

↳ Parent: Record

Complexity

Conditions	34
Paths	> 20000

Size

Total Lines	127
Code Lines	72

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	52
CRAP Score	61.5281

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	127
ccs	52
cts	73
cp	0.7123
rs	2
cc	34
eloc	72
nc	71681
nop	2
crap	61.5281

How to fix Long Method Complexity

<?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)
                && (string) $xmlBalance->Tp->CdOrPrtry->Cd === 'OPBD'
            ) {
                $balance = DTO\Balance::opening(
                    new Money(
                        $amount,
                        new Currency($currency)
                    ),
                    $this->dateDecoder->decode($date)
                );
            } else {
                $balance = DTO\Balance::closing(
                    new Money(
                        $amount,
                        new Currency($currency)
                    ),
                    $this->dateDecoder->decode($date)
                );
            }

            $record->addBalance($balance);
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.
    }
}
        }
    }

    /**
     * @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))
            );

            if ($bookingDate) {
              $entry->setBookingDate($this->dateDecoder->decode($bookingDate));
            }

            if ($valueDate) {
              $entry->setValueDate($this->dateDecoder->decode($valueDate));
            }

            $entry->setAdditionalInfo($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++;
        }
    }
}


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)
50	14	&& isset($xmlBalance->Tp->CdOrPrtry)
51	14	&& (string) $xmlBalance->Tp->CdOrPrtry->Cd === 'OPBD'
52		) {
53	11	$balance = DTO\Balance::opening(
54	11	new Money(
55	11	$amount,
56	11	new Currency($currency)
57		),
58	11	$this->dateDecoder->decode($date)
59		);
60		} else {
61	13	$balance = DTO\Balance::closing(
62	13	new Money(
63	13	$amount,
64	13	new Currency($currency)
65		),
66	13	$this->dateDecoder->decode($date)
67		);
68		}
69
70	14	$record->addBalance($balance);
		0 ignored issues – show Bug introduced 2016-06-17 08:31 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...
71		}
72	19	}
73
74		/**
75		* @param DTO\Record $record
76		* @param SimpleXMLElement $xmlRecord
77		*/
78	22	public function addEntries(DTO\Record $record, SimpleXMLElement $xmlRecord)
79		{
80	22	$index = 0;
81	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...
82	22	foreach ($xmlEntries as $xmlEntry) {
83	21	$amount = StringToUnits::convert((string) $xmlEntry->Amt);
84	21	$currency = (string)$xmlEntry->Amt['Ccy'];
85	21	$bookingDate = ((string) $xmlEntry->BookgDt->Dt) ?: (string) $xmlEntry->BookgDt->DtTm;
86	21	$valueDate = ((string) $xmlEntry->ValDt->Dt) ?: (string) $xmlEntry->ValDt->DtTm;
87	21	$additionalInfo = ((string) $xmlEntry->AddtlNtryInf) ?: (string) $xmlEntry->AddtlNtryInf;
88
89	21	if ((string) $xmlEntry->CdtDbtInd === 'DBIT') {
90	12	$amount = $amount * -1;
91		}
92
93	21	$entry = new DTO\Entry(
94	21	$record,
95	21	$index,
96	21	new Money($amount, new Currency($currency))
97		);
98
99	21	if ($bookingDate) {
100	20	$entry->setBookingDate($this->dateDecoder->decode($bookingDate));
101		}
102
103	21	if ($valueDate) {
104	20	$entry->setValueDate($this->dateDecoder->decode($valueDate));
105		}
106
107	21	$entry->setAdditionalInfo($additionalInfo);
108
109	21	if (isset($xmlEntry->RvslInd) && (string) $xmlEntry->RvslInd === 'true') {
110	1	$entry->setReversalIndicator(true);
111		}
112
113	21	if (isset($xmlEntry->NtryRef) && (string) $xmlEntry->NtryRef) {
114	1	$entry->setReference((string) $xmlEntry->NtryRef);
115		}
116
117	21	if (isset($xmlEntry->AcctSvcrRef) && (string) $xmlEntry->AcctSvcrRef) {
118	18	$entry->setAccountServicerReference((string) $xmlEntry->AcctSvcrRef);
119		}
120
121	21	if (isset($xmlEntry->NtryDtls->Btch->PmtInfId) && (string) $xmlEntry->NtryDtls->Btch->PmtInfId) {
122	11	$entry->setBatchPaymentId((string) $xmlEntry->NtryDtls->Btch->PmtInfId);
123		}
124
125	21	if (isset($xmlEntry->NtryDtls->TxDtls->Refs->PmtInfId) && (string) $xmlEntry->NtryDtls->TxDtls->Refs->PmtInfId) {
126	3	$entry->setBatchPaymentId((string) $xmlEntry->NtryDtls->TxDtls->Refs->PmtInfId);
127		}
128
129	21	if (isset($xmlEntry->BkTxCd)) {
130	20	$bankTransactionCode = new DTO\BankTransactionCode();
131
132	20	if (isset($xmlEntry->BkTxCd->Prtry)) {
133	19	$proprietaryBankTransactionCode = new DTO\ProprietaryBankTransactionCode(
134	19	(string)$xmlEntry->BkTxCd->Prtry->Cd,
135	19	(string)$xmlEntry->BkTxCd->Prtry->Issr
136		);
137
138	19	$bankTransactionCode->setProprietary($proprietaryBankTransactionCode);
139		}
140
141	20	if (isset($xmlEntry->BkTxCd->Domn)) {
142	17	$domainBankTransactionCode = new DTO\DomainBankTransactionCode(
143	17	(string)$xmlEntry->BkTxCd->Domn->Cd
144		);
145
146	17	if (isset($xmlEntry->BkTxCd->Domn->Fmly)) {
147	17	$domainFamilyBankTransactionCode = new DTO\DomainFamilyBankTransactionCode(
148	17	(string)$xmlEntry->BkTxCd->Domn->Fmly->Cd,
149	17	(string)$xmlEntry->BkTxCd->Domn->Fmly->SubFmlyCd
150		);
151
152	17	$domainBankTransactionCode->setFamily($domainFamilyBankTransactionCode);
153		}
154
155	17	$bankTransactionCode->setDomain($domainBankTransactionCode);
156		}
157
158	20	$entry->setBankTransactionCode($bankTransactionCode);
159		}
160
161	21	if (isset($xmlEntry->Chrgs)) {
162		$charges = new DTO\Charges();
163
164		if (isset($xmlEntry->Chrgs->TtlChrgsAndTaxAmt) && (string) $xmlEntry->Chrgs->TtlChrgsAndTaxAmt) {
165		$amount = StringToUnits::convert((string) $xmlEntry->Chrgs->TtlChrgsAndTaxAmt);
166		$currency = (string)$xmlEntry->Chrgs->TtlChrgsAndTaxAmt['Ccy'];
167
168		$charges->setTotalChargesAndTaxAmount(new Money($amount, new Currency($currency)));
169		}
170
171		$chargesRecords = $xmlEntry->Chrgs->Rcrd;
172		if ($chargesRecords) {
173		foreach ($chargesRecords as $chargesRecord) {
174
175		$chargesDetail = new DTO\ChargesRecord();
176
177		if(isset($chargesRecord->Amt) && (string) $chargesRecord->Amt) {
178		$amount = StringToUnits::convert((string) $chargesRecord->Amt);
179		$currency = (string)$chargesRecord->Amt['Ccy'];
180
181		if ((string) $chargesRecord->CdtDbtInd === 'DBIT') {
182		$amount = $amount * -1;
183		}
184
185		$chargesDetail->setAmount(new Money($amount, new Currency($currency)));
186		}
187		if (isset($chargesRecord->CdtDbtInd) && (string) $chargesRecord->CdtDbtInd === 'true') {
188		$chargesDetail->setChargesIncludedIndicator(true);
189		}
190		if (isset($chargesRecord->Tp->Prtry->Id) && (string) $chargesRecord->Tp->Prtry->Id) {
191		$chargesDetail->setIdentification((string) $chargesRecord->Tp->Prtry->Id);
192		}
193		$charges->addRecord($chargesDetail);
194		}
195		}
196		$entry->setCharges($charges);
197		}
198
199	21	$this->entryDecoder->addTransactionDetails($entry, $xmlEntry);
200
201	21	$record->addEntry($entry);
202	21	$index++;
203		}
204	22	}
205		}
206

genkgo / camt

Pull Request — master (#62)

Record::addEntries() F

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like