Build administration-compatible budget chart.

2025-11-02 12:15:55 +00:00 · 2023-08-01 19:38:53 +02:00
parent 5f9f621fa6
commit 0c087f33c2
23 changed files with 785 additions and 59 deletions
--- a/app/Repositories/Administration/Budget/BudgetRepository.php
+++ b/app/Repositories/Administration/Budget/BudgetRepository.php
@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+/*
+ * BudgetRepository.php
+ * Copyright (c) 2023 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/>.
+ */
+
+namespace FireflyIII\Repositories\Administration\Budget;
+
+use FireflyIII\Support\Repositories\Administration\AdministrationTrait;
+use Illuminate\Support\Collection;
+
+/**
+ * Class BudgetRepository
+ */
+class BudgetRepository implements BudgetRepositoryInterface
+{
+    use AdministrationTrait;
+
+    /**
+     * @inheritDoc
+     */
+    public function getActiveBudgets(): Collection
+    {
+        return $this->userGroup->budgets()->where('active', true)
+                               ->orderBy('order', 'ASC')
+                               ->orderBy('name', 'ASC')
+                               ->get();
+    }
+}
--- a/app/Repositories/Administration/Budget/BudgetRepositoryInterface.php
+++ b/app/Repositories/Administration/Budget/BudgetRepositoryInterface.php
@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+/*
+ * BudgetRepositoryInterface.php
+ * Copyright (c) 2023 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/>.
+ */
+
+namespace FireflyIII\Repositories\Administration\Budget;
+
+use Illuminate\Support\Collection;
+
+/**
+ * Interface BudgetRepositoryInterface
+ */
+interface BudgetRepositoryInterface
+{
+    /**
+     * @return Collection
+     */
+    public function getActiveBudgets(): Collection;
+}
--- a/app/Repositories/Administration/Budget/OperationsRepository.php
+++ b/app/Repositories/Administration/Budget/OperationsRepository.php
@@ -0,0 +1,136 @@
+<?php
+
+declare(strict_types=1);
+/*
+ * OperationsRepository.php
+ * Copyright (c) 2023 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/>.
+ */
+
+namespace FireflyIII\Repositories\Administration\Budget;
+
+use Carbon\Carbon;
+use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Helpers\Collector\GroupCollectorInterface;
+use FireflyIII\Models\TransactionType;
+use FireflyIII\Support\Repositories\Administration\AdministrationTrait;
+use Illuminate\Support\Collection;
+
+/**
+ * Class OperationsRepository
+ */
+class OperationsRepository implements OperationsRepositoryInterface
+{
+    use AdministrationTrait;
+
+    /**
+     * @inheritDoc
+     * @throws FireflyException
+     */
+    public function listExpenses(Carbon $start, Carbon $end, ?Collection $accounts = null, ?Collection $budgets = null): array
+    {
+        /** @var GroupCollectorInterface $collector */
+        $collector = app(GroupCollectorInterface::class);
+        $collector->setUserGroup($this->userGroup)->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 budget" 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 budgets:
+            $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'];
+            $final     = [
+                'amount'                          => app('steam')->negative($journal['amount']),
+                'foreign_amount'                  => null,
+                'foreign_currency_id'             => null,
+                'foreign_currency_code'           => null,
+                'foreign_currency_symbol'         => null,
+                'foreign_currency_name'           => null,
+                'foreign_currency_decimal_places' => null,
+                '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'],
+            ];
+            if (null !== $journal['foreign_amount']) {
+                $final['foreign_amount']                  = app('steam')->negative($journal['foreign_amount']);
+                $final['foreign_currency_id']             = $journal['foreign_currency_id'];
+                $final['foreign_currency_code']           = $journal['foreign_currency_code'];
+                $final['foreign_currency_symbol']         = $journal['foreign_currency_symbol'];
+                $final['foreign_currency_name']           = $journal['foreign_currency_name'];
+                $final['foreign_currency_decimal_places'] = $journal['foreign_currency_decimal_places'];
+            }
+
+            $array[$currencyId]['budgets'][$budgetId]['transaction_journals'][$journalId] = $final;
+        }
+
+        return $array;
+    }
+
+    /**
+     * @return Collection
+     * @throws FireflyException
+     */
+    private function getBudgets(): Collection
+    {
+        /** @var BudgetRepositoryInterface $repos */
+        $repos = app(BudgetRepositoryInterface::class);
+        $repos->setAdministrationId($this->getAdministrationId());
+
+        return $repos->getActiveBudgets();
+    }
+}
--- a/app/Repositories/Administration/Budget/OperationsRepositoryInterface.php
+++ b/app/Repositories/Administration/Budget/OperationsRepositoryInterface.php
@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+/*
+ * OperationsRepositoryInterface.php
+ * Copyright (c) 2023 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/>.
+ */
+
+namespace FireflyIII\Repositories\Administration\Budget;
+
+use Carbon\Carbon;
+use Illuminate\Support\Collection;
+
+/**
+ * Interface OperationsRepositoryInterface
+ */
+interface OperationsRepositoryInterface
+{
+    /**
+     * 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;
+}
--- a/app/Repositories/Budget/BudgetRepository.php
+++ b/app/Repositories/Budget/BudgetRepository.php
@@ -798,10 +798,11 @@ class BudgetRepository implements BudgetRepositoryInterface
        try {
            $newBudget = Budget::create(
                [
-                    'user_id' => $this->user->id,
-                    'name'    => $data['name'],
-                    'order'   => $order + 1,
-                    'active'  => array_key_exists('active', $data) ? $data['active'] : true,
+                    '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) {