mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2024-12-01 13:09:35 -06:00
345 lines
14 KiB
PHP
345 lines
14 KiB
PHP
<?php
|
|
/**
|
|
* OperationsRepository.php
|
|
* Copyright (c) 2019 james@firefly-iii.org
|
|
*
|
|
* 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\Repositories\Budget;
|
|
|
|
use Carbon\Carbon;
|
|
use FireflyIII\Helpers\Collector\GroupCollectorInterface;
|
|
use FireflyIII\Models\Account;
|
|
use FireflyIII\Models\Budget;
|
|
use FireflyIII\Models\TransactionCurrency;
|
|
use FireflyIII\Models\TransactionType;
|
|
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
|
|
use FireflyIII\User;
|
|
use Illuminate\Contracts\Auth\Authenticatable;
|
|
use Illuminate\Support\Collection;
|
|
|
|
/**
|
|
*
|
|
* Class OperationsRepository
|
|
*/
|
|
class OperationsRepository implements OperationsRepositoryInterface
|
|
{
|
|
private User $user;
|
|
|
|
/**
|
|
* A method that returns the amount of money budgeted per day for this budget,
|
|
* on average.
|
|
*
|
|
* @param Budget $budget
|
|
*
|
|
* @return string
|
|
*/
|
|
public function budgetedPerDay(Budget $budget): string
|
|
{
|
|
app('log')->debug(sprintf('Now with budget #%d "%s"', $budget->id, $budget->name));
|
|
$total = '0';
|
|
$count = 0;
|
|
foreach ($budget->budgetlimits as $limit) {
|
|
$diff = $limit->start_date->diffInDays($limit->end_date);
|
|
$diff = 0 === $diff ? 1 : $diff;
|
|
$amount = $limit->amount;
|
|
$perDay = bcdiv($amount, (string)$diff);
|
|
$total = bcadd($total, $perDay);
|
|
$count++;
|
|
app('log')->debug(sprintf('Found %d budget limits. Per day is %s, total is %s', $count, $perDay, $total));
|
|
}
|
|
$avg = $total;
|
|
if ($count > 0) {
|
|
$avg = bcdiv($total, (string)$count);
|
|
}
|
|
app('log')->debug(sprintf('%s / %d = %s = average.', $total, $count, $avg));
|
|
|
|
return $avg;
|
|
}
|
|
|
|
/**
|
|
* This method is being used to generate the budget overview in the year/multi-year report. Its used
|
|
* in both the year/multi-year budget overview AND in the accompanying chart.
|
|
*
|
|
* @param Collection $budgets
|
|
* @param Collection $accounts
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
*
|
|
* @return array
|
|
* @deprecated
|
|
*/
|
|
public function getBudgetPeriodReport(Collection $budgets, Collection $accounts, Carbon $start, Carbon $end): array
|
|
{
|
|
$carbonFormat = app('navigation')->preferredCarbonFormat($start, $end);
|
|
$data = [];
|
|
// get all transactions:
|
|
/** @var GroupCollectorInterface $collector */
|
|
$collector = app(GroupCollectorInterface::class);
|
|
$collector->setAccounts($accounts)->setRange($start, $end);
|
|
$collector->setBudgets($budgets);
|
|
$journals = $collector->getExtractedJournals();
|
|
|
|
// loop transactions:
|
|
/** @var array $journal */
|
|
foreach ($journals as $journal) {
|
|
// prep data array for currency:
|
|
$budgetId = (int)$journal['budget_id'];
|
|
$budgetName = $journal['budget_name'];
|
|
$currencyId = (int)$journal['currency_id'];
|
|
$key = sprintf('%d-%d', $budgetId, $currencyId);
|
|
|
|
$data[$key] = $data[$key] ?? [
|
|
'id' => $budgetId,
|
|
'name' => sprintf('%s (%s)', $budgetName, $journal['currency_name']),
|
|
'sum' => '0',
|
|
'currency_id' => $currencyId,
|
|
'currency_code' => $journal['currency_code'],
|
|
'currency_name' => $journal['currency_name'],
|
|
'currency_symbol' => $journal['currency_symbol'],
|
|
'currency_decimal_places' => $journal['currency_decimal_places'],
|
|
'entries' => [],
|
|
];
|
|
$date = $journal['date']->format($carbonFormat);
|
|
$data[$key]['entries'][$date] = bcadd($data[$key]['entries'][$date] ?? '0', $journal['amount']);
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* This method returns a list of all the withdrawal transaction journals (as arrays) set in that period
|
|
* which have the specified budget set to them. It's grouped per currency, with as few details in the array
|
|
* as possible. Amounts are always negative.
|
|
*
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
* @param Collection|null $accounts
|
|
* @param Collection|null $budgets
|
|
*
|
|
* @return array
|
|
*/
|
|
public function listExpenses(Carbon $start, Carbon $end, ?Collection $accounts = null, ?Collection $budgets = null): array
|
|
{
|
|
/** @var GroupCollectorInterface $collector */
|
|
$collector = app(GroupCollectorInterface::class);
|
|
$collector->setUser($this->user)->setRange($start, $end)->setTypes([TransactionType::WITHDRAWAL]);
|
|
if (null !== $accounts && $accounts->count() > 0) {
|
|
$collector->setAccounts($accounts);
|
|
}
|
|
if (null !== $budgets && $budgets->count() > 0) {
|
|
$collector->setBudgets($budgets);
|
|
}
|
|
if (null === $budgets || 0 === $budgets->count()) {
|
|
$collector->setBudgets($this->getBudgets());
|
|
}
|
|
$collector->withBudgetInformation()->withAccountInformation()->withCategoryInformation();
|
|
$journals = $collector->getExtractedJournals();
|
|
$array = [];
|
|
|
|
foreach ($journals as $journal) {
|
|
$currencyId = (int)$journal['currency_id'];
|
|
$budgetId = (int)$journal['budget_id'];
|
|
$budgetName = (string)$journal['budget_name'];
|
|
|
|
// catch "no category" entries.
|
|
if (0 === $budgetId) {
|
|
continue;
|
|
}
|
|
|
|
// info about the currency:
|
|
$array[$currencyId] = $array[$currencyId] ?? [
|
|
'budgets' => [],
|
|
'currency_id' => $currencyId,
|
|
'currency_name' => $journal['currency_name'],
|
|
'currency_symbol' => $journal['currency_symbol'],
|
|
'currency_code' => $journal['currency_code'],
|
|
'currency_decimal_places' => $journal['currency_decimal_places'],
|
|
];
|
|
|
|
// info about the categories:
|
|
$array[$currencyId]['budgets'][$budgetId] = $array[$currencyId]['budgets'][$budgetId] ?? [
|
|
'id' => $budgetId,
|
|
'name' => $budgetName,
|
|
'transaction_journals' => [],
|
|
];
|
|
|
|
// add journal to array:
|
|
// only a subset of the fields.
|
|
$journalId = (int)$journal['transaction_journal_id'];
|
|
$array[$currencyId]['budgets'][$budgetId]['transaction_journals'][$journalId] = [
|
|
'amount' => app('steam')->negative($journal['amount']),
|
|
'destination_account_id' => $journal['destination_account_id'],
|
|
'destination_account_name' => $journal['destination_account_name'],
|
|
'source_account_id' => $journal['source_account_id'],
|
|
'source_account_name' => $journal['source_account_name'],
|
|
'category_name' => $journal['category_name'],
|
|
'description' => $journal['description'],
|
|
'transaction_group_id' => $journal['transaction_group_id'],
|
|
'date' => $journal['date'],
|
|
];
|
|
}
|
|
|
|
return $array;
|
|
}
|
|
|
|
/**
|
|
* @param User|Authenticatable|null $user
|
|
*/
|
|
public function setUser(User | Authenticatable | null $user): void
|
|
{
|
|
if ($user instanceof User) {
|
|
$this->user = $user;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return Collection
|
|
*/
|
|
private function getBudgets(): Collection
|
|
{
|
|
/** @var BudgetRepositoryInterface $repos */
|
|
$repos = app(BudgetRepositoryInterface::class);
|
|
|
|
return $repos->getActiveBudgets();
|
|
}
|
|
|
|
/**
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
* @param Collection|null $accounts
|
|
* @param Collection|null $budgets
|
|
* @param TransactionCurrency|null $currency
|
|
*
|
|
* @return array
|
|
*/
|
|
public function sumExpenses(
|
|
Carbon $start,
|
|
Carbon $end,
|
|
?Collection $accounts = null,
|
|
?Collection $budgets = null,
|
|
?TransactionCurrency $currency = null
|
|
): array {
|
|
//app('log')->debug(sprintf('Now in %s', __METHOD__));
|
|
$start->startOfDay();
|
|
$end->endOfDay();
|
|
|
|
// this collector excludes all transfers TO
|
|
// liabilities (which are also withdrawals)
|
|
// because those expenses only become expenses
|
|
// once they move from the liability to the friend.
|
|
// TODO this filter must be somewhere in AccountRepositoryInterface because I suspect its needed more often (A113)
|
|
$repository = app(AccountRepositoryInterface::class);
|
|
$repository->setUser($this->user);
|
|
$subset = $repository->getAccountsByType(config('firefly.valid_liabilities'));
|
|
$selection = new Collection();
|
|
/** @var Account $account */
|
|
foreach ($subset as $account) {
|
|
if ('credit' === $repository->getMetaValue($account, 'liability_direction')) {
|
|
$selection->push($account);
|
|
}
|
|
}
|
|
|
|
|
|
/** @var GroupCollectorInterface $collector */
|
|
$collector = app(GroupCollectorInterface::class);
|
|
$collector->setUser($this->user)
|
|
->setRange($start, $end)
|
|
->excludeDestinationAccounts($selection)
|
|
->setTypes([TransactionType::WITHDRAWAL]);
|
|
|
|
if (null !== $accounts) {
|
|
$collector->setAccounts($accounts);
|
|
}
|
|
if (null === $budgets) {
|
|
$budgets = $this->getBudgets();
|
|
}
|
|
if (null !== $currency) {
|
|
$collector->setCurrency($currency);
|
|
}
|
|
$collector->setBudgets($budgets);
|
|
$journals = $collector->getExtractedJournals();
|
|
|
|
// same but for foreign currencies:
|
|
if (null !== $currency) {
|
|
//app('log')->debug(sprintf('Currency is "%s".', $currency->name));
|
|
/** @var GroupCollectorInterface $collector */
|
|
$collector = app(GroupCollectorInterface::class);
|
|
$collector->setUser($this->user)->setRange($start, $end)->setTypes([TransactionType::WITHDRAWAL])
|
|
->setForeignCurrency($currency)->setBudgets($budgets);
|
|
|
|
if (null !== $accounts) {
|
|
$collector->setAccounts($accounts);
|
|
}
|
|
$result = $collector->getExtractedJournals();
|
|
//app('log')->debug(sprintf('Found %d journals with currency %s.', count($result), $currency->code));
|
|
// do not use array_merge because you want keys to overwrite (otherwise you get double results):
|
|
$journals = $result + $journals;
|
|
}
|
|
$array = [];
|
|
|
|
foreach ($journals as $journal) {
|
|
$currencyId = (int)$journal['currency_id'];
|
|
$array[$currencyId] = $array[$currencyId] ?? [
|
|
'sum' => '0',
|
|
'currency_id' => $currencyId,
|
|
'currency_name' => $journal['currency_name'],
|
|
'currency_symbol' => $journal['currency_symbol'],
|
|
'currency_code' => $journal['currency_code'],
|
|
'currency_decimal_places' => $journal['currency_decimal_places'],
|
|
];
|
|
$array[$currencyId]['sum'] = bcadd($array[$currencyId]['sum'], app('steam')->negative($journal['amount']));
|
|
|
|
// also do foreign amount:
|
|
$foreignId = (int)$journal['foreign_currency_id'];
|
|
if (0 !== $foreignId) {
|
|
$array[$foreignId] = $array[$foreignId] ?? [
|
|
'sum' => '0',
|
|
'currency_id' => $foreignId,
|
|
'currency_name' => $journal['foreign_currency_name'],
|
|
'currency_symbol' => $journal['foreign_currency_symbol'],
|
|
'currency_code' => $journal['foreign_currency_code'],
|
|
'currency_decimal_places' => $journal['foreign_currency_decimal_places'],
|
|
];
|
|
$array[$foreignId]['sum'] = bcadd($array[$foreignId]['sum'], app('steam')->negative($journal['foreign_amount']));
|
|
}
|
|
}
|
|
|
|
return $array;
|
|
}
|
|
|
|
/**
|
|
* For now, simply refer to whichever repository holds this function.
|
|
* TODO perhaps better in the future.
|
|
*
|
|
* @param Budget $budget
|
|
* @param Carbon|null $start
|
|
* @param Carbon|null $end
|
|
*
|
|
* @return Collection
|
|
*/
|
|
private function getBudgetLimits(Budget $budget, Carbon $start = null, Carbon $end = null): Collection
|
|
{
|
|
/** @var BudgetLimitRepositoryInterface $blRepository */
|
|
$blRepository = app(BudgetLimitRepositoryInterface::class);
|
|
|
|
return $blRepository->getBudgetLimits($budget, $start, $end);
|
|
}
|
|
}
|