mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-02-25 18:45:27 -06:00
347 lines
12 KiB
PHP
347 lines
12 KiB
PHP
<?php
|
|
/**
|
|
* ExpenseController.php
|
|
* Copyright (c) 2017 thegrumpydictator@gmail.com
|
|
*
|
|
* This file is part of Firefly III.
|
|
*
|
|
* Firefly III is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Firefly III 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\Http\Controllers\Report;
|
|
|
|
use Carbon\Carbon;
|
|
use FireflyIII\Helpers\Collector\GroupCollectorInterface;
|
|
use FireflyIII\Http\Controllers\Controller;
|
|
use FireflyIII\Models\TransactionType;
|
|
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
|
|
use FireflyIII\Support\CacheProperties;
|
|
use FireflyIII\Support\Http\Controllers\AugumentData;
|
|
use Illuminate\Support\Collection;
|
|
use Log;
|
|
use Throwable;
|
|
|
|
/**
|
|
* Class ExpenseController
|
|
*
|
|
*/
|
|
class ExpenseController extends Controller
|
|
{
|
|
use AugumentData;
|
|
|
|
/** @var AccountRepositoryInterface The account repository */
|
|
protected $accountRepository;
|
|
|
|
/**
|
|
* Constructor for ExpenseController
|
|
* @codeCoverageIgnore
|
|
*/
|
|
public function __construct()
|
|
{
|
|
parent::__construct();
|
|
|
|
// translations:
|
|
$this->middleware(
|
|
function ($request, $next) {
|
|
$this->accountRepository = app(AccountRepositoryInterface::class);
|
|
|
|
return $next($request);
|
|
}
|
|
);
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Generates the overview per budget.
|
|
*
|
|
* @param Collection $accounts
|
|
* @param Collection $expense
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
*
|
|
* @return string
|
|
*/
|
|
public function budget(Collection $accounts, Collection $expense, Carbon $start, Carbon $end): string
|
|
{
|
|
// Properties for cache:
|
|
$cache = new CacheProperties;
|
|
$cache->addProperty($start);
|
|
$cache->addProperty($end);
|
|
$cache->addProperty('expense-budget');
|
|
$cache->addProperty($accounts->pluck('id')->toArray());
|
|
$cache->addProperty($expense->pluck('id')->toArray());
|
|
if ($cache->has()) {
|
|
return $cache->get(); // @codeCoverageIgnore
|
|
}
|
|
$combined = $this->combineAccounts($expense);
|
|
$all = new Collection;
|
|
foreach ($combined as $combi) {
|
|
$all = $all->merge($combi);
|
|
}
|
|
// now find spent / earned:
|
|
$spent = $this->spentByBudget($accounts, $all, $start, $end);
|
|
// join arrays somehow:
|
|
$together = [];
|
|
foreach ($spent as $categoryId => $spentInfo) {
|
|
if (!isset($together[$categoryId])) {
|
|
$together[$categoryId]['spent'] = $spentInfo;
|
|
$together[$categoryId]['budget'] = $spentInfo['name'];
|
|
$together[$categoryId]['grand_total'] = '0';
|
|
}
|
|
$together[$categoryId]['grand_total'] = bcadd($spentInfo['grand_total'], $together[$categoryId]['grand_total']);
|
|
}
|
|
try {
|
|
$result = view('reports.partials.exp-budgets', compact('together'))->render();
|
|
// @codeCoverageIgnoreStart
|
|
} catch (Throwable $e) {
|
|
Log::error(sprintf('Could not render category::budget: %s', $e->getMessage()));
|
|
$result = sprintf('An error prevented Firefly III from rendering: %s. Apologies.', $e->getMessage());
|
|
}
|
|
// @codeCoverageIgnoreEnd
|
|
$cache->store($result);
|
|
|
|
return $result;
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Generates the overview per category (spent and earned).
|
|
*
|
|
* @param Collection $accounts
|
|
* @param Collection $expense
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
*
|
|
* @return string
|
|
*/
|
|
public function category(Collection $accounts, Collection $expense, Carbon $start, Carbon $end): string
|
|
{
|
|
// Properties for cache:
|
|
$cache = new CacheProperties;
|
|
$cache->addProperty($start);
|
|
$cache->addProperty($end);
|
|
$cache->addProperty('expense-category');
|
|
$cache->addProperty($accounts->pluck('id')->toArray());
|
|
$cache->addProperty($expense->pluck('id')->toArray());
|
|
if ($cache->has()) {
|
|
return $cache->get(); // @codeCoverageIgnore
|
|
}
|
|
$combined = $this->combineAccounts($expense);
|
|
$all = new Collection;
|
|
foreach ($combined as $combi) {
|
|
$all = $all->merge($combi);
|
|
}
|
|
// now find spent / earned:
|
|
$spent = $this->spentByCategory($accounts, $all, $start, $end);
|
|
$earned = $this->earnedByCategory($accounts, $all, $start, $end);
|
|
// join arrays somehow:
|
|
$together = [];
|
|
foreach ($spent as $categoryId => $spentInfo) {
|
|
if (!isset($together[$categoryId])) {
|
|
$together[$categoryId]['spent'] = $spentInfo;
|
|
$together[$categoryId]['category'] = $spentInfo['name'];
|
|
$together[$categoryId]['grand_total'] = '0';
|
|
}
|
|
$together[$categoryId]['grand_total'] = bcadd($spentInfo['grand_total'], $together[$categoryId]['grand_total']);
|
|
}
|
|
foreach ($earned as $categoryId => $earnedInfo) {
|
|
if (!isset($together[$categoryId])) {
|
|
$together[$categoryId]['earned'] = $earnedInfo;
|
|
$together[$categoryId]['category'] = $earnedInfo['name'];
|
|
$together[$categoryId]['grand_total'] = '0';
|
|
}
|
|
$together[$categoryId]['grand_total'] = bcadd($earnedInfo['grand_total'], $together[$categoryId]['grand_total']);
|
|
}
|
|
try {
|
|
$result = view('reports.partials.exp-categories', compact('together'))->render();
|
|
// @codeCoverageIgnoreStart
|
|
} catch (Throwable $e) {
|
|
Log::error(sprintf('Could not render category::expenses: %s', $e->getMessage()));
|
|
$result = sprintf('An error prevented Firefly III from rendering: %s. Apologies.', $e->getMessage());
|
|
}
|
|
// @codeCoverageIgnoreEnd
|
|
$cache->store($result);
|
|
|
|
return $result;
|
|
}
|
|
|
|
|
|
/**
|
|
* Overview of spending.
|
|
*
|
|
* @param Collection $accounts
|
|
* @param Collection $expense
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
*
|
|
* @return array|mixed|string
|
|
*/
|
|
public function spent(Collection $accounts, Collection $expense, Carbon $start, Carbon $end)
|
|
{
|
|
// chart properties for cache:
|
|
$cache = new CacheProperties;
|
|
$cache->addProperty($start);
|
|
$cache->addProperty($end);
|
|
$cache->addProperty('expense-spent');
|
|
$cache->addProperty($accounts->pluck('id')->toArray());
|
|
$cache->addProperty($expense->pluck('id')->toArray());
|
|
if ($cache->has()) {
|
|
return $cache->get(); // @codeCoverageIgnore
|
|
}
|
|
|
|
$combined = $this->combineAccounts($expense);
|
|
$result = [];
|
|
|
|
foreach ($combined as $name => $combi) {
|
|
/**
|
|
* @var string
|
|
* @var Collection $combi
|
|
*/
|
|
$spent = $this->spentInPeriod($accounts, $combi, $start, $end);
|
|
$earned = $this->earnedInPeriod($accounts, $combi, $start, $end);
|
|
$result[$name] = [
|
|
'spent' => $spent,
|
|
'earned' => $earned,
|
|
];
|
|
}
|
|
try {
|
|
$result = view('reports.partials.exp-not-grouped', compact('result'))->render();
|
|
// @codeCoverageIgnoreStart
|
|
} catch (Throwable $e) {
|
|
Log::error(sprintf('Could not render category::expenses: %s', $e->getMessage()));
|
|
$result = sprintf('An error prevented Firefly III from rendering: %s. Apologies.', $e->getMessage());
|
|
}
|
|
// @codeCoverageIgnoreEnd
|
|
$cache->store($result);
|
|
|
|
return $result;
|
|
// for period, get spent and earned for each account (by name)
|
|
}
|
|
|
|
|
|
/**
|
|
* List of top expenses.
|
|
*
|
|
* @param Collection $accounts
|
|
* @param Collection $expense
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
*
|
|
* @return string
|
|
*/
|
|
public function topExpense(Collection $accounts, Collection $expense, Carbon $start, Carbon $end): string
|
|
{
|
|
// Properties for cache:
|
|
$cache = new CacheProperties;
|
|
$cache->addProperty($start);
|
|
$cache->addProperty($end);
|
|
$cache->addProperty('top-expense');
|
|
$cache->addProperty($accounts->pluck('id')->toArray());
|
|
$cache->addProperty($expense->pluck('id')->toArray());
|
|
if ($cache->has()) {
|
|
return $cache->get(); // @codeCoverageIgnore
|
|
}
|
|
$combined = $this->combineAccounts($expense);
|
|
$all = new Collection;
|
|
foreach ($combined as $combi) {
|
|
$all = $all->merge($combi);
|
|
}
|
|
// get all expenses in period:
|
|
/** @var GroupCollectorInterface $collector */
|
|
$collector = app(GroupCollectorInterface::class);
|
|
|
|
$collector->setRange($start, $end)->setTypes([TransactionType::WITHDRAWAL])->setAccounts($accounts);
|
|
$collector->setAccounts($all)->withAccountInformation();
|
|
$sorted = $collector->getExtractedJournals();
|
|
|
|
usort($sorted, function ($a, $b) {
|
|
return $a['amount'] <=> $b['amount']; // @codeCoverageIgnore
|
|
});
|
|
|
|
try {
|
|
$result = view('reports.partials.top-transactions', compact('sorted'))->render();
|
|
// @codeCoverageIgnoreStart
|
|
} catch (Throwable $e) {
|
|
Log::error(sprintf('Could not render category::topExpense: %s', $e->getMessage()));
|
|
$result = sprintf('An error prevented Firefly III from rendering: %s. Apologies.', $e->getMessage());
|
|
}
|
|
// @codeCoverageIgnoreEnd
|
|
$cache->store($result);
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* List of top income.
|
|
*
|
|
* @param Collection $accounts
|
|
* @param Collection $expense
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
*
|
|
* @return mixed|string
|
|
*/
|
|
public function topIncome(Collection $accounts, Collection $expense, Carbon $start, Carbon $end)
|
|
{
|
|
// Properties for cache:
|
|
$cache = new CacheProperties;
|
|
$cache->addProperty($start);
|
|
$cache->addProperty($end);
|
|
$cache->addProperty('top-income');
|
|
$cache->addProperty($accounts->pluck('id')->toArray());
|
|
$cache->addProperty($expense->pluck('id')->toArray());
|
|
if ($cache->has()) {
|
|
return $cache->get(); // @codeCoverageIgnore
|
|
}
|
|
$combined = $this->combineAccounts($expense);
|
|
$all = new Collection;
|
|
foreach ($combined as $combi) {
|
|
$all = $all->merge($combi);
|
|
}
|
|
// get all expenses in period:
|
|
|
|
/** @var GroupCollectorInterface $collector */
|
|
$collector = app(GroupCollectorInterface::class);
|
|
|
|
$total = $accounts->merge($all);
|
|
$collector->setRange($start, $end)->setTypes([TransactionType::DEPOSIT])->setAccounts($total)->withAccountInformation();
|
|
$sorted = $collector->getExtractedJournals();
|
|
|
|
foreach (array_keys($sorted) as $key) {
|
|
$sorted[$key]['amount'] = bcmul($sorted[$key]['amount'], '-1');
|
|
}
|
|
|
|
usort($sorted, function ($a, $b) {
|
|
return $a['amount'] <=> $b['amount']; // @codeCoverageIgnore
|
|
});
|
|
|
|
try {
|
|
$result = view('reports.partials.top-transactions', compact('sorted'))->render();
|
|
// @codeCoverageIgnoreStart
|
|
} catch (Throwable $e) {
|
|
Log::error(sprintf('Could not render category::topIncome: %s', $e->getMessage()));
|
|
$result = sprintf('An error prevented Firefly III from rendering: %s. Apologies.', $e->getMessage());
|
|
}
|
|
// @codeCoverageIgnoreEnd
|
|
$cache->store($result);
|
|
|
|
return $result;
|
|
}
|
|
|
|
|
|
}
|