MT940::parse() - Code Metrics - Inspection of "Add support for transaction codes" - mschindler83/fints-hbci-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#95)

unknown

created 2018-01-25 11:37 UTC

MT940::parse() A

↳ Parent: MT940

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2.5

Importance

Changes

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

<?php

namespace Fhp\Parser;

use Fhp\Parser\Exception\MT940Exception;

/**
 * Class MT940
 * @package Fhp\Parser
 */
class MT940
{
    const TARGET_ARRAY = 0;

    const CD_CREDIT = 'credit';
    const CD_DEBIT = 'debit';
    const CD_CREDIT_CANCELLATION = 'credit_cancellation';
    const CD_DEBIT_CANCELLATION = 'debit_cancellation';

    /** @var string */
    protected $rawData;
    /** @var string */
    protected $soaDate;

    /**
     * MT940 constructor.
     *
     * @param string $rawData
     */
    public function __construct($rawData)
    {
        $this->rawData = (string) $rawData;
    }

    /**
     * @param string $target
     * @return array
     * @throws MT940Exception
     */
    public function parse($target)
    {
        switch ($target) {
            case static::TARGET_ARRAY:
                return $this->parseToArray();
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            default:
                throw new MT940Exception('Invalid parse type provided');
        }
    }

    /**
     * @return array
     * @throws MT940Exception
     */
    protected function parseToArray()
    {
        // The divider can be either \r\n or @@
        $divider = substr_count($this->rawData, "\r\n-") > substr_count($this->rawData, '@@-') ? "\r\n" : '@@';

        $result = array();
        $days = preg_split('%' . $divider . '-$%', $this->rawData);
        foreach ($days as &$day) {
            $day = explode($divider . ':', $day);
            for ($i = 0, $cnt = count($day); $i < $cnt; $i++) {
                // handle start balance
                // 60F:C160401EUR1234,56

                if (preg_match('/^60(F|M):/', $day[$i])) {
                    // remove 60(F|M): for better parsing

                    $day[$i] = substr($day[$i], 4);
                    $this->soaDate = $this->getDate(substr($day[$i], 1, 6));

                    if (!isset($result[$this->soaDate])) {
                        $result[$this->soaDate] = array('start_balance' => array());
                    }

                    $cdMark = substr($day[$i], 0, 1);
                    if ($cdMark == 'C') {
                        $result[$this->soaDate]['start_balance']['credit_debit'] = static::CD_CREDIT;
                    } elseif ($cdMark == 'D') {
                        $result[$this->soaDate]['start_balance']['credit_debit'] = static::CD_DEBIT;
                    }

                    $amount = str_replace(',', '.', substr($day[$i], 10));
                    $result[$this->soaDate]['start_balance']['amount'] = $amount;
                } elseif (
                    // found transaction
                    // trx:61:1603310331DR637,39N033NONREF

                    0 === strpos($day[$i], '61:')
                    && isset($day[$i + 1])
                    && 0 === strpos($day[$i + 1], '86:')
                ) {
                    $transaction = substr($day[$i], 3);
                    $description = substr($day[$i + 1], 3);

                    if (!isset($result[$this->soaDate]['transactions'])) {
                        $result[$this->soaDate]['transactions'] = array();
                    }

                    // short form for better handling
                    $trx = &$result[$this->soaDate]['transactions'];
                    $currentTrx = &$trx[count($trx)];
                    
                    preg_match('/^\d{6}(\d{4})?(C|D|RC|RD)[A-Z]?([^N]+)N(...)?/', $transaction, $trxMatch);
                    
                    switch($trxMatch[2]) {
                        case 'C':
                            $currentTrx['credit_debit'] = static::CD_CREDIT;
                            break;
                        case 'D':
                            $currentTrx['credit_debit'] = static::CD_DEBIT;
                            break;
                        case 'RC':
                            $currentTrx['credit_debit'] = static::CD_CREDIT_CANCELLATION;
                            break;
                        case 'RD':
                            $currentTrx['credit_debit'] = static::CD_DEBIT_CANCELLATION;
                            break;
                        default:
                            throw new MT940Exception('c/d/rc/rd mark not found in: ' . $transaction);
                    }
                    
                    $amount = $trxMatch[4];
                    $amount = str_replace(',', '.', $amount);
                    $currentTrx['amount'] = floatval($amount);

                    $code = count($trxMatch) > 4 ? $trxMatch[4] : "";
                    $currentTrx['transaction_code'] = $code;

                    $description = $this->parseDescription($description);
                    $currentTrx['description'] = $description;

                    // :61:1605110509D198,02NMSCNONREF

                    // 16 = year
                    // 0511 = valuta date
                    // 0509 = booking date
                    $year = substr($transaction, 0, 2);
                    $valutaDate = $this->getDate($year . substr($transaction, 2, 4));

                    $bookingDate = substr($transaction, 6, 4);
                    if (preg_match('/^\d{4}$/', $bookingDate)) {
                        // if valuta date is earlier than booking date, then it must be in the new year.
                        if (substr($transaction, 2, 2) == '12' && substr($transaction, 6, 2) == '01') {
                            $year++;
                        } elseif (substr($transaction, 2, 2) == '01' && substr($transaction, 6, 2) == '12') {
                            $year--;
                        }
                        $bookingDate = $this->getDate($year . $bookingDate);
                    } else {
                        // if booking date not set in :61, then we have to take it from :60F
                        $bookingDate = $this->soaDate;
                    }

                    $currentTrx['booking_date'] = $bookingDate;
                    $currentTrx['valuta_date'] = $valutaDate;
                }
            }
        }

        return $result;
    }

    /**
     * @param string $descr
     * @return array
     */
    protected function parseDescription($descr)
    {
        $prepared = array();
        $result = array();

        // prefill with empty values
        for ($i = 0; $i <= 63; $i++) {
            $prepared[$i] = null;
        }

        $descr = str_replace("\r\n", '', $descr);
        $descr = str_replace('? ', '?', $descr);
        preg_match_all('/\?[\r\n]*(\d{2})([^\?]+)/', $descr, $matches, PREG_SET_ORDER);

        $descriptionLines = array();
        $description1 = ''; // Legacy, could be removed.
        $description2 = ''; // Legacy, could be removed.
        foreach ($matches as $m) {
            $index = (int) $m[1];
            if ((20 <= $index && $index <= 29) || (60 <= $index && $index <= 63)) {
                if (20 <= $index && $index <= 29) {
                    $description1 .= $m[2];
                } else {
                    $description2 .= $m[2];
                }
                $m[2] = trim($m[2]);
                if (!empty($m[2])) {
                    $descriptionLines[] = $m[2];
                }
            } else {
                $prepared[$index] = $m[2];
            }
        }

        $description = array();
        if (empty($descriptionLines) || strlen($descriptionLines[0]) < 5 || $descriptionLines[0][4] !== '+') {
            $description['SVWZ'] = implode('', $descriptionLines);
        } else {
            $lastType = null;
            foreach ($descriptionLines as $line) {
                if (strlen($line) > 5 && $line[4] === '+') {
                    if ($lastType != null) {

                        $description[$lastType] = trim($description[$lastType]);
                    }
                    $lastType = substr($line, 0, 4);
                    $description[$lastType] = substr($line, 5);
                } else {
                    $description[$lastType] .= $line;
                }
                if (strlen($line) < 27) {
                    // Usually, lines are 27 characters long. In case characters are missing, then it's either the end
                    // of the current type or spaces have been trimmed from the end. We want to collapse multiple spaces
                    // into one and we don't want to leave trailing spaces behind. So add a single space here to make up
                    // for possibly missing spaces, and if it's the end of the type, it will be trimmed off later.
                    $description[$lastType] .= ' ';
                }
            }
            $description[$lastType] = trim($description[$lastType]);
        }

        $result['description']       = $description;
        $result['booking_text']      = trim($prepared[0]);
        $result['primanoten_nr']     = trim($prepared[10]);
        $result['description_1']     = trim($description1);
        $result['bank_code']         = trim($prepared[30]);
        $result['account_number']    = trim($prepared[31]);
        $result['name']              = trim($prepared[32] . $prepared[33]);
        $result['text_key_addition'] = trim($prepared[34]);
        $result['description_2']     = trim($description2);
        return $result;
    }

    /**
     * @param string $val
     * @return string
     */
    protected function getDate($val)
    {
        $val = '20' . $val;
        preg_match('/(\d{4})(\d{2})(\d{2})/', $val, $m);
        return $m[1] . '-' . $m[2] . '-' . $m[3];
    }
}


1		<?php
2
3		namespace Fhp\Parser;
4
5		use Fhp\Parser\Exception\MT940Exception;
6
7		/**
8		* Class MT940
9		* @package Fhp\Parser
10		*/
11		class MT940
12		{
13		const TARGET_ARRAY = 0;
14
15		const CD_CREDIT = 'credit';
16		const CD_DEBIT = 'debit';
17		const CD_CREDIT_CANCELLATION = 'credit_cancellation';
18		const CD_DEBIT_CANCELLATION = 'debit_cancellation';
19
20		/** @var string */
21		protected $rawData;
22		/** @var string */
23		protected $soaDate;
24
25		/**
26		* MT940 constructor.
27		*
28		* @param string $rawData
29		*/
30	1	public function __construct($rawData)
31		{
32	1	$this->rawData = (string) $rawData;
33	1	}
34
35		/**
36		* @param string $target
37		* @return array
38		* @throws MT940Exception
39		*/
40	1	public function parse($target)
41		{
42		switch ($target) {
43	1	case static::TARGET_ARRAY:
44	1	return $this->parseToArray();
45		break;
		0 ignored issues – show Unused Code introduced 2016-09-05 20:43 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
46		default:
47		throw new MT940Exception('Invalid parse type provided');
48		}
49		}
50
51		/**
52		* @return array
53		* @throws MT940Exception
54		*/
55	1	protected function parseToArray()
56		{
57		// The divider can be either \r\n or @@
58	1	$divider = substr_count($this->rawData, "\r\n-") > substr_count($this->rawData, '@@-') ? "\r\n" : '@@';
59
60	1	$result = array();
61	1	$days = preg_split('%' . $divider . '-$%', $this->rawData);
62	1	foreach ($days as &$day) {
63	1	$day = explode($divider . ':', $day);
64	1	for ($i = 0, $cnt = count($day); $i < $cnt; $i++) {
65		// handle start balance
66		// 60F:C160401EUR1234,56
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-09-05 20:43 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
67	1	if (preg_match('/^60(F\|M):/', $day[$i])) {
68		// remove 60(F\|M): for better parsing
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-01-10 09:12 UTC by Report Bug Copy Issue Report `38%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
69	1	$day[$i] = substr($day[$i], 4);
70	1	$this->soaDate = $this->getDate(substr($day[$i], 1, 6));
71
72	1	if (!isset($result[$this->soaDate])) {
73	1	$result[$this->soaDate] = array('start_balance' => array());
74	1	}
75
76	1	$cdMark = substr($day[$i], 0, 1);
77	1	if ($cdMark == 'C') {
78	1	$result[$this->soaDate]['start_balance']['credit_debit'] = static::CD_CREDIT;
79	1	} elseif ($cdMark == 'D') {
80		$result[$this->soaDate]['start_balance']['credit_debit'] = static::CD_DEBIT;
81		}
82
83	1	$amount = str_replace(',', '.', substr($day[$i], 10));
84	1	$result[$this->soaDate]['start_balance']['amount'] = $amount;
85	1	} elseif (
86		// found transaction
87		// trx:61:1603310331DR637,39N033NONREF
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-09-05 20:43 UTC by Report Bug Copy Issue Report `56%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
88	1	0 === strpos($day[$i], '61:')
89	1	&& isset($day[$i + 1])
90	1	&& 0 === strpos($day[$i + 1], '86:')
91	1	) {
92	1	$transaction = substr($day[$i], 3);
93	1	$description = substr($day[$i + 1], 3);
94
95	1	if (!isset($result[$this->soaDate]['transactions'])) {
96	1	$result[$this->soaDate]['transactions'] = array();
97	1	}
98
99		// short form for better handling
100	1	$trx = &$result[$this->soaDate]['transactions'];
101	1	$currentTrx = &$trx[count($trx)];
102
103	1	preg_match('/^\d{6}(\d{4})?(C\|D\|RC\|RD)[A-Z]?([^N]+)N(...)?/', $transaction, $trxMatch);
104
105	1	switch($trxMatch[2]) {
106	1	case 'C':
107	1	$currentTrx['credit_debit'] = static::CD_CREDIT;
108	1	break;
109		case 'D':
110		$currentTrx['credit_debit'] = static::CD_DEBIT;
111		break;
112		case 'RC':
113		$currentTrx['credit_debit'] = static::CD_CREDIT_CANCELLATION;
114		break;
115		case 'RD':
116		$currentTrx['credit_debit'] = static::CD_DEBIT_CANCELLATION;
117		break;
118		default:
119		throw new MT940Exception('c/d/rc/rd mark not found in: ' . $transaction);
120	1	}
121
122	1	$amount = $trxMatch[4];
123	1	$amount = str_replace(',', '.', $amount);
124	1	$currentTrx['amount'] = floatval($amount);
125
126	1	$code = count($trxMatch) > 4 ? $trxMatch[4] : "";
127	1	$currentTrx['transaction_code'] = $code;
128
129	1	$description = $this->parseDescription($description);
130	1	$currentTrx['description'] = $description;
131
132		// :61:1605110509D198,02NMSCNONREF
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-09-05 20:43 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
133		// 16 = year
134		// 0511 = valuta date
135		// 0509 = booking date
136	1	$year = substr($transaction, 0, 2);
137	1	$valutaDate = $this->getDate($year . substr($transaction, 2, 4));
138
139	1	$bookingDate = substr($transaction, 6, 4);
140	1	if (preg_match('/^\d{4}$/', $bookingDate)) {
141		// if valuta date is earlier than booking date, then it must be in the new year.
142	1	if (substr($transaction, 2, 2) == '12' && substr($transaction, 6, 2) == '01') {
143		$year++;
144	1	} elseif (substr($transaction, 2, 2) == '01' && substr($transaction, 6, 2) == '12') {
145		$year--;
146		}
147	1	$bookingDate = $this->getDate($year . $bookingDate);
148	1	} else {
149		// if booking date not set in :61, then we have to take it from :60F
150		$bookingDate = $this->soaDate;
151		}
152
153	1	$currentTrx['booking_date'] = $bookingDate;
154	1	$currentTrx['valuta_date'] = $valutaDate;
155	1	}
156	1	}
157	1	}
158
159	1	return $result;
160		}
161
162		/**
163		* @param string $descr
164		* @return array
165		*/
166	1	protected function parseDescription($descr)
167		{
168	1	$prepared = array();
169	1	$result = array();
170
171		// prefill with empty values
172	1	for ($i = 0; $i <= 63; $i++) {
173	1	$prepared[$i] = null;
174	1	}
175
176	1	$descr = str_replace("\r\n", '', $descr);
177	1	$descr = str_replace('? ', '?', $descr);
178	1	preg_match_all('/\?[\r\n]*(\d{2})([^\?]+)/', $descr, $matches, PREG_SET_ORDER);
179
180	1	$descriptionLines = array();
181	1	$description1 = ''; // Legacy, could be removed.
182	1	$description2 = ''; // Legacy, could be removed.
183	1	foreach ($matches as $m) {
184	1	$index = (int) $m[1];
185	1	if ((20 <= $index && $index <= 29) \|\| (60 <= $index && $index <= 63)) {
186	1	if (20 <= $index && $index <= 29) {
187	1	$description1 .= $m[2];
188	1	} else {
189		$description2 .= $m[2];
190		}
191	1	$m[2] = trim($m[2]);
192	1	if (!empty($m[2])) {
193	1	$descriptionLines[] = $m[2];
194	1	}
195	1	} else {
196	1	$prepared[$index] = $m[2];
197		}
198	1	}
199
200	1	$description = array();
201	1	if (empty($descriptionLines) \|\| strlen($descriptionLines[0]) < 5 \|\| $descriptionLines[0][4] !== '+') {
202		$description['SVWZ'] = implode('', $descriptionLines);
203		} else {
204	1	$lastType = null;
205	1	foreach ($descriptionLines as $line) {
206	1	if (strlen($line) > 5 && $line[4] === '+') {
207	1	if ($lastType != null) {
		0 ignored issues – show Bug introduced 2016-11-13 19:46 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$lastType` of type `string\|null` against `null`; this is ambiguous if the string can be empty. Consider using a strict comparison `!==` instead. Loading history...
208	1	$description[$lastType] = trim($description[$lastType]);
209	1	}
210	1	$lastType = substr($line, 0, 4);
211	1	$description[$lastType] = substr($line, 5);
212	1	} else {
213	1	$description[$lastType] .= $line;
214		}
215	1	if (strlen($line) < 27) {
216		// Usually, lines are 27 characters long. In case characters are missing, then it's either the end
217		// of the current type or spaces have been trimmed from the end. We want to collapse multiple spaces
218		// into one and we don't want to leave trailing spaces behind. So add a single space here to make up
219		// for possibly missing spaces, and if it's the end of the type, it will be trimmed off later.
220	1	$description[$lastType] .= ' ';
221	1	}
222	1	}
223	1	$description[$lastType] = trim($description[$lastType]);
224		}
225
226	1	$result['description'] = $description;
227	1	$result['booking_text'] = trim($prepared[0]);
228	1	$result['primanoten_nr'] = trim($prepared[10]);
229	1	$result['description_1'] = trim($description1);
230	1	$result['bank_code'] = trim($prepared[30]);
231	1	$result['account_number'] = trim($prepared[31]);
232	1	$result['name'] = trim($prepared[32] . $prepared[33]);
233	1	$result['text_key_addition'] = trim($prepared[34]);
234	1	$result['description_2'] = trim($description2);
235	1	return $result;
236		}
237
238		/**
239		* @param string $val
240		* @return string
241		*/
242	1	protected function getDate($val)
243		{
244	1	$val = '20' . $val;
245	1	preg_match('/(\d{4})(\d{2})(\d{2})/', $val, $m);
246	1	return $m[1] . '-' . $m[2] . '-' . $m[3];
247		}
248		}
249

mschindler83 / fints-hbci-php

Pull Request — master (#95)

MT940::parse() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like