ToOfx::generate() - Code Metrics - Inspection of "chore: Add local-php-security-checker." - beccha/ofxparser - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( a150bb...33769c )

by Charles

created 2024-04-27 20:00 UTC

ToOfx::generate() A

↳ Parent: ToOfx

Complexity

Conditions	3
Paths	3

Size

Total Lines	55
Code Lines	43

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	3
eloc	43
c	2
b	0
f	0
nc	3
nop	0
dl	0
loc	55
rs	9.232

How to fix Long Method

<?php

declare(strict_types=1);

namespace Beccha\OfxParser;

use Beccha\OfxParser\Entity\BankAccount;
use Beccha\OfxParser\Entity\SignOn;
use XMLWriter;

class ToOfx
{
    /**
     * @var array<BankAccount>
     */
    private array $banks;
    private SignOn $signOn;

    /**
     * @param array<BankAccount> $banks
     */
    public function __construct(SignOn $signOn, array $banks)
    {
        $this->banks = $banks;
        $this->signOn = $signOn;
    }

    public function generate(): string
    {
        $writer = new XMLWriter();
        $writer->openMemory();
        $writer->startDocument('1.0', 'UTF-8', 'no');
        $writer->setIndent(true);
        $writer->setIndentString(' ');

        // Write OFX declaration
        $writer->writeRaw(
            '<?OFX'
            . ' OFXHEADER="200"'
            . ' VERSION="211"'
            . ' SECURITY="NONE"'
            . ' OLDFILEUID="NONE"'
            . ' NEWFILEUID="12345678901234567890123456789012"?>'
            . "\n"
        );

        $writer->startElement('OFX');
        $this->createSignOn($writer);

        // Banks
        foreach ($this->banks as $bank) {
            $writer->startElement('BANKMSGSRSV1');
            $writer->startElement('STMTTRNRS');
            $writer->startElement('TRNUID');
            $writer->text($bank->getTransactionUid());
            $writer->endElement(); // TRNUID
            $writer->startElement('STMTRS');
            $writer->startElement('CURDEF');
            $writer->text($bank->getStatement()->getCurrency());
            $writer->endElement(); // CURDEF
            $this->createBankAccountFrom($writer, $bank);
            $writer->startElement('BANKTRANLIST');
            $writer->startElement('DTSTART');
            $writer->text($bank->getStatement()->getStartDate()->format('YmdHis'));
            $writer->endElement(); // DTSTART
            $writer->startElement('DTEND');
            $writer->text($bank->getStatement()->getEndDate()->format('YmdHis'));
            $writer->endElement(); // DTEND
            foreach ($bank->getStatement()->getTransactions() as $transaction) {
                $this->createTransaction($writer, $transaction);
            }
            $writer->endElement(); // BANKTRANLIST
            $this->createLedgerBalance($writer, $bank);
            $writer->endElement(); // STMTRS
            $writer->endElement(); // STMTTRNRS
            $writer->endElement(); // BANKMSGSRSV1
        }

        $writer->endElement(); // OFX
        $writer->endDocument();

        return $writer->outputMemory(true);
    }

    private function createTransaction(XMLWriter $writer, Entity\Transaction $transaction): void
    {
        $writer->startElement('STMTTRN');
        $writer->startElement('TRNTYPE');
        $writer->text($transaction->getType());
        $writer->endElement(); // TRNTYPE
        $writer->startElement('DTPOSTED');
        $writer->text($transaction->getDate()->format('YmdHis'));
        $writer->endElement(); // DTPOSTED
        $writer->startElement('TRNAMT');
        $writer->text($this->formatAmount($transaction->getAmount()));
        $writer->endElement(); // TRNAMT
        $writer->startElement('FITID');
        $writer->text($transaction->getUniqueId());
        $writer->endElement(); // FITID
        $writer->startElement('NAME');
        $writer->text($transaction->getName());
        $writer->endElement(); // NAME
        $writer->startElement('MEMO');
        $writer->text($transaction->getMemo());
        $writer->endElement(); // NAME
        $writer->endElement(); // STMTTRN
    }

    private function createSignOn(XMLWriter $writer): void
    {
// SignOn
        $writer->startElement('SIGNONMSGSRSV1');
        $writer->startElement('SONRS');
        $this->createServerStatus($writer);
        $writer->startElement('DTSERVER');
        $writer->text($this->signOn->getDate()->format('YmdHis'));
        $writer->endElement(); // DTSERVER
        $writer->startElement('LANGUAGE');
        $writer->text($this->signOn->getLanguage());
        $writer->endElement(); // LANGUAGE
        $this->createSignOnFi($writer);
        $writer->endElement(); // SONRS
        $writer->endElement(); // SIGNONMSGSRSV1
    }

    private function createSignOnFi(XMLWriter $writer): void
    {
        $writer->startElement('FI');
        $writer->startElement('ORG');
        $writer->text($this->signOn->getInstitution()->getName());
        $writer->endElement(); // ORG
        $writer->startElement('FID');
        $writer->text($this->signOn->getInstitution()->getId());
        $writer->endElement(); // FID
        $writer->endElement(); // FI
    }

    private function createServerStatus(XMLWriter $writer): void
    {
        $writer->startElement('STATUS');
        $writer->startElement('CODE');
        $writer->text($this->signOn->getStatus()->getCode());
        $writer->endElement(); // CODE
        $writer->startElement('SEVERITY');
        $writer->text($this->signOn->getStatus()->getSeverity());
        $writer->endElement(); // SEVERITY
        $writer->startElement('MESSAGE');
        $writer->text($this->signOn->getStatus()->getMessage());
        $writer->endElement(); // MESSAGE
        $writer->endElement(); // STATUS
    }

    private function createLedgerBalance(XMLWriter $writer, BankAccount $bank): void
    {
        $writer->startElement('LEDGERBAL');
        $writer->startElement('BALAMT');
        $writer->text($this->formatAmount($bank->getBalance()));
        $writer->endElement(); // BALAMT
        $writer->startElement('DTASOF');
        $writer->text($bank->getBalanceDate()->format('YmdHis'));
        $writer->endElement(); // DTASOF
        $writer->endElement(); // LEDGERBAL
    }

    /**
     * @param XMLWriter $writer
     * @param BankAccount $bank
     * @return void
     */
    private function createBankAccountFrom(XMLWriter $writer, BankAccount $bank): void
    {
        $writer->startElement('BANKACCTFROM');
        $writer->startElement('BANKID');
        $writer->text($bank->getRoutingNumber());
        $writer->endElement(); // BANKID
        $writer->startElement('ACCTID');
        $writer->text($bank->getAccountNumber());
        $writer->endElement(); // ACCTID
        $writer->startElement('ACCTTYPE');
        $writer->text($bank->getAccountType());
        $writer->endElement(); // ACCTTYPE
        $writer->endElement(); // BANKACCTFROM
    }

    private function formatAmount(int $amount): string
    {
        return number_format(($amount / 100), 2, '.', '');
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Beccha\OfxParser;
6
7			use Beccha\OfxParser\Entity\BankAccount;
8			use Beccha\OfxParser\Entity\SignOn;
9			use XMLWriter;
10
11			class ToOfx
12			{
13			/**
14			* @var array<BankAccount>
15			*/
16			private array $banks;
17			private SignOn $signOn;
18
19			/**
20			* @param array<BankAccount> $banks
21			*/
22			public function __construct(SignOn $signOn, array $banks)
23			{
24			$this->banks = $banks;
25			$this->signOn = $signOn;
26			}
27
28			public function generate(): string
29			{
30			$writer = new XMLWriter();
31			$writer->openMemory();
32			$writer->startDocument('1.0', 'UTF-8', 'no');
33			$writer->setIndent(true);
34			$writer->setIndentString(' ');
35
36			// Write OFX declaration
37			$writer->writeRaw(
38			'<?OFX'
39			. ' OFXHEADER="200"'
40			. ' VERSION="211"'
41			. ' SECURITY="NONE"'
42			. ' OLDFILEUID="NONE"'
43			. ' NEWFILEUID="12345678901234567890123456789012"?>'
44			. "\n"
45			);
46
47			$writer->startElement('OFX');
48			$this->createSignOn($writer);
49
50			// Banks
51			foreach ($this->banks as $bank) {
52			$writer->startElement('BANKMSGSRSV1');
53			$writer->startElement('STMTTRNRS');
54			$writer->startElement('TRNUID');
55			$writer->text($bank->getTransactionUid());
56			$writer->endElement(); // TRNUID
57			$writer->startElement('STMTRS');
58			$writer->startElement('CURDEF');
59			$writer->text($bank->getStatement()->getCurrency());
60			$writer->endElement(); // CURDEF
61			$this->createBankAccountFrom($writer, $bank);
62			$writer->startElement('BANKTRANLIST');
63			$writer->startElement('DTSTART');
64			$writer->text($bank->getStatement()->getStartDate()->format('YmdHis'));
65			$writer->endElement(); // DTSTART
66			$writer->startElement('DTEND');
67			$writer->text($bank->getStatement()->getEndDate()->format('YmdHis'));
68			$writer->endElement(); // DTEND
69			foreach ($bank->getStatement()->getTransactions() as $transaction) {
70			$this->createTransaction($writer, $transaction);
71			}
72			$writer->endElement(); // BANKTRANLIST
73			$this->createLedgerBalance($writer, $bank);
74			$writer->endElement(); // STMTRS
75			$writer->endElement(); // STMTTRNRS
76			$writer->endElement(); // BANKMSGSRSV1
77			}
78
79			$writer->endElement(); // OFX
80			$writer->endDocument();
81
82			return $writer->outputMemory(true);
83			}
84
85			private function createTransaction(XMLWriter $writer, Entity\Transaction $transaction): void
86			{
87			$writer->startElement('STMTTRN');
88			$writer->startElement('TRNTYPE');
89			$writer->text($transaction->getType());
90			$writer->endElement(); // TRNTYPE
91			$writer->startElement('DTPOSTED');
92			$writer->text($transaction->getDate()->format('YmdHis'));
93			$writer->endElement(); // DTPOSTED
94			$writer->startElement('TRNAMT');
95			$writer->text($this->formatAmount($transaction->getAmount()));
96			$writer->endElement(); // TRNAMT
97			$writer->startElement('FITID');
98			$writer->text($transaction->getUniqueId());
99			$writer->endElement(); // FITID
100			$writer->startElement('NAME');
101			$writer->text($transaction->getName());
102			$writer->endElement(); // NAME
103			$writer->startElement('MEMO');
104			$writer->text($transaction->getMemo());
105			$writer->endElement(); // NAME
106			$writer->endElement(); // STMTTRN
107			}
108
109			private function createSignOn(XMLWriter $writer): void
110			{
111			// SignOn
112			$writer->startElement('SIGNONMSGSRSV1');
113			$writer->startElement('SONRS');
114			$this->createServerStatus($writer);
115			$writer->startElement('DTSERVER');
116			$writer->text($this->signOn->getDate()->format('YmdHis'));
117			$writer->endElement(); // DTSERVER
118			$writer->startElement('LANGUAGE');
119			$writer->text($this->signOn->getLanguage());
120			$writer->endElement(); // LANGUAGE
121			$this->createSignOnFi($writer);
122			$writer->endElement(); // SONRS
123			$writer->endElement(); // SIGNONMSGSRSV1
124			}
125
126			private function createSignOnFi(XMLWriter $writer): void
127			{
128			$writer->startElement('FI');
129			$writer->startElement('ORG');
130			$writer->text($this->signOn->getInstitution()->getName());
131			$writer->endElement(); // ORG
132			$writer->startElement('FID');
133			$writer->text($this->signOn->getInstitution()->getId());
134			$writer->endElement(); // FID
135			$writer->endElement(); // FI
136			}
137
138			private function createServerStatus(XMLWriter $writer): void
139			{
140			$writer->startElement('STATUS');
141			$writer->startElement('CODE');
142			$writer->text($this->signOn->getStatus()->getCode());
143			$writer->endElement(); // CODE
144			$writer->startElement('SEVERITY');
145			$writer->text($this->signOn->getStatus()->getSeverity());
146			$writer->endElement(); // SEVERITY
147			$writer->startElement('MESSAGE');
148			$writer->text($this->signOn->getStatus()->getMessage());
149			$writer->endElement(); // MESSAGE
150			$writer->endElement(); // STATUS
151			}
152
153			private function createLedgerBalance(XMLWriter $writer, BankAccount $bank): void
154			{
155			$writer->startElement('LEDGERBAL');
156			$writer->startElement('BALAMT');
157			$writer->text($this->formatAmount($bank->getBalance()));
158			$writer->endElement(); // BALAMT
159			$writer->startElement('DTASOF');
160			$writer->text($bank->getBalanceDate()->format('YmdHis'));
161			$writer->endElement(); // DTASOF
162			$writer->endElement(); // LEDGERBAL
163			}
164
165			/**
166			* @param XMLWriter $writer
167			* @param BankAccount $bank
168			* @return void
169			*/
170			private function createBankAccountFrom(XMLWriter $writer, BankAccount $bank): void
171			{
172			$writer->startElement('BANKACCTFROM');
173			$writer->startElement('BANKID');
174			$writer->text($bank->getRoutingNumber());
175			$writer->endElement(); // BANKID
176			$writer->startElement('ACCTID');
177			$writer->text($bank->getAccountNumber());
178			$writer->endElement(); // ACCTID
179			$writer->startElement('ACCTTYPE');
180			$writer->text($bank->getAccountType());
181			$writer->endElement(); // ACCTTYPE
182			$writer->endElement(); // BANKACCTFROM
183			}
184
185			private function formatAmount(int $amount): string
186			{
187			return number_format(($amount / 100), 2, '.', '');
188			}
189			}
190

beccha / ofxparser

Push — master ( a150bb...33769c )

ToOfx::generate() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like