EntryTransactionDetail::addReturnInformation() - Code Metrics - Inspection of "Add ProprietaryBankTransactionCode <BkTxCd>.<Prtry..." - genkgo/camt - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#31)

unknown

created 2016-08-31 07:47 UTC

EntryTransactionDetail::addReturnInformation() A

↳ Parent: EntryTransactionDetail

Complexity

Conditions	3
Paths	2

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	3

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	10
ccs	9
cts	9
cp	1
rs	9.4285
cc	3
eloc	6
nc	2
nop	2
crap	3

<?php

namespace Genkgo\Camt\Decoder;

use Genkgo\Camt\DTO;
use \SimpleXMLElement;
use Genkgo\Camt\Decoder\Factory\DTO as DTOFactory;
use Genkgo\Camt\Iban;

abstract class EntryTransactionDetail
{
    /**
     * @param DTO\EntryTransactionDetail $detail
     * @param SimpleXMLElement           $xmlDetail
     */
    public function addReferences(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
    {
        if (false === isset($xmlDetail->Refs)) {
            return;
        }

        $refs = $xmlDetail->Refs;

        $reference = new DTO\Reference();

        $reference->setMessageId(isset($refs->MsgId) ? (string) $refs->MsgId : null);
        $reference->setAccountServiceReference(isset($refs->AcctSvcrRef) ? (string) $refs->AcctSvcrRef : null);
        $reference->setPaymentInformationId(isset($refs->PmtInfId) ? (string) $refs->PmtInfId : null);
        $reference->setInstructionId(isset($refs->InstrId) ? (string) $refs->InstrId : null);
        $reference->setEndToEndId(isset($refs->EndToEndId) ? (string) $refs->EndToEndId : null);
        $reference->setTransactionId(isset($refs->TxId) ? (string) $refs->TxId : null);
        $reference->setMandateId(isset($refs->MndtId) ? (string) $refs->MndtId : null);
        $reference->setChequeNumber(isset($refs->ChqNb) ? (string) $refs->ChqNb : null);
        $reference->setClearingSystemReference(isset($refs->ClrSysRef) ? (string) $refs->ClrSysRef : null);
        $reference->setAccountOwnerTransactionId(isset($refs->AcctOwnrTxId) ? (string) $refs->AcctOwnrTxId : null);
        $reference->setAccountServicerTransactionId(isset($refs->AcctSvcrTxId) ? (string) $refs->AcctSvcrTxId : null);
        $reference->setMarketInfrastructureTransactionId(isset($refs->MktInfrstrctrTxId) ? (string) $refs->MktInfrstrctrTxId : null);
        $reference->setProcessingId(isset($refs->PrcgId) ? (string) $refs->PrcgId : null);

        foreach ($refs->Prtry as $xmlProprietary) {
            $type = isset($xmlProprietary->Tp) ? (string) $xmlProprietary->Tp : null;
            $subReference = isset($xmlProprietary->Ref) ? (string) $xmlProprietary->Ref : null;

            $reference->addProprietary(new DTO\ProprietaryReference($type, $subReference));
        }

        $detail->addReference($reference);
    }

    /**
     * @param DTO\EntryTransactionDetail $detail
     * @param SimpleXMLElement           $xmlDetail
     */
    public function addRelatedParties(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
    {
        if (false === isset($xmlDetail->RltdPties)) {
            return;
        }

        foreach ($xmlDetail->RltdPties as $xmlRelatedParty) {

            if (isset($xmlRelatedParty->Cdtr)) {
                $xmlRelatedPartyType = $xmlRelatedParty->Cdtr;
                $xmlRelatedPartyTypeAccount = $xmlRelatedParty->CdtrAcct;
                $relatedPartyType = $creditor = new DTO\Creditor((string) $xmlRelatedPartyType->Nm);
$myVar = 'Value';
$higher = false;

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

                $this->addRelatedParty($detail, $xmlRelatedPartyType, $relatedPartyType, $xmlRelatedPartyTypeAccount);
            }

            if (isset($xmlRelatedParty->Dbtr)) {
                $xmlRelatedPartyType = $xmlRelatedParty->Dbtr;
                $xmlRelatedPartyTypeAccount = $xmlRelatedParty->DbtrAcct;
                $relatedPartyType = $debtor = new DTO\Debtor((string) $xmlRelatedPartyType->Nm);
$myVar = 'Value';
$higher = false;

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

                $this->addRelatedParty($detail, $xmlRelatedPartyType, $relatedPartyType, $xmlRelatedPartyTypeAccount);
            }
        }
    }

    /**
     * @param DTO\EntryTransactionDetail $detail
     * @param $xmlRelatedPartyType
     * @param $relatedPartyType
     * @param $xmlRelatedPartyTypeAccount
     * @return DTO\RelatedParty
     */
    protected function addRelatedParty(DTO\EntryTransactionDetail $detail, $xmlRelatedPartyType, $relatedPartyType, $xmlRelatedPartyTypeAccount)
    {
        if (isset($xmlRelatedPartyType->PstlAdr)) {
            $relatedPartyType->setAddress(DTOFactory\Address::createFromXml($xmlRelatedPartyType->PstlAdr));
        }

        $relatedParty = new DTO\RelatedParty($relatedPartyType, $this->getRelatedPartyAccount($xmlRelatedPartyTypeAccount));

        $detail->addRelatedParty($relatedParty);

        return $relatedParty;
    }

    /**
     * @param DTO\EntryTransactionDetail $detail
     * @param SimpleXMLElement           $xmlDetail
     */
    public function addRelatedAgents(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
    {
        if (false === isset($xmlDetail->RltdAgts)) {
            return;
        }

        foreach ($xmlDetail->RltdAgts as $xmlRelatedAgent) {
            if(isset($xmlRelatedAgent->CdtrAgt)) {
                $agent = new DTO\CreditorAgent((string)$xmlRelatedAgent->CdtrAgt->FinInstnId->Nm, (string)$xmlRelatedAgent->CdtrAgt->FinInstnId->BIC);
                $relatedAgent =  new DTO\RelatedAgent($agent);
                $detail->addRelatedAgent($relatedAgent);
            }

            if(isset($xmlRelatedAgent->DbtrAgt)) {
                $agent = new DTO\DebtorAgent((string)$xmlRelatedAgent->DbtrAgt->FinInstnId->Nm, (string)$xmlRelatedAgent->DbtrAgt->FinInstnId->BIC);
                $relatedAgent =  new DTO\RelatedAgent($agent);
                $detail->addRelatedAgent($relatedAgent);
            }
        }
    }

    /**
     * @param DTO\EntryTransactionDetail $detail
     * @param SimpleXMLElement           $xmlDetail
     */
    public function addRemittanceInformation(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
    {
        if (false === isset($xmlDetail->RmtInf)) {
            return;
        }

        if (isset($xmlDetail->RmtInf->Ustrd)) {
            $remittanceInformation = DTO\RemittanceInformation::fromUnstructured(
                (string)$xmlDetail->RmtInf->Ustrd
            );
            $detail->setRemittanceInformation($remittanceInformation);

            return;
        }

        if (isset($xmlDetail->RmtInf->Strd)
            && isset($xmlDetail->RmtInf->Strd->CdtrRefInf)
            && isset($xmlDetail->RmtInf->Strd->CdtrRefInf->Ref)
        ) {
            $creditorReferenceInformation = DTO\CreditorReferenceInformation::fromUnstructured(
                (string)$xmlDetail->RmtInf->Strd->CdtrRefInf->Ref
            );
            $remittanceInformation = new DTO\RemittanceInformation();
            $remittanceInformation->setCreditorReferenceInformation($creditorReferenceInformation);
            $detail->setRemittanceInformation($remittanceInformation);
        }
    }

    /**
     * @param DTO\EntryTransactionDetail $detail
     * @param SimpleXMLElement           $xmlDetail
     */
    public function addReturnInformation(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
    {
        if (isset($xmlDetail->RtrInf) && isset($xmlDetail->RtrInf->Rsn->Cd)) {
            $remittanceInformation = DTO\ReturnInformation::fromUnstructured(
                (string)$xmlDetail->RtrInf->Rsn->Cd,
                (string)$xmlDetail->RtrInf->AddtlInf
            );
            $detail->setReturnInformation($remittanceInformation);
        }
    }

    /**
     * @param DTO\EntryTransactionDetail $detail
     * @param SimpleXMLElement           $xmlDetail
     */
    public function addAdditionalTransactionInformation(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
    {
        if (isset($xmlDetail->AddtlTxInf)) {
            $additionalInformation = new DTO\AdditionalTransactionInformation(
                (string) $xmlDetail->AddtlTxInf
            );
            $detail->setAdditionalTransactionInformation($additionalInformation);
        }
    }

    /**
     * @param DTO\EntryTransactionDetail $detail
     * @param SimpleXMLElement           $xmlDetail
     */
    public function addBankTransactionCode(DTO\EntryTransactionDetail $detail, SimpleXMLElement $xmlDetail)
    {
        $bankTransactionCode = new DTO\BankTransactionCode();

        if (isset($xmlDetail->BkTxCd)) {
            $bankTransactionCode = new DTO\BankTransactionCode();

            if (isset($xmlDetail->BkTxCd->Prtry)) {
                $proprietaryBankTransactionCode = new DTO\ProprietaryBankTransactionCode(
                    (string)$xmlDetail->BkTxCd->Prtry->Cd,
                    (string)$xmlDetail->BkTxCd->Prtry->Issr
                );

                $bankTransactionCode->setProprietary($proprietaryBankTransactionCode);
            }
        }

        $detail->setBankTransactionCode($bankTransactionCode);
    }

    /**
     * @param SimpleXMLElement $xmlDetail
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return DTO\Account|null
     */
    abstract public function getRelatedPartyAccount(SimpleXMLElement $xmlRelatedPartyTypeAccount);

}


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 2016-06-10 14:03 UTC by Report Bug Copy Issue Report 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 2016-06-08 09:26 UTC by Report Bug Copy Issue Report `$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 2016-08-26 15:40 UTC by Report Bug Copy Issue Report `$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 2016-06-10 14:03 UTC by Report Bug Copy Issue Report 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

genkgo / camt

Pull Request — master (#31)

EntryTransactionDetail::addReturnInformation() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like