Completed
Pull Request — master (#31)
by
unknown
03:17
created

EntryTransactionDetail   C

Complexity

Total Complexity 44

Size/Duplication

Total Lines 207
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 16

Test Coverage

Coverage 100%

Importance

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

9 Methods

Rating   Name   Duplication   Size   Complexity  
D addReferences() 0 32 18
B addRelatedParties() 0 25 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
61 21
            if (isset($xmlRelatedParty->Cdtr)) {
62 21
                $xmlRelatedPartyType = $xmlRelatedParty->Cdtr;
63 21
                $xmlRelatedPartyTypeAccount = $xmlRelatedParty->CdtrAcct;
64 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...
65
66 21
                $this->addRelatedParty($detail, $xmlRelatedPartyType, $relatedPartyType, $xmlRelatedPartyTypeAccount);
67 21
            }
68
69 21
            if (isset($xmlRelatedParty->Dbtr)) {
70 18
                $xmlRelatedPartyType = $xmlRelatedParty->Dbtr;
71 18
                $xmlRelatedPartyTypeAccount = $xmlRelatedParty->DbtrAcct;
72 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...
73
74 18
                $this->addRelatedParty($detail, $xmlRelatedPartyType, $relatedPartyType, $xmlRelatedPartyTypeAccount);
75 18
            }
76 21
        }
77 21
    }
78
79
    /**
80
     * @param DTO\EntryTransactionDetail $detail
81
     * @param $xmlRelatedPartyType
82
     * @param $relatedPartyType
83
     * @param $xmlRelatedPartyTypeAccount
84
     * @return DTO\RelatedParty
85
     */
86 21
    protected function addRelatedParty(DTO\EntryTransactionDetail $detail, $xmlRelatedPartyType, $relatedPartyType, $xmlRelatedPartyTypeAccount)
87
    {
88 21
        if (isset($xmlRelatedPartyType->PstlAdr)) {
89 21
            $relatedPartyType->setAddress(DTOFactory\Address::createFromXml($xmlRelatedPartyType->PstlAdr));
90 21
        }
91
92 21
        $relatedParty = new DTO\RelatedParty($relatedPartyType, $this->getRelatedPartyAccount($xmlRelatedPartyTypeAccount));
93
94 21
        $detail->addRelatedParty($relatedParty);
95
96 21
        return $relatedParty;
97
    }
98
99
    /**
100
     * @param DTO\EntryTransactionDetail $detail
101
     * @param SimpleXMLElement           $xmlDetail
102
     */
103 20
    public function addRelatedAgents(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
104
    {
105 20
        if (false === isset($xmlDetail->RltdAgts)) {
106 12
            return;
107
        }
108
109 16
        foreach ($xmlDetail->RltdAgts as $xmlRelatedAgent) {
110 16
            if(isset($xmlRelatedAgent->CdtrAgt)) {
111 16
                $agent = new DTO\CreditorAgent((string)$xmlRelatedAgent->CdtrAgt->FinInstnId->Nm, (string)$xmlRelatedAgent->CdtrAgt->FinInstnId->BIC);
112 16
                $relatedAgent =  new DTO\RelatedAgent($agent);
113 16
                $detail->addRelatedAgent($relatedAgent);
114 16
            }
115
116 16
            if(isset($xmlRelatedAgent->DbtrAgt)) {
117 16
                $agent = new DTO\DebtorAgent((string)$xmlRelatedAgent->DbtrAgt->FinInstnId->Nm, (string)$xmlRelatedAgent->DbtrAgt->FinInstnId->BIC);
118 16
                $relatedAgent =  new DTO\RelatedAgent($agent);
119 16
                $detail->addRelatedAgent($relatedAgent);
120 16
            }
121 16
        }
122 16
    }
123
124
    /**
125
     * @param DTO\EntryTransactionDetail $detail
126
     * @param SimpleXMLElement           $xmlDetail
127
     */
128 23
    public function addRemittanceInformation(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
129
    {
130 23
        if (false === isset($xmlDetail->RmtInf)) {
131 11
            return;
132
        }
133
134 18
        if (isset($xmlDetail->RmtInf->Ustrd)) {
135 9
            $remittanceInformation = DTO\RemittanceInformation::fromUnstructured(
136 9
                (string)$xmlDetail->RmtInf->Ustrd
137 9
            );
138 9
            $detail->setRemittanceInformation($remittanceInformation);
139
140 9
            return;
141
        }
142
143 9
        if (isset($xmlDetail->RmtInf->Strd)
144 9
            && isset($xmlDetail->RmtInf->Strd->CdtrRefInf)
145 9
            && isset($xmlDetail->RmtInf->Strd->CdtrRefInf->Ref)
146 9
        ) {
147 9
            $creditorReferenceInformation = DTO\CreditorReferenceInformation::fromUnstructured(
148 9
                (string)$xmlDetail->RmtInf->Strd->CdtrRefInf->Ref
149 9
            );
150 9
            $remittanceInformation = new DTO\RemittanceInformation();
151 9
            $remittanceInformation->setCreditorReferenceInformation($creditorReferenceInformation);
152 9
            $detail->setRemittanceInformation($remittanceInformation);
153 9
        }
154 9
    }
155
156
    /**
157
     * @param DTO\EntryTransactionDetail $detail
158
     * @param SimpleXMLElement           $xmlDetail
159
     */
160 22
    public function addReturnInformation(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
161
    {
162 22
        if (isset($xmlDetail->RtrInf) && isset($xmlDetail->RtrInf->Rsn->Cd)) {
163 1
            $remittanceInformation = DTO\ReturnInformation::fromUnstructured(
164 1
                (string)$xmlDetail->RtrInf->Rsn->Cd,
165 1
                (string)$xmlDetail->RtrInf->AddtlInf
166 1
            );
167 1
            $detail->setReturnInformation($remittanceInformation);
168 1
        }
169 22
    }
170
171
    /**
172
     * @param DTO\EntryTransactionDetail $detail
173
     * @param SimpleXMLElement           $xmlDetail
174
     */
175 22
    public function addAdditionalTransactionInformation(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
176
    {
177 22
        if (isset($xmlDetail->AddtlTxInf)) {
178 1
            $additionalInformation = new DTO\AdditionalTransactionInformation(
179 1
                (string) $xmlDetail->AddtlTxInf
180 1
            );
181 1
            $detail->setAdditionalTransactionInformation($additionalInformation);
182 1
        }
183 22
    }
184
185
    /**
186
     * @param DTO\EntryTransactionDetail $detail
187
     * @param SimpleXMLElement           $xmlDetail
188
     */
189 20
    public function addBankTransactionCode(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
190
    {
191 20
        $bankTransactionCode = new DTO\BankTransactionCode();
192
193 20
        if (isset($xmlDetail->BkTxCd)) {
194 18
            $bankTransactionCode = new DTO\BankTransactionCode();
195
196 18
            if (isset($xmlDetail->BkTxCd->Prtry)) {
197 18
                $proprietaryBankTransactionCode = new DTO\ProprietaryBankTransactionCode(
198 18
                    (string)$xmlDetail->BkTxCd->Prtry->Cd,
199 18
                    (string)$xmlDetail->BkTxCd->Prtry->Issr
200 18
                );
201
202 18
                $bankTransactionCode->setProprietary($proprietaryBankTransactionCode);
203 18
            }
204 18
        }
205
206 20
        $detail->setBankTransactionCode($bankTransactionCode);
207 20
    }
208
209
    /**
210
     * @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...
211
     *
212
     * @return DTO\Account|null
213
     */
214
    abstract public function getRelatedPartyAccount(SimpleXMLElement $xmlRelatedPartyTypeAccount);
215
216
}
217