mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-10-31 02:36:28 +00:00
815 lines
31 KiB
PHP
815 lines
31 KiB
PHP
<?php
|
|
|
|
/**
|
|
* BudgetRepository.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\Enums\AutoBudgetType;
|
|
use FireflyIII\Enums\TransactionTypeEnum;
|
|
use FireflyIII\Exceptions\FireflyException;
|
|
use FireflyIII\Helpers\Collector\GroupCollectorInterface;
|
|
use FireflyIII\Models\Account;
|
|
use FireflyIII\Models\Attachment;
|
|
use FireflyIII\Models\AutoBudget;
|
|
use FireflyIII\Models\Budget;
|
|
use FireflyIII\Models\BudgetLimit;
|
|
use FireflyIII\Models\Note;
|
|
use FireflyIII\Models\RecurrenceTransactionMeta;
|
|
use FireflyIII\Models\RuleAction;
|
|
use FireflyIII\Models\RuleTrigger;
|
|
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
|
|
use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
|
|
use FireflyIII\Services\Internal\Destroy\BudgetDestroyService;
|
|
use FireflyIII\Support\Http\Api\ExchangeRateConverter;
|
|
use FireflyIII\Support\Repositories\UserGroup\UserGroupInterface;
|
|
use FireflyIII\Support\Repositories\UserGroup\UserGroupTrait;
|
|
use Illuminate\Database\QueryException;
|
|
use Illuminate\Support\Collection;
|
|
use Illuminate\Support\Facades\DB;
|
|
use Illuminate\Support\Facades\Log;
|
|
use Illuminate\Support\Facades\Storage;
|
|
|
|
/**
|
|
* Class BudgetRepository.
|
|
*/
|
|
class BudgetRepository implements BudgetRepositoryInterface, UserGroupInterface
|
|
{
|
|
use UserGroupTrait;
|
|
|
|
public function budgetEndsWith(string $query, int $limit): Collection
|
|
{
|
|
$search = $this->user->budgets();
|
|
if ('' !== $query) {
|
|
$search->whereLike('name', sprintf('%%%s', $query));
|
|
}
|
|
$search->orderBy('order', 'ASC')
|
|
->orderBy('name', 'ASC')->where('active', true)
|
|
;
|
|
|
|
return $search->take($limit)->get();
|
|
}
|
|
|
|
public function budgetStartsWith(string $query, int $limit): Collection
|
|
{
|
|
$search = $this->user->budgets();
|
|
if ('' !== $query) {
|
|
$search->whereLike('name', sprintf('%s%%', $query));
|
|
}
|
|
$search->orderBy('order', 'ASC')
|
|
->orderBy('name', 'ASC')->where('active', true)
|
|
;
|
|
|
|
return $search->take($limit)->get();
|
|
}
|
|
|
|
public function budgetedInPeriod(Carbon $start, Carbon $end): array
|
|
{
|
|
app('log')->debug(sprintf('Now in budgetedInPeriod("%s", "%s")', $start->format('Y-m-d'), $end->format('Y-m-d')));
|
|
$return = [];
|
|
|
|
/** @var BudgetLimitRepository $limitRepository */
|
|
$limitRepository = app(BudgetLimitRepository::class);
|
|
$limitRepository->setUser($this->user);
|
|
$budgets = $this->getActiveBudgets();
|
|
$defaultCurrency = app('amount')->getNativeCurrency();
|
|
$converter = new ExchangeRateConverter();
|
|
|
|
/** @var Budget $budget */
|
|
foreach ($budgets as $budget) {
|
|
app('log')->debug(sprintf('Budget #%d: "%s"', $budget->id, $budget->name));
|
|
$limits = $limitRepository->getBudgetLimits($budget, $start, $end);
|
|
|
|
/** @var BudgetLimit $limit */
|
|
foreach ($limits as $limit) {
|
|
app('log')->debug(sprintf('Budget limit #%d', $limit->id));
|
|
$currency = $limit->transactionCurrency;
|
|
$rate = $converter->getCurrencyRate($currency, $defaultCurrency, $end);
|
|
$currencyCode = $currency->code;
|
|
$return[$currencyCode] ??= [
|
|
'currency_id' => (string) $currency->id,
|
|
'currency_name' => $currency->name,
|
|
'currency_symbol' => $currency->symbol,
|
|
'currency_code' => $currency->code,
|
|
'currency_decimal_places' => $currency->decimal_places,
|
|
'native_currency_id' => (string) $defaultCurrency->id,
|
|
'native_currency_name' => $defaultCurrency->name,
|
|
'native_currency_symbol' => $defaultCurrency->symbol,
|
|
'native_currency_code' => $defaultCurrency->code,
|
|
'native_currency_decimal_places' => $defaultCurrency->decimal_places,
|
|
'sum' => '0',
|
|
'native_sum' => '0',
|
|
];
|
|
// same period
|
|
if ($limit->start_date->isSameDay($start) && $limit->end_date->isSameDay($end)) {
|
|
$return[$currencyCode]['sum'] = bcadd($return[$currencyCode]['sum'], $limit->amount);
|
|
$return[$currencyCode]['native_sum'] = bcmul($rate, $return[$currencyCode]['sum']);
|
|
app('log')->debug(sprintf('Add full amount [1]: %s', $limit->amount));
|
|
|
|
continue;
|
|
}
|
|
// limit is inside of date range
|
|
if ($start->lte($limit->start_date) && $end->gte($limit->end_date)) {
|
|
$return[$currencyCode]['sum'] = bcadd($return[$currencyCode]['sum'], $limit->amount);
|
|
$return[$currencyCode]['native_sum'] = bcmul($rate, $return[$currencyCode]['sum']);
|
|
app('log')->debug(sprintf('Add full amount [2]: %s', $limit->amount));
|
|
|
|
continue;
|
|
}
|
|
$total = $limit->start_date->diffInDays($limit->end_date, true) + 1; // include the day itself.
|
|
$days = $this->daysInOverlap($limit, $start, $end);
|
|
$amount = bcmul(bcdiv($limit->amount, (string) $total), (string) $days);
|
|
$return[$currencyCode]['sum'] = bcadd($return[$currencyCode]['sum'], $amount);
|
|
$return[$currencyCode]['native_sum'] = bcmul($rate, $return[$currencyCode]['sum']);
|
|
app('log')->debug(
|
|
sprintf(
|
|
'Amount per day: %s (%s over %d days). Total amount for %d days: %s',
|
|
bcdiv($limit->amount, (string) $total),
|
|
$limit->amount,
|
|
$total,
|
|
$days,
|
|
$amount
|
|
)
|
|
);
|
|
}
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
public function getActiveBudgets(): Collection
|
|
{
|
|
return $this->user->budgets()->where('active', true)
|
|
->orderBy('order', 'ASC')
|
|
->orderBy('name', 'ASC')
|
|
->get()
|
|
;
|
|
}
|
|
|
|
/**
|
|
* How many days of this budget limit are between start and end?
|
|
*/
|
|
private function daysInOverlap(BudgetLimit $limit, Carbon $start, Carbon $end): int
|
|
{
|
|
// start1 = $start
|
|
// start2 = $limit->start_date
|
|
// start1 = $end
|
|
// start2 = $limit->end_date
|
|
|
|
// limit is larger than start and end (inclusive)
|
|
// |-----------|
|
|
// |----------------|
|
|
if ($start->gte($limit->start_date) && $end->lte($limit->end_date)) {
|
|
return (int) $start->diffInDays($end, true) + 1; // add one day
|
|
}
|
|
// limit starts earlier and limit ends first:
|
|
// |-----------|
|
|
// |-------|
|
|
if ($limit->start_date->lte($start) && $limit->end_date->lte($end)) {
|
|
// return days in the range $start-$limit_end
|
|
return (int) $start->diffInDays($limit->end_date, true) + 1; // add one day, the day itself
|
|
}
|
|
// limit starts later and limit ends earlier
|
|
// |-----------|
|
|
// |-------|
|
|
if ($limit->start_date->gte($start) && $limit->end_date->gte($end)) {
|
|
// return days in the range $limit_start - $end
|
|
return (int) $limit->start_date->diffInDays($end, true) + 1; // add one day, the day itself
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
public function budgetedInPeriodForBudget(Budget $budget, Carbon $start, Carbon $end): array
|
|
{
|
|
app('log')->debug(sprintf('Now in budgetedInPeriod(#%d, "%s", "%s")', $budget->id, $start->format('Y-m-d'), $end->format('Y-m-d')));
|
|
$return = [];
|
|
|
|
/** @var BudgetLimitRepository $limitRepository */
|
|
$limitRepository = app(BudgetLimitRepository::class);
|
|
$limitRepository->setUser($this->user);
|
|
|
|
app('log')->debug(sprintf('Budget #%d: "%s"', $budget->id, $budget->name));
|
|
$limits = $limitRepository->getBudgetLimits($budget, $start, $end);
|
|
|
|
/** @var BudgetLimit $limit */
|
|
foreach ($limits as $limit) {
|
|
app('log')->debug(sprintf('Budget limit #%d', $limit->id));
|
|
$currency = $limit->transactionCurrency;
|
|
$return[$currency->id] ??= [
|
|
'id' => (string) $currency->id,
|
|
'name' => $currency->name,
|
|
'symbol' => $currency->symbol,
|
|
'code' => $currency->code,
|
|
'decimal_places' => $currency->decimal_places,
|
|
'sum' => '0',
|
|
];
|
|
// same period
|
|
if ($limit->start_date->isSameDay($start) && $limit->end_date->isSameDay($end)) {
|
|
$return[$currency->id]['sum'] = bcadd($return[$currency->id]['sum'], $limit->amount);
|
|
app('log')->debug(sprintf('Add full amount [1]: %s', $limit->amount));
|
|
|
|
continue;
|
|
}
|
|
// limit is inside of date range
|
|
if ($start->lte($limit->start_date) && $end->gte($limit->end_date)) {
|
|
$return[$currency->id]['sum'] = bcadd($return[$currency->id]['sum'], $limit->amount);
|
|
app('log')->debug(sprintf('Add full amount [2]: %s', $limit->amount));
|
|
|
|
continue;
|
|
}
|
|
$total = $limit->start_date->diffInDays($limit->end_date) + 1; // include the day itself.
|
|
$days = $this->daysInOverlap($limit, $start, $end);
|
|
$amount = bcmul(bcdiv($limit->amount, (string) $total), (string) $days);
|
|
$return[$currency->id]['sum'] = bcadd($return[$currency->id]['sum'], $amount);
|
|
app('log')->debug(
|
|
sprintf(
|
|
'Amount per day: %s (%s over %d days). Total amount for %d days: %s',
|
|
bcdiv($limit->amount, (string) $total),
|
|
$limit->amount,
|
|
$total,
|
|
$days,
|
|
$amount
|
|
)
|
|
);
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
public function cleanupBudgets(): bool
|
|
{
|
|
// delete limits with amount 0:
|
|
BudgetLimit::where('amount', 0)->delete();
|
|
$budgets = $this->getActiveBudgets();
|
|
|
|
/**
|
|
* @var int $index
|
|
* @var Budget $budget
|
|
*/
|
|
foreach ($budgets as $index => $budget) {
|
|
$budget->order = $index + 1;
|
|
$budget->save();
|
|
}
|
|
// other budgets, set to 0.
|
|
$this->user->budgets()->where('active', 0)->update(['order' => 0]);
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @throws FireflyException
|
|
*/
|
|
public function update(Budget $budget, array $data): Budget
|
|
{
|
|
app('log')->debug('Now in update()');
|
|
|
|
$oldName = $budget->name;
|
|
if (array_key_exists('name', $data)) {
|
|
$budget->name = $data['name'];
|
|
$this->updateRuleActions($oldName, $budget->name);
|
|
$this->updateRuleTriggers($oldName, $budget->name);
|
|
}
|
|
if (array_key_exists('active', $data)) {
|
|
$budget->active = $data['active'];
|
|
}
|
|
if (array_key_exists('notes', $data)) {
|
|
$this->setNoteText($budget, (string) $data['notes']);
|
|
}
|
|
$budget->save();
|
|
|
|
// update or create auto-budget:
|
|
$autoBudget = $this->getAutoBudget($budget);
|
|
|
|
// first things first: delete when no longer required:
|
|
$autoBudgetType = array_key_exists('auto_budget_type', $data) ? $data['auto_budget_type'] : null;
|
|
|
|
if (0 === $autoBudgetType && null !== $autoBudget) {
|
|
// delete!
|
|
$autoBudget->delete();
|
|
|
|
return $budget;
|
|
}
|
|
if (0 === $autoBudgetType && null === $autoBudget) {
|
|
return $budget;
|
|
}
|
|
if (null === $autoBudgetType && null === $autoBudget) {
|
|
return $budget;
|
|
}
|
|
$this->updateAutoBudget($budget, $data);
|
|
|
|
return $budget;
|
|
}
|
|
|
|
private function updateRuleActions(string $oldName, string $newName): void
|
|
{
|
|
$types = ['set_budget'];
|
|
$actions = RuleAction::leftJoin('rules', 'rules.id', '=', 'rule_actions.rule_id')
|
|
->where('rules.user_id', $this->user->id)
|
|
->whereIn('rule_actions.action_type', $types)
|
|
->where('rule_actions.action_value', $oldName)
|
|
->get(['rule_actions.*'])
|
|
;
|
|
app('log')->debug(sprintf('Found %d actions to update.', $actions->count()));
|
|
|
|
/** @var RuleAction $action */
|
|
foreach ($actions as $action) {
|
|
$action->action_value = $newName;
|
|
$action->save();
|
|
app('log')->debug(sprintf('Updated action %d: %s', $action->id, $action->action_value));
|
|
}
|
|
}
|
|
|
|
private function updateRuleTriggers(string $oldName, string $newName): void
|
|
{
|
|
$types = ['budget_is'];
|
|
$triggers = RuleTrigger::leftJoin('rules', 'rules.id', '=', 'rule_triggers.rule_id')
|
|
->where('rules.user_id', $this->user->id)
|
|
->whereIn('rule_triggers.trigger_type', $types)
|
|
->where('rule_triggers.trigger_value', $oldName)
|
|
->get(['rule_triggers.*'])
|
|
;
|
|
app('log')->debug(sprintf('Found %d triggers to update.', $triggers->count()));
|
|
|
|
/** @var RuleTrigger $trigger */
|
|
foreach ($triggers as $trigger) {
|
|
$trigger->trigger_value = $newName;
|
|
$trigger->save();
|
|
app('log')->debug(sprintf('Updated trigger %d: %s', $trigger->id, $trigger->trigger_value));
|
|
}
|
|
}
|
|
|
|
private function setNoteText(Budget $budget, string $text): void
|
|
{
|
|
$dbNote = $budget->notes()->first();
|
|
if ('' !== $text) {
|
|
if (null === $dbNote) {
|
|
$dbNote = new Note();
|
|
$dbNote->noteable()->associate($budget);
|
|
}
|
|
$dbNote->text = trim($text);
|
|
$dbNote->save();
|
|
|
|
return;
|
|
}
|
|
if (null !== $dbNote) {
|
|
$dbNote->delete();
|
|
}
|
|
}
|
|
|
|
public function getAutoBudget(Budget $budget): ?AutoBudget
|
|
{
|
|
/** @var null|AutoBudget */
|
|
return $budget->autoBudgets()->first();
|
|
}
|
|
|
|
/**
|
|
* @throws FireflyException
|
|
*/
|
|
private function updateAutoBudget(Budget $budget, array $data): void
|
|
{
|
|
// update or create auto-budget:
|
|
$autoBudget = $this->getAutoBudget($budget);
|
|
|
|
// grab default currency:
|
|
$currency = app('amount')->getNativeCurrencyByUserGroup($this->user->userGroup);
|
|
|
|
if (null === $autoBudget) {
|
|
// at this point it's a blind assumption auto_budget_type is 1 or 2.
|
|
$autoBudget = new AutoBudget();
|
|
$autoBudget->auto_budget_type = $data['auto_budget_type'];
|
|
$autoBudget->budget_id = $budget->id;
|
|
$autoBudget->transaction_currency_id = $currency->id;
|
|
}
|
|
|
|
// set or update the currency.
|
|
if (array_key_exists('currency_id', $data) || array_key_exists('currency_code', $data)) {
|
|
/** @var CurrencyRepositoryInterface $repos */
|
|
$repos = app(CurrencyRepositoryInterface::class);
|
|
$currencyId = (int) ($data['currency_id'] ?? 0);
|
|
$currencyCode = (string) ($data['currency_code'] ?? '');
|
|
$currency = $repos->find($currencyId);
|
|
if (null === $currency) {
|
|
$currency = $repos->findByCode($currencyCode);
|
|
}
|
|
if (null !== $currency) {
|
|
$autoBudget->transaction_currency_id = $currency->id;
|
|
}
|
|
}
|
|
|
|
// change values if submitted or presented:
|
|
if (array_key_exists('auto_budget_type', $data)) {
|
|
$autoBudget->auto_budget_type = $data['auto_budget_type'];
|
|
}
|
|
if (array_key_exists('auto_budget_amount', $data)) {
|
|
$autoBudget->amount = $data['auto_budget_amount'];
|
|
}
|
|
if (array_key_exists('auto_budget_period', $data)) {
|
|
$autoBudget->period = $data['auto_budget_period'];
|
|
}
|
|
|
|
$autoBudget->save();
|
|
}
|
|
|
|
/**
|
|
* Find a budget or return NULL
|
|
*
|
|
* @param null|int $budgetId |null
|
|
*/
|
|
public function find(?int $budgetId = null): ?Budget
|
|
{
|
|
/** @var null|Budget */
|
|
return $this->user->budgets()->find($budgetId);
|
|
}
|
|
|
|
public function destroy(Budget $budget): bool
|
|
{
|
|
/** @var BudgetDestroyService $service */
|
|
$service = app(BudgetDestroyService::class);
|
|
$service->destroy($budget);
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Destroy all budgets.
|
|
*/
|
|
public function destroyAll(): void
|
|
{
|
|
$budgets = $this->getBudgets();
|
|
|
|
/** @var Budget $budget */
|
|
foreach ($budgets as $budget) {
|
|
DB::table('budget_transaction')->where('budget_id', $budget->id)->delete();
|
|
DB::table('budget_transaction_journal')->where('budget_id', $budget->id)->delete();
|
|
RecurrenceTransactionMeta::where('name', 'budget_id')->where('value', (string) $budget->id)->delete();
|
|
RuleAction::where('action_type', 'set_budget')->where('action_value', (string) $budget->id)->delete();
|
|
$budget->delete();
|
|
}
|
|
Log::channel('audit')->info('Delete all budgets through destroyAll');
|
|
}
|
|
|
|
public function getBudgets(): Collection
|
|
{
|
|
return $this->user->budgets()->orderBy('order', 'ASC')
|
|
->orderBy('name', 'ASC')->get()
|
|
;
|
|
}
|
|
|
|
public function destroyAutoBudget(Budget $budget): void
|
|
{
|
|
/** @var AutoBudget $autoBudget */
|
|
foreach ($budget->autoBudgets()->get() as $autoBudget) {
|
|
$autoBudget->delete();
|
|
}
|
|
}
|
|
|
|
public function findBudget(?int $budgetId, ?string $budgetName): ?Budget
|
|
{
|
|
app('log')->debug('Now in findBudget()');
|
|
app('log')->debug(sprintf('Searching for budget with ID #%d...', $budgetId));
|
|
$result = $this->find((int) $budgetId);
|
|
if (null === $result && null !== $budgetName && '' !== $budgetName) {
|
|
app('log')->debug(sprintf('Searching for budget with name %s...', $budgetName));
|
|
$result = $this->findByName($budgetName);
|
|
}
|
|
if (null !== $result) {
|
|
app('log')->debug(sprintf('Found budget #%d: %s', $result->id, $result->name));
|
|
}
|
|
app('log')->debug(sprintf('Found result is null? %s', var_export(null === $result, true)));
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Find budget by name.
|
|
*/
|
|
public function findByName(?string $name): ?Budget
|
|
{
|
|
if (null === $name) {
|
|
return null;
|
|
}
|
|
$query = sprintf('%%%s%%', $name);
|
|
|
|
/** @var null|Budget */
|
|
return $this->user->budgets()->whereLike('name', $query)->first();
|
|
}
|
|
|
|
/**
|
|
* This method returns the oldest journal or transaction date known to this budget.
|
|
* Will cache result.
|
|
*/
|
|
public function firstUseDate(Budget $budget): ?Carbon
|
|
{
|
|
$journal = $budget->transactionJournals()->orderBy('date', 'ASC')->first();
|
|
if (null !== $journal) {
|
|
return $journal->date;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
public function getAttachments(Budget $budget): Collection
|
|
{
|
|
$set = $budget->attachments()->get();
|
|
|
|
$disk = Storage::disk('upload');
|
|
|
|
return $set->each(
|
|
static function (Attachment $attachment) use ($disk) { // @phpstan-ignore-line
|
|
$notes = $attachment->notes()->first();
|
|
$attachment->file_exists = $disk->exists($attachment->fileName());
|
|
$attachment->notes_text = null !== $notes ? $notes->text : '';
|
|
|
|
return $attachment;
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Get all budgets with these ID's.
|
|
*/
|
|
public function getByIds(array $budgetIds): Collection
|
|
{
|
|
return $this->user->budgets()->whereIn('id', $budgetIds)->get();
|
|
}
|
|
|
|
public function getInactiveBudgets(): Collection
|
|
{
|
|
return $this->user->budgets()
|
|
->orderBy('order', 'ASC')
|
|
->orderBy('name', 'ASC')->where('active', 0)->get()
|
|
;
|
|
}
|
|
|
|
public function getNoteText(Budget $budget): ?string
|
|
{
|
|
$note = $budget->notes()->first();
|
|
if (null === $note) {
|
|
return null;
|
|
}
|
|
|
|
return $note->text;
|
|
}
|
|
|
|
public function searchBudget(string $query, int $limit): Collection
|
|
{
|
|
$search = $this->user->budgets();
|
|
if ('' !== $query) {
|
|
$search->whereLike('name', sprintf('%%%s%%', $query));
|
|
}
|
|
$search->orderBy('order', 'ASC')
|
|
->orderBy('name', 'ASC')->where('active', true)
|
|
;
|
|
|
|
return $search->take($limit)->get();
|
|
}
|
|
|
|
public function setBudgetOrder(Budget $budget, int $order): void
|
|
{
|
|
$budget->order = $order;
|
|
$budget->save();
|
|
}
|
|
|
|
public function spentInPeriod(Carbon $start, Carbon $end): array
|
|
{
|
|
app('log')->debug(sprintf('Now in %s', __METHOD__));
|
|
$start->startOfDay();
|
|
$end->endOfDay();
|
|
|
|
// exclude specific liabilities
|
|
$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);
|
|
}
|
|
}
|
|
|
|
// start collecting:
|
|
/** @var GroupCollectorInterface $collector */
|
|
$collector = app(GroupCollectorInterface::class);
|
|
$collector->setUser($this->user)
|
|
->setRange($start, $end)
|
|
->excludeDestinationAccounts($selection)
|
|
->setTypes([TransactionTypeEnum::WITHDRAWAL->value])
|
|
->setBudgets($this->getActiveBudgets())
|
|
;
|
|
|
|
$journals = $collector->getExtractedJournals();
|
|
$array = [];
|
|
|
|
foreach ($journals as $journal) {
|
|
$currencyId = (int) $journal['currency_id'];
|
|
$array[$currencyId] ??= [
|
|
'id' => (string) $currencyId,
|
|
'name' => $journal['currency_name'],
|
|
'symbol' => $journal['currency_symbol'],
|
|
'code' => $journal['currency_code'],
|
|
'decimal_places' => $journal['currency_decimal_places'],
|
|
'sum' => '0',
|
|
];
|
|
$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] ??= [
|
|
'id' => (string) $foreignId,
|
|
'name' => $journal['foreign_currency_name'],
|
|
'symbol' => $journal['foreign_currency_symbol'],
|
|
'code' => $journal['foreign_currency_code'],
|
|
'decimal_places' => $journal['foreign_currency_decimal_places'],
|
|
'sum' => '0',
|
|
];
|
|
$array[$foreignId]['sum'] = bcadd($array[$foreignId]['sum'], app('steam')->negative($journal['foreign_amount']));
|
|
}
|
|
}
|
|
|
|
return $array;
|
|
}
|
|
|
|
public function spentInPeriodForBudget(Budget $budget, Carbon $start, Carbon $end): array
|
|
{
|
|
app('log')->debug(sprintf('Now in %s', __METHOD__));
|
|
$start->startOfDay();
|
|
$end->endOfDay();
|
|
|
|
// exclude specific liabilities
|
|
$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);
|
|
}
|
|
}
|
|
|
|
// start collecting:
|
|
/** @var GroupCollectorInterface $collector */
|
|
$collector = app(GroupCollectorInterface::class);
|
|
$collector->setUser($this->user)
|
|
->setRange($start, $end)
|
|
->excludeDestinationAccounts($selection)
|
|
->setTypes([TransactionTypeEnum::WITHDRAWAL->value])
|
|
->setBudget($budget)
|
|
;
|
|
|
|
$journals = $collector->getExtractedJournals();
|
|
$array = [];
|
|
|
|
foreach ($journals as $journal) {
|
|
$currencyId = (int) $journal['currency_id'];
|
|
$array[$currencyId] ??= [
|
|
'id' => (string) $currencyId,
|
|
'name' => $journal['currency_name'],
|
|
'symbol' => $journal['currency_symbol'],
|
|
'code' => $journal['currency_code'],
|
|
'decimal_places' => $journal['currency_decimal_places'],
|
|
'sum' => '0',
|
|
];
|
|
$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] ??= [
|
|
'id' => (string) $foreignId,
|
|
'name' => $journal['foreign_currency_name'],
|
|
'symbol' => $journal['foreign_currency_symbol'],
|
|
'code' => $journal['foreign_currency_code'],
|
|
'decimal_places' => $journal['foreign_currency_decimal_places'],
|
|
'sum' => '0',
|
|
];
|
|
$array[$foreignId]['sum'] = bcadd($array[$foreignId]['sum'], app('steam')->negative($journal['foreign_amount']));
|
|
}
|
|
}
|
|
|
|
return $array;
|
|
}
|
|
|
|
/**
|
|
* @throws FireflyException
|
|
*
|
|
* @SuppressWarnings("PHPMD.NPathComplexity")
|
|
*/
|
|
public function store(array $data): Budget
|
|
{
|
|
$order = $this->getMaxOrder();
|
|
|
|
try {
|
|
$newBudget = Budget::create(
|
|
[
|
|
'user_id' => $this->user->id,
|
|
'user_group_id' => $this->user->user_group_id,
|
|
'name' => $data['name'],
|
|
'order' => $order + 1,
|
|
'active' => array_key_exists('active', $data) ? $data['active'] : true,
|
|
]
|
|
);
|
|
} catch (QueryException $e) {
|
|
app('log')->error($e->getMessage());
|
|
app('log')->error($e->getTraceAsString());
|
|
|
|
throw new FireflyException('400002: Could not store budget.', 0, $e);
|
|
}
|
|
|
|
// set notes
|
|
if (array_key_exists('notes', $data)) {
|
|
$this->setNoteText($newBudget, (string) $data['notes']);
|
|
}
|
|
|
|
if (!array_key_exists('auto_budget_type', $data) || !array_key_exists('auto_budget_amount', $data) || !array_key_exists('auto_budget_period', $data)) {
|
|
return $newBudget;
|
|
}
|
|
$type = $data['auto_budget_type'];
|
|
if ('none' === $type) {
|
|
return $newBudget;
|
|
}
|
|
if (0 === $type) {
|
|
return $newBudget;
|
|
}
|
|
|
|
if ('reset' === $type) {
|
|
$type = AutoBudgetType::AUTO_BUDGET_RESET->value;
|
|
}
|
|
if ('rollover' === $type) {
|
|
$type = AutoBudgetType::AUTO_BUDGET_ROLLOVER->value;
|
|
}
|
|
if ('adjusted' === $type) {
|
|
$type = AutoBudgetType::AUTO_BUDGET_ADJUSTED->value;
|
|
}
|
|
|
|
/** @var CurrencyRepositoryInterface $repos */
|
|
$repos = app(CurrencyRepositoryInterface::class);
|
|
$currency = null;
|
|
if (array_key_exists('currency_id', $data)) {
|
|
$currency = $repos->find((int) $data['currency_id']);
|
|
}
|
|
if (array_key_exists('currency_code', $data)) {
|
|
$currency = $repos->findByCode((string) $data['currency_code']);
|
|
}
|
|
if (null === $currency) {
|
|
$currency = app('amount')->getNativeCurrencyByUserGroup($this->user->userGroup);
|
|
}
|
|
|
|
$autoBudget = new AutoBudget();
|
|
$autoBudget->budget()->associate($newBudget);
|
|
$autoBudget->transaction_currency_id = $currency->id;
|
|
$autoBudget->auto_budget_type = $type;
|
|
$autoBudget->amount = $data['auto_budget_amount'] ?? '1';
|
|
$autoBudget->period = $data['auto_budget_period'] ?? 'monthly';
|
|
$autoBudget->save();
|
|
|
|
// create initial budget limit.
|
|
$today = today(config('app.timezone'));
|
|
$start = app('navigation')->startOfPeriod($today, $autoBudget->period);
|
|
$end = app('navigation')->endOfPeriod($start, $autoBudget->period);
|
|
|
|
$limitRepos = app(BudgetLimitRepositoryInterface::class);
|
|
$limitRepos->setUser($this->user);
|
|
$limitRepos->store(
|
|
[
|
|
'budget_id' => $newBudget->id,
|
|
'currency_id' => $autoBudget->transaction_currency_id,
|
|
'start_date' => $start,
|
|
'end_date' => $end,
|
|
'amount' => $autoBudget->amount,
|
|
]
|
|
);
|
|
|
|
return $newBudget;
|
|
}
|
|
|
|
public function getMaxOrder(): int
|
|
{
|
|
return (int) $this->user->budgets()->max('order');
|
|
}
|
|
}
|