Completed
Push — master ( 5b15b1...03eab3 )
by Yann
9s
created

EntryTransactionDetail   B

Complexity

Total Complexity 41

Size/Duplication

Total Lines 183
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 14

Test Coverage

Coverage 100%

Importance

Changes 6
Bugs 0 Features 4
Metric Value
wmc 41
c 6
b 0
f 4
lcom 0
cbo 14
dl 0
loc 183
ccs 88
cts 88
cp 1
rs 8.2769

8 Methods

Rating   Name   Duplication   Size   Complexity  
D addReferences() 0 32 18
getRelatedPartyAccount() 0 1 ?
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

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 21
    public function addReferences(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
17
    {
18 21
        if (false === isset($xmlDetail->Refs)) {
19 7
            return;
20
        }
21
22 17
        $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 17
        foreach ($refs->Prtry as $xmlProprietary) {
40 8
            $type = isset($xmlProprietary->Tp) ? (string) $xmlProprietary->Tp : null;
41 8
            $subReference = isset($xmlProprietary->Ref) ? (string) $xmlProprietary->Ref : null;
42
43 8
            $reference->addProprietary(new DTO\ProprietaryReference($type, $subReference));
44
        }
45
46 17
        $detail->addReference($reference);
47 17
    }
48
49
    /**
50
     * @param DTO\EntryTransactionDetail $detail
51
     * @param SimpleXMLElement           $xmlDetail
52
     */
53 21
    public function addRelatedParties(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
54
    {
55 21
        if (false === isset($xmlDetail->RltdPties)) {
56 1
            return;
57
        }
58
59 20
        foreach ($xmlDetail->RltdPties as $xmlRelatedParty) {
60
61 20
            if (isset($xmlRelatedParty->Cdtr)) {
62 20
                $xmlRelatedPartyType = $xmlRelatedParty->Cdtr;
63 20
                $xmlRelatedPartyTypeAccount = $xmlRelatedParty->CdtrAcct;
64 20
                $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 20
                $this->addRelatedParty($detail, $xmlRelatedPartyType, $relatedPartyType, $xmlRelatedPartyTypeAccount);
67
            }
68
69 20
            if (isset($xmlRelatedParty->Dbtr)) {
70 17
                $xmlRelatedPartyType = $xmlRelatedParty->Dbtr;
71 17
                $xmlRelatedPartyTypeAccount = $xmlRelatedParty->DbtrAcct;
72 17
                $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 20
                $this->addRelatedParty($detail, $xmlRelatedPartyType, $relatedPartyType, $xmlRelatedPartyTypeAccount);
75
            }
76
        }
77 20
    }
78
79
    /**
80
     * @param DTO\EntryTransactionDetail $detail
81
     * @param $xmlRelatedPartyType
82
     * @param $relatedPartyType
83
     * @param $xmlRelatedPartyTypeAccount
84
     * @return DTO\RelatedParty
85
     */
86 20
    protected function addRelatedParty(DTO\EntryTransactionDetail $detail, $xmlRelatedPartyType, $relatedPartyType, $xmlRelatedPartyTypeAccount)
87
    {
88 20
        if (isset($xmlRelatedPartyType->PstlAdr)) {
89 20
            $relatedPartyType->setAddress(DTOFactory\Address::createFromXml($xmlRelatedPartyType->PstlAdr));
90
        }
91
92 20
        $relatedParty = new DTO\RelatedParty($relatedPartyType, $this->getRelatedPartyAccount($xmlRelatedPartyTypeAccount));
93
94 20
        $detail->addRelatedParty($relatedParty);
95
96 20
        return $relatedParty;
97
    }
98
99
    /**
100
     * @param DTO\EntryTransactionDetail $detail
101
     * @param SimpleXMLElement           $xmlDetail
102
     */
103 19
    public function addRelatedAgents(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
104
    {
105 19
        if (false === isset($xmlDetail->RltdAgts)) {
106 12
            return;
107
        }
108
109 15
        foreach ($xmlDetail->RltdAgts as $xmlRelatedAgent) {
110 15
            if(isset($xmlRelatedAgent->CdtrAgt)) {
111 15
                $agent = new DTO\CreditorAgent((string)$xmlRelatedAgent->CdtrAgt->FinInstnId->Nm, (string)$xmlRelatedAgent->CdtrAgt->FinInstnId->BIC);
112 15
                $relatedAgent =  new DTO\RelatedAgent($agent);
113 15
                $detail->addRelatedAgent($relatedAgent);
114
            }
115
116 15
            if(isset($xmlRelatedAgent->DbtrAgt)) {
117 15
                $agent = new DTO\DebtorAgent((string)$xmlRelatedAgent->DbtrAgt->FinInstnId->Nm, (string)$xmlRelatedAgent->DbtrAgt->FinInstnId->BIC);
118 15
                $relatedAgent =  new DTO\RelatedAgent($agent);
119 15
                $detail->addRelatedAgent($relatedAgent);
120
            }
121
        }
122 15
    }
123
124
    /**
125
     * @param DTO\EntryTransactionDetail $detail
126
     * @param SimpleXMLElement           $xmlDetail
127
     */
128 22
    public function addRemittanceInformation(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
129
    {
130 22
        if (false === isset($xmlDetail->RmtInf)) {
131 10
            return;
132
        }
133
134 18
        if (isset($xmlDetail->RmtInf->Ustrd)) {
135 9
            $remittanceInformation = DTO\RemittanceInformation::fromUnstructured(
136 9
                (string)$xmlDetail->RmtInf->Ustrd
137
            );
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
        ) {
147 9
            $creditorReferenceInformation = DTO\CreditorReferenceInformation::fromUnstructured(
148 9
                (string)$xmlDetail->RmtInf->Strd->CdtrRefInf->Ref
149
            );
150 9
            $remittanceInformation = new DTO\RemittanceInformation();
151 9
            $remittanceInformation->setCreditorReferenceInformation($creditorReferenceInformation);
152 9
            $detail->setRemittanceInformation($remittanceInformation);
153
        }
154 9
    }
155
156
    /**
157
     * @param DTO\EntryTransactionDetail $detail
158
     * @param SimpleXMLElement           $xmlDetail
159
     */
160 21
    public function addReturnInformation(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
161
    {
162 21
        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
            );
167 1
            $detail->setReturnInformation($remittanceInformation);
168
        }
169 21
    }
170
171
    /**
172
     * @param DTO\EntryTransactionDetail $detail
173
     * @param SimpleXMLElement           $xmlDetail
174
     */
175 21
    public function addAdditionalTransactionInformation(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
176
    {
177 21
        if (isset($xmlDetail->AddtlTxInf)) {
178 1
            $additionalInformation = new DTO\AdditionalTransactionInformation(
179 1
                (string) $xmlDetail->AddtlTxInf
180
            );
181 1
            $detail->setAdditionalTransactionInformation($additionalInformation);
182
        }
183 21
    }
184
185
    /**
186
     * @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...
187
     *
188
     * @return DTO\Account|null
189
     */
190
    abstract public function getRelatedPartyAccount(SimpleXMLElement $xmlRelatedPartyTypeAccount);
191
192
}
193