Completed
Pull Request — master (#31)
by
unknown
22:01
created

EntryTransactionDetail   C

Complexity

Total Complexity 44

Size/Duplication

Total Lines 205
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 16

Test Coverage

Coverage 100%

Importance

Changes 8
Bugs 1 Features 5
Metric Value
wmc 44
c 8
b 1
f 5
lcom 0
cbo 16
dl 0
loc 205
ccs 119
cts 119
cp 1
rs 6.916

9 Methods

Rating   Name   Duplication   Size   Complexity  
D addReferences() 0 32 18
B addRelatedParties() 0 24 5
A addRelatedParty() 0 12 2
B addRelatedAgents() 0 20 5
B addRemittanceInformation() 0 27 6
A addReturnInformation() 0 10 3
A addAdditionalTransactionInformation() 0 9 2
A addBankTransactionCode() 0 19 3
getRelatedPartyAccount() 0 1 ?

How to fix   Complexity   

Complex Class

Complex classes like EntryTransactionDetail often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use EntryTransactionDetail, and based on these observations, apply Extract Interface, too.

1
<?php
2
3
namespace Genkgo\Camt\Decoder;
4
5
use Genkgo\Camt\DTO;
6
use \SimpleXMLElement;
7
use Genkgo\Camt\Decoder\Factory\DTO as DTOFactory;
8
use Genkgo\Camt\Iban;
9
10
abstract class EntryTransactionDetail
11
{
12
    /**
13
     * @param DTO\EntryTransactionDetail $detail
14
     * @param SimpleXMLElement           $xmlDetail
15
     */
16 22
    public function addReferences(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
17
    {
18 22
        if (false === isset($xmlDetail->Refs)) {
19 8
            return;
20 21
        }
21
22 20
        $refs = $xmlDetail->Refs;
0 ignored issues
show
Bug introduced by
The property Refs 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...
23 17
        $reference = new DTO\Reference();
24
25 17
        $reference->setMessageId(isset($refs->MsgId) ? (string) $refs->MsgId : null);
26 17
        $reference->setAccountServiceReference(isset($refs->AcctSvcrRef) ? (string) $refs->AcctSvcrRef : null);
27 17
        $reference->setPaymentInformationId(isset($refs->PmtInfId) ? (string) $refs->PmtInfId : null);
28 17
        $reference->setInstructionId(isset($refs->InstrId) ? (string) $refs->InstrId : null);
29 17
        $reference->setEndToEndId(isset($refs->EndToEndId) ? (string) $refs->EndToEndId : null);
30 17
        $reference->setTransactionId(isset($refs->TxId) ? (string) $refs->TxId : null);
31 17
        $reference->setMandateId(isset($refs->MndtId) ? (string) $refs->MndtId : null);
32 17
        $reference->setChequeNumber(isset($refs->ChqNb) ? (string) $refs->ChqNb : null);
33 17
        $reference->setClearingSystemReference(isset($refs->ClrSysRef) ? (string) $refs->ClrSysRef : null);
34 17
        $reference->setAccountOwnerTransactionId(isset($refs->AcctOwnrTxId) ? (string) $refs->AcctOwnrTxId : null);
35 17
        $reference->setAccountServicerTransactionId(isset($refs->AcctSvcrTxId) ? (string) $refs->AcctSvcrTxId : null);
36 17
        $reference->setMarketInfrastructureTransactionId(isset($refs->MktInfrstrctrTxId) ? (string) $refs->MktInfrstrctrTxId : null);
37 17
        $reference->setProcessingId(isset($refs->PrcgId) ? (string) $refs->PrcgId : null);
38
39 18
        foreach ($refs->Prtry as $xmlProprietary) {
40 8
            $type = isset($xmlProprietary->Tp) ? (string) $xmlProprietary->Tp : null;
41 14
            $subReference = isset($xmlProprietary->Ref) ? (string) $xmlProprietary->Ref : null;
42
43 8
            $reference->addProprietary(new DTO\ProprietaryReference($type, $subReference));
44 17
        }
45
46 17
        $detail->addReference($reference);
47 17
    }
48
49
    /**
50
     * @param DTO\EntryTransactionDetail $detail
51
     * @param SimpleXMLElement           $xmlDetail
52
     */
53 22
    public function addRelatedParties(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
54
    {
55 22
        if (false === isset($xmlDetail->RltdPties)) {
56 1
            return;
57
        }
58
59 21
        foreach ($xmlDetail->RltdPties as $xmlRelatedParty) {
60 21
            if (isset($xmlRelatedParty->Cdtr)) {
61 21
                $xmlRelatedPartyType = $xmlRelatedParty->Cdtr;
62 21
                $xmlRelatedPartyTypeAccount = $xmlRelatedParty->CdtrAcct;
63 21
                $relatedPartyType = $creditor = new DTO\Creditor((string) $xmlRelatedPartyType->Nm);
0 ignored issues
show
Unused Code introduced by
$creditor is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
64
65 21
                $this->addRelatedParty($detail, $xmlRelatedPartyType, $relatedPartyType, $xmlRelatedPartyTypeAccount);
66 21
            }
67
68 21
            if (isset($xmlRelatedParty->Dbtr)) {
69 18
                $xmlRelatedPartyType = $xmlRelatedParty->Dbtr;
70 18
                $xmlRelatedPartyTypeAccount = $xmlRelatedParty->DbtrAcct;
71 18
                $relatedPartyType = $debtor = new DTO\Debtor((string) $xmlRelatedPartyType->Nm);
0 ignored issues
show
Unused Code introduced by
$debtor is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
72
73 18
                $this->addRelatedParty($detail, $xmlRelatedPartyType, $relatedPartyType, $xmlRelatedPartyTypeAccount);
74 18
            }
75 21
        }
76 21
    }
77
78
    /**
79
     * @param DTO\EntryTransactionDetail $detail
80
     * @param $xmlRelatedPartyType
81
     * @param $relatedPartyType
82
     * @param $xmlRelatedPartyTypeAccount
83
     * @return DTO\RelatedParty
84
     */
85 21
    protected function addRelatedParty(DTO\EntryTransactionDetail $detail, $xmlRelatedPartyType, $relatedPartyType, $xmlRelatedPartyTypeAccount)
86
    {
87 21
        if (isset($xmlRelatedPartyType->PstlAdr)) {
88 21
            $relatedPartyType->setAddress(DTOFactory\Address::createFromXml($xmlRelatedPartyType->PstlAdr));
89 21
        }
90
91 21
        $relatedParty = new DTO\RelatedParty($relatedPartyType, $this->getRelatedPartyAccount($xmlRelatedPartyTypeAccount));
92
93 21
        $detail->addRelatedParty($relatedParty);
94
95 21
        return $relatedParty;
96
    }
97
98
    /**
99
     * @param DTO\EntryTransactionDetail $detail
100
     * @param SimpleXMLElement           $xmlDetail
101
     */
102 20
    public function addRelatedAgents(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
103
    {
104 20
        if (false === isset($xmlDetail->RltdAgts)) {
105 12
            return;
106
        }
107
108 16
        foreach ($xmlDetail->RltdAgts as $xmlRelatedAgent) {
109 16
            if (isset($xmlRelatedAgent->CdtrAgt)) {
110 16
                $agent = new DTO\CreditorAgent((string)$xmlRelatedAgent->CdtrAgt->FinInstnId->Nm, (string)$xmlRelatedAgent->CdtrAgt->FinInstnId->BIC);
111 16
                $relatedAgent =  new DTO\RelatedAgent($agent);
112 16
                $detail->addRelatedAgent($relatedAgent);
113 16
            }
114
115 16
            if (isset($xmlRelatedAgent->DbtrAgt)) {
116 16
                $agent = new DTO\DebtorAgent((string)$xmlRelatedAgent->DbtrAgt->FinInstnId->Nm, (string)$xmlRelatedAgent->DbtrAgt->FinInstnId->BIC);
117 16
                $relatedAgent =  new DTO\RelatedAgent($agent);
118 16
                $detail->addRelatedAgent($relatedAgent);
119 16
            }
120 16
        }
121 16
    }
122
123
    /**
124
     * @param DTO\EntryTransactionDetail $detail
125
     * @param SimpleXMLElement           $xmlDetail
126
     */
127 23
    public function addRemittanceInformation(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
128
    {
129 23
        if (false === isset($xmlDetail->RmtInf)) {
130 11
            return;
131
        }
132
133 18
        if (isset($xmlDetail->RmtInf->Ustrd)) {
134 9
            $remittanceInformation = DTO\RemittanceInformation::fromUnstructured(
135 9
                (string)$xmlDetail->RmtInf->Ustrd
136 9
            );
137 9
            $detail->setRemittanceInformation($remittanceInformation);
138
139 9
            return;
140
        }
141
142 9
        if (isset($xmlDetail->RmtInf->Strd)
143 9
            && isset($xmlDetail->RmtInf->Strd->CdtrRefInf)
144 9
            && isset($xmlDetail->RmtInf->Strd->CdtrRefInf->Ref)
145 9
        ) {
146 9
            $creditorReferenceInformation = DTO\CreditorReferenceInformation::fromUnstructured(
147 9
                (string)$xmlDetail->RmtInf->Strd->CdtrRefInf->Ref
148 9
            );
149 9
            $remittanceInformation = new DTO\RemittanceInformation();
150 9
            $remittanceInformation->setCreditorReferenceInformation($creditorReferenceInformation);
151 9
            $detail->setRemittanceInformation($remittanceInformation);
152 9
        }
153 9
    }
154
155
    /**
156
     * @param DTO\EntryTransactionDetail $detail
157
     * @param SimpleXMLElement           $xmlDetail
158
     */
159 22
    public function addReturnInformation(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
160
    {
161 22
        if (isset($xmlDetail->RtrInf) && isset($xmlDetail->RtrInf->Rsn->Cd)) {
162 1
            $remittanceInformation = DTO\ReturnInformation::fromUnstructured(
163 1
                (string)$xmlDetail->RtrInf->Rsn->Cd,
164 1
                (string)$xmlDetail->RtrInf->AddtlInf
165 1
            );
166 1
            $detail->setReturnInformation($remittanceInformation);
167 1
        }
168 22
    }
169
170
    /**
171
     * @param DTO\EntryTransactionDetail $detail
172
     * @param SimpleXMLElement           $xmlDetail
173
     */
174 22
    public function addAdditionalTransactionInformation(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
175
    {
176 22
        if (isset($xmlDetail->AddtlTxInf)) {
177 1
            $additionalInformation = new DTO\AdditionalTransactionInformation(
178 1
                (string) $xmlDetail->AddtlTxInf
179 1
            );
180 1
            $detail->setAdditionalTransactionInformation($additionalInformation);
181 1
        }
182 22
    }
183
184
    /**
185
     * @param DTO\EntryTransactionDetail $detail
186
     * @param SimpleXMLElement           $xmlDetail
187
     */
188 20
    public function addBankTransactionCode(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
189
    {
190 20
        $bankTransactionCode = new DTO\BankTransactionCode();
191
192 20
        if (isset($xmlDetail->BkTxCd)) {
193 18
            $bankTransactionCode = new DTO\BankTransactionCode();
194
195 18
            if (isset($xmlDetail->BkTxCd->Prtry)) {
196 18
                $proprietaryBankTransactionCode = new DTO\ProprietaryBankTransactionCode(
197 18
                    (string)$xmlDetail->BkTxCd->Prtry->Cd,
198 18
                    (string)$xmlDetail->BkTxCd->Prtry->Issr
199 18
                );
200
201 18
                $bankTransactionCode->setProprietary($proprietaryBankTransactionCode);
202 18
            }
203 18
        }
204
205 20
        $detail->setBankTransactionCode($bankTransactionCode);
206 20
    }
207
208
    /**
209
     * @param SimpleXMLElement $xmlDetail
0 ignored issues
show
Bug introduced by
There is no parameter named $xmlDetail. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
210
     *
211
     * @return DTO\Account|null
212
     */
213
    abstract public function getRelatedPartyAccount(SimpleXMLElement $xmlRelatedPartyTypeAccount);
214
}
215