Skip to content

Firefly III: a personal finances manager

3.9 KB
Raw Blame
<?php

/**
 * TransactionCurrencyFactory.php
 * Copyright (c) 2019 [email protected]
 *
 * 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\Factory;

use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\TransactionCurrency;
use FireflyIII\Support\Facades\Amount;
use Illuminate\Database\QueryException;
use Illuminate\Support\Facades\Log;

/**
 * Class TransactionCurrencyFactory
 */
class TransactionCurrencyFactory
{
    /**
     * @throws FireflyException
     */
    public function create(array $data): TransactionCurrency
    {
        $data['code']           = e($data['code']);
        $data['symbol']         = e($data['symbol']);
        $data['name']           = e($data['name']);
        $data['decimal_places'] = (int) $data['decimal_places'];
        // if the code already exists (deleted)
        // force delete it and then create the transaction:
        $count                  = TransactionCurrency::query()->withTrashed()->whereCode($data['code'])->count();
        if (1 === $count) {
            $old = TransactionCurrency::query()->withTrashed()->whereCode($data['code'])->first();
            $old->forceDelete();
            Log::warning(sprintf('Force deleted old currency with ID #%d and code "%s".', $old->id, $data['code']));
        }

        try {
            /** @var TransactionCurrency $result */
            $result = TransactionCurrency::create([
                'name'           => $data['name'],
                'code'           => $data['code'],
                'symbol'         => $data['symbol'],
                'decimal_places' => $data['decimal_places'],
                'enabled'        => false,
            ]);
        } catch (QueryException $e) {
            $result = null;
            Log::error(sprintf('Could not create new currency: %s', $e->getMessage()));
            Log::error($e->getTraceAsString());

            throw new FireflyException('400004: Could not store new currency.', 0, $e);
        }

        return $result;
    }

    public function find(?int $currencyId, ?string $currencyCode): ?TransactionCurrency
    {
        $currencyCode = e($currencyCode);
        $currencyId   = (int) $currencyId;
        $currency     = null;

        if ('' === $currencyCode && 0 === $currencyId) {
            Log::debug('Cannot find anything on empty currency code and empty currency ID!');

            return null;
        }

        // first by ID:
        if ($currencyId > 0) {
            try {
                $currency = Amount::getTransactionCurrencyById($currencyId);
            } catch (FireflyException) {
                Log::warning(sprintf('Currency ID is #%d but found nothing!', $currencyId));
            }
        }
        // then by code:
        if ('' !== $currencyCode && null === $currency) {
            try {
                $currency = Amount::getTransactionCurrencyByCode($currencyCode);
            } catch (FireflyException) {
                Log::warning(sprintf('Currency code is "%s" but found nothing!', $currencyCode));
            }
        }
        Log::info(sprintf('Found currency #%d based on ID %d and code "%s".', $currency->id, $currencyId, $currencyCode));

        return $currency;
    }
}