Record::addEntries() - Code Metrics - Inspection of "Adding several Camt054.v4 Options (#44)" - genkgo/camt - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a5ff2b...bf9940 )

by Yann

created 2017-05-31 11:47 UTC

Record::addEntries() F

↳ Parent: Record

Complexity

Conditions	30
Paths	7681

Size

Total Lines	103
Code Lines	61

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	51
CRAP Score	72.8712

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	103
ccs	51
cts	80
cp	0.6375
rs	2
c	1
b	0
f	0
cc	30
eloc	61
nc	7681
nop	2
crap	72.8712

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;
use \DateTimeImmutable;

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

    public function __construct(Entry $entryDecoder)
    {
        $this->entryDecoder = $entryDecoder;
    }

    /**
     * @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)
                    ),
                    new DateTimeImmutable($date)
                );
            } else {
                $balance = DTO\Balance::closing(
                    new Money(
                        $amount,
                        new Currency($currency)
                    ),
                    new DateTimeImmutable($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)),
                new DateTimeImmutable($bookingDate),
                new DateTimeImmutable($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);
                }

                $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		use \DateTimeImmutable;
11
12		class Record
13		{
14		/**
15		* @var Entry
16		*/
17		private $entryDecoder;
18
19	31	public function __construct(Entry $entryDecoder)
20		{
21	31	$this->entryDecoder = $entryDecoder;
22	31	}
23
24		/**
25		* @param DTO\Record $record
26		* @param SimpleXMLElement $xmlRecord
27		*/
28	19	public function addBalances(DTO\Record $record, SimpleXMLElement $xmlRecord)
29		{
30	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...
31	19	foreach ($xmlBalances as $xmlBalance) {
32	14	$amount = StringToUnits::convert((string) $xmlBalance->Amt);
33	14	$currency = (string)$xmlBalance->Amt['Ccy'];
34	14	$date = (string)$xmlBalance->Dt->Dt;
35
36	14	if ((string) $xmlBalance->CdtDbtInd === 'DBIT') {
37	9	$amount = $amount * -1;
38	9	}
39
40	14	if (isset($xmlBalance->Tp)
41	14	&& isset($xmlBalance->Tp->CdOrPrtry)
42	14	&& (string) $xmlBalance->Tp->CdOrPrtry->Cd === 'OPBD'
43	14	) {
44	11	$balance = DTO\Balance::opening(
45	11	new Money(
46	11	$amount,
47	11	new Currency($currency)
48	11	),
49	11	new DateTimeImmutable($date)
50	11	);
51	11	} else {
52	13	$balance = DTO\Balance::closing(
53	13	new Money(
54	13	$amount,
55	13	new Currency($currency)
56	13	),
57	13	new DateTimeImmutable($date)
58	13	);
59		}
60
61	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...
62	19	}
63	19	}
64
65		/**
66		* @param DTO\Record $record
67		* @param SimpleXMLElement $xmlRecord
68		*/
69	22	public function addEntries(DTO\Record $record, SimpleXMLElement $xmlRecord)
70		{
71	22	$index = 0;
72	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...
73	22	foreach ($xmlEntries as $xmlEntry) {
74	21	$amount = StringToUnits::convert((string) $xmlEntry->Amt);
75	21	$currency = (string)$xmlEntry->Amt['Ccy'];
76	21	$bookingDate = ((string) $xmlEntry->BookgDt->Dt) ?: (string) $xmlEntry->BookgDt->DtTm;
77	21	$valueDate = ((string) $xmlEntry->ValDt->Dt) ?: (string) $xmlEntry->ValDt->DtTm;
78	21	$additionalInfo = ((string) $xmlEntry->AddtlNtryInf) ?: (string) $xmlEntry->AddtlNtryInf;
79
80	21	if ((string) $xmlEntry->CdtDbtInd === 'DBIT') {
81	12	$amount = $amount * -1;
82	12	}
83
84	21	$entry = new DTO\Entry(
85	21	$record,
86	21	$index,
87	21	new Money($amount, new Currency($currency)),
88	21	new DateTimeImmutable($bookingDate),
89	21	new DateTimeImmutable($valueDate),
90		$additionalInfo
91	21	);
92
93	21	if (isset($xmlEntry->RvslInd) && (string) $xmlEntry->RvslInd === 'true') {
94	1	$entry->setReversalIndicator(true);
95	1	}
96
97	21	if (isset($xmlEntry->NtryRef) && (string) $xmlEntry->NtryRef) {
98	1	$entry->setReference((string) $xmlEntry->NtryRef);
99	1	}
100
101	21	if (isset($xmlEntry->AcctSvcrRef) && (string) $xmlEntry->AcctSvcrRef) {
102	18	$entry->setAccountServicerReference((string) $xmlEntry->AcctSvcrRef);
103	18	}
104
105	21	if (isset($xmlEntry->NtryDtls->Btch->PmtInfId) && (string) $xmlEntry->NtryDtls->Btch->PmtInfId) {
106	11	$entry->setBatchPaymentId((string) $xmlEntry->NtryDtls->Btch->PmtInfId);
107	11	}
108
109	21	if (isset($xmlEntry->NtryDtls->TxDtls->Refs->PmtInfId) && (string) $xmlEntry->NtryDtls->TxDtls->Refs->PmtInfId) {
110	3	$entry->setBatchPaymentId((string) $xmlEntry->NtryDtls->TxDtls->Refs->PmtInfId);
111	3	}
112
113	21	if (isset($xmlEntry->BkTxCd)) {
114	20	$bankTransactionCode = new DTO\BankTransactionCode();
115
116	20	if (isset($xmlEntry->BkTxCd->Prtry)) {
117	19	$proprietaryBankTransactionCode = new DTO\ProprietaryBankTransactionCode(
118	19	(string)$xmlEntry->BkTxCd->Prtry->Cd,
119	19	(string)$xmlEntry->BkTxCd->Prtry->Issr
120	19	);
121
122	19	$bankTransactionCode->setProprietary($proprietaryBankTransactionCode);
123	19	}
124
125	20	$entry->setBankTransactionCode($bankTransactionCode);
126	20	}
127
128	21	if (isset($xmlEntry->Chrgs)) {
129		$charges = new DTO\Charges();
130
131		if (isset($xmlEntry->Chrgs->TtlChrgsAndTaxAmt) && (string) $xmlEntry->Chrgs->TtlChrgsAndTaxAmt) {
132		$amount = StringToUnits::convert((string) $xmlEntry->Chrgs->TtlChrgsAndTaxAmt);
133		$currency = (string)$xmlEntry->Chrgs->TtlChrgsAndTaxAmt['Ccy'];
134
135		$charges->setTotalChargesAndTaxAmount(new Money($amount, new Currency($currency)));
136		}
137
138		$chargesRecords = $xmlEntry->Chrgs->Rcrd;
139		if ($chargesRecords) {
140		foreach ($chargesRecords as $chargesRecord) {
141
142		$chargesDetail = new DTO\ChargesRecord();
143
144		if(isset($chargesRecord->Amt) && (string) $chargesRecord->Amt) {
145		$amount = StringToUnits::convert((string) $chargesRecord->Amt);
146		$currency = (string)$chargesRecord->Amt['Ccy'];
147
148		if ((string) $chargesRecord->CdtDbtInd === 'DBIT') {
149		$amount = $amount * -1;
150		}
151
152		$chargesDetail->setAmount(new Money($amount, new Currency($currency)));
153		}
154		if (isset($chargesRecord->CdtDbtInd) && (string) $chargesRecord->CdtDbtInd === 'true') {
155		$chargesDetail->setChargesIncludedIndicator(true);
156		}
157		if (isset($chargesRecord->Tp->Prtry->Id) && (string) $chargesRecord->Tp->Prtry->Id) {
158		$chargesDetail->setIdentification((string) $chargesRecord->Tp->Prtry->Id);
159		}
160		$charges->addRecord($chargesDetail);
161		}
162		}
163		$entry->setCharges($charges);
164		}
165
166	21	$this->entryDecoder->addTransactionDetails($entry, $xmlEntry);
167
168	21	$record->addEntry($entry);
169	21	$index++;
170	22	}
171	22	}
172		}
173

genkgo / camt

Push — master ( a5ff2b...bf9940 )

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