firefly-iii / firefly-iii

app/Import/Specifics/Belfius.php

<?php
/**
 * Belfius.php
 * Copyright (c) 2019 Sander Kleykens <sander@kleykens.com>
 *
 * This file is part of Firefly III (https://github.com/firefly-iii).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
declare(strict_types=1);

namespace FireflyIII\Import\Specifics;

/**
 * Class Belfius.
 *
 * @deprecated
 * @codeCoverageIgnore
 *
 * Fixes Belfius CSV files to:
 *  - Correct descriptions for recurring transactions so doubles can be detected when the equivalent incoming
 *    transaction is imported.
 *
 */
class Belfius implements SpecificInterface

The interface FireflyIII\Import\Specifics\SpecificInterface has been deprecated.

{
    /**
     * Description of this specific fix.
     *
     * @return string
     * @codeCoverageIgnore
     */
    public static function getDescription(): string
    {
        return 'import.specific_belfius_descr';
    }

    /**
     * Name of specific fix.
     *
     * @return string
     * @codeCoverageIgnore
     */
    public static function getName(): string
    {
        return 'import.specific_belfius_name';
    }

    /**
     * Fixes the description for outgoing recurring transactions so doubles can be detected when the equivalent incoming
     * transaction is imported for another bank account.
     *
     * @return array the row containing the new description
     */
    protected static function processRecurringTransactionDescription(array $row): array
    {
        if (!isset($row[5]) || !isset($row[14])) {
            return $row;
        }

        $opposingAccountName = $row[5];
        $description         = $row[14];

        preg_match('/DOORLOPENDE OPDRACHT.*\s+' . preg_quote($opposingAccountName, '/') . '\s+(.+)\s+REF.\s*:/', $description, $matches);

        if (isset($matches[1])) {
            $row[14] = $matches[1];
        }

        return $row;
    }

    /**
     * Run the fix.
     *
     * @param array $row
     *
     * @return array
     *
     */
    public function run(array $row): array
    {
        return Belfius::processRecurringTransactionDescription($row);
    }
}