Skip to content

Firefly III: a personal finances manager

6.3 KB
Raw Blame
<?php

/**
 * BalanceController.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\Http\Controllers\Report;

use Carbon\Carbon;
use FireflyIII\Enums\TransactionTypeEnum;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Helpers\Collector\GroupCollectorInterface;
use FireflyIII\Http\Controllers\Controller;
use FireflyIII\Models\Account;
use FireflyIII\Models\Budget;
use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Log;
use Throwable;

/**
 * Class BalanceController.
 */
final class BalanceController extends Controller
{
    /** @var BudgetRepositoryInterface */
    private $repository;

    /**
     * BalanceController constructor.
     */
    public function __construct()
    {
        parent::__construct();

        $this->middleware(function ($request, $next) {
            $this->repository = app(BudgetRepositoryInterface::class);

            return $next($request);
        });
    }

    /**
     * Show overview of budget balances.
     *
     * @return string
     *
     * @throws FireflyException
     */
    public function general(Collection $accounts, Carbon $start, Carbon $end)
    {
        $report  = ['budgets' => [], 'accounts' => []];

        /** @var Account $account */
        foreach ($accounts as $account) {
            $report['accounts'][$account->id] = ['id' => $account->id, 'name' => $account->name, 'iban' => $account->iban, 'sum' => '0'];
        }

        $budgets = $this->repository->getBudgets();

        /** @var Budget $budget */
        foreach ($budgets as $budget) {
            $budgetId                              = $budget->id;
            $report['budgets'][$budgetId]          = [
                'budget_id'   => $budgetId,
                'budget_name' => $budget->name,
                'spent'       => [], // per account
                'sums'        => [], // per currency
            ];
            $spent                                 = [];

            /** @var GroupCollectorInterface $collector */
            $collector                             = app(GroupCollectorInterface::class);
            $journals                              = $collector
                ->setRange($start, $end)
                ->setSourceAccounts($accounts)
                ->setTypes([TransactionTypeEnum::WITHDRAWAL->value])
                ->setBudget($budget)
                ->getExtractedJournals()
            ;

            /** @var array $journal */
            foreach ($journals as $journal) {
                $sourceAccount                                                 = $journal['source_account_id'];
                $currencyId                                                    = $journal['currency_id'];
                $spent[$sourceAccount]                  ??= [
                    'source_account_id'       => $sourceAccount,
                    'currency_id'             => $journal['currency_id'],
                    'currency_code'           => $journal['currency_code'],
                    'currency_name'           => $journal['currency_name'],
                    'currency_symbol'         => $journal['currency_symbol'],
                    'currency_decimal_places' => $journal['currency_decimal_places'],
                    'spent'                   => '0',
                ];
                $spent[$sourceAccount]['spent']                                = bcadd($spent[$sourceAccount]['spent'], (string) $journal['amount']);

                // also fix sum:
                $report['sums'][$budgetId][$currencyId] ??= [
                    'sum'                     => '0',
                    'currency_id'             => $journal['currency_id'],
                    'currency_code'           => $journal['currency_code'],
                    'currency_name'           => $journal['currency_name'],
                    'currency_symbol'         => $journal['currency_symbol'],
                    'currency_decimal_places' => $journal['currency_decimal_places'],
                ];
                $report['sums'][$budgetId][$currencyId]['sum']                 = bcadd($report['sums'][$budgetId][$currencyId]['sum'], (string) $journal['amount']);
                $report['accounts'][$sourceAccount]['sum']                     = bcadd($report['accounts'][$sourceAccount]['sum'], (string) $journal['amount']);

                // add currency info for account sum
                $report['accounts'][$sourceAccount]['currency_id']             = $journal['currency_id'];
                $report['accounts'][$sourceAccount]['currency_code']           = $journal['currency_code'];
                $report['accounts'][$sourceAccount]['currency_name']           = $journal['currency_name'];
                $report['accounts'][$sourceAccount]['currency_symbol']         = $journal['currency_symbol'];
                $report['accounts'][$sourceAccount]['currency_decimal_places'] = $journal['currency_decimal_places'];
            }
            $report['budgets'][$budgetId]['spent'] = $spent;

            // get transactions in budget
        }

        //        echo '<pre>';
        //        print_r($report);exit;
        try {
            $result = view('reports.partials.balance', ['report' => $report])->render();
        } catch (Throwable $e) {
            Log::error(sprintf('Could not render reports.partials.balance: %s', $e->getMessage()));
            Log::error($e->getTraceAsString());
            $result = sprintf('Could not render view: %s', $e->getMessage());

            throw new FireflyException($result, 0, $e);
        }

        return $result;
    }
}