mirror of
				https://github.com/firefly-iii/firefly-iii.git
				synced 2025-10-30 06:50:49 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			640 lines
		
	
	
		
			23 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
			
		
		
	
	
			640 lines
		
	
	
		
			23 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
| <?php
 | |
| /**
 | |
|  * BudgetController.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\Chart;
 | |
| 
 | |
| use Carbon\Carbon;
 | |
| use FireflyIII\Exceptions\FireflyException;
 | |
| use FireflyIII\Generator\Chart\Basic\GeneratorInterface;
 | |
| use FireflyIII\Helpers\Collector\JournalCollectorInterface;
 | |
| use FireflyIII\Http\Controllers\Controller;
 | |
| use FireflyIII\Models\AccountType;
 | |
| use FireflyIII\Models\Budget;
 | |
| use FireflyIII\Models\BudgetLimit;
 | |
| use FireflyIII\Models\Transaction;
 | |
| use FireflyIII\Models\TransactionType;
 | |
| use FireflyIII\Repositories\Account\AccountRepositoryInterface;
 | |
| use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
 | |
| use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
 | |
| use FireflyIII\Support\CacheProperties;
 | |
| use Illuminate\Support\Collection;
 | |
| use Response;
 | |
| use Steam;
 | |
| 
 | |
| /**
 | |
|  * Class BudgetController.
 | |
|  *
 | |
|  * @SuppressWarnings(PHPMD.CouplingBetweenObjects) // can't realy be helped.
 | |
|  */
 | |
| class BudgetController extends Controller
 | |
| {
 | |
|     /** @var GeneratorInterface */
 | |
|     protected $generator;
 | |
| 
 | |
|     /** @var BudgetRepositoryInterface */
 | |
|     protected $repository;
 | |
| 
 | |
|     /**
 | |
|      * BudgetController constructor.
 | |
|      */
 | |
|     public function __construct()
 | |
|     {
 | |
|         parent::__construct();
 | |
| 
 | |
|         $this->middleware(
 | |
|             function ($request, $next) {
 | |
|                 $this->generator  = app(GeneratorInterface::class);
 | |
|                 $this->repository = app(BudgetRepositoryInterface::class);
 | |
| 
 | |
|                 return $next($request);
 | |
|             }
 | |
|         );
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @param Budget $budget
 | |
|      *
 | |
|      * @return \Symfony\Component\HttpFoundation\Response
 | |
|      */
 | |
|     public function budget(Budget $budget)
 | |
|     {
 | |
|         $start = $this->repository->firstUseDate($budget);
 | |
|         $end   = session('end', new Carbon);
 | |
|         $cache = new CacheProperties();
 | |
|         $cache->addProperty($start);
 | |
|         $cache->addProperty($end);
 | |
|         $cache->addProperty('chart.budget.budget');
 | |
|         $cache->addProperty($budget->id);
 | |
| 
 | |
|         if ($cache->has()) {
 | |
|             return Response::json($cache->get()); // @codeCoverageIgnore
 | |
|         }
 | |
| 
 | |
|         // depending on diff, do something with range of chart.
 | |
|         $step   = '1D';
 | |
|         $months = $start->diffInMonths($end);
 | |
|         if ($months > 3) {
 | |
|             $step = '1W';
 | |
|         }
 | |
|         if ($months > 24) {
 | |
|             $step = '1M';
 | |
|         }
 | |
|         if ($months > 60) {
 | |
|             $step = '1Y'; // @codeCoverageIgnore
 | |
|         }
 | |
|         $budgetCollection = new Collection([$budget]);
 | |
|         $chartData        = [];
 | |
|         $current          = clone $start;
 | |
|         $current          = app('navigation')->startOfPeriod($current, $step);
 | |
| 
 | |
|         while ($end >= $current) {
 | |
|             $currentEnd = app('navigation')->endOfPeriod($current, $step);
 | |
|             if ($step === '1Y') {
 | |
|                 $currentEnd->subDay(); // @codeCoverageIgnore
 | |
|             }
 | |
|             $spent             = $this->repository->spentInPeriod($budgetCollection, new Collection, $current, $currentEnd);
 | |
|             $label             = app('navigation')->periodShow($current, $step);
 | |
|             $chartData[$label] = floatval(bcmul($spent, '-1'));
 | |
|             $current           = clone $currentEnd;
 | |
|             $current->addDay();
 | |
|         }
 | |
| 
 | |
|         $data = $this->generator->singleSet(strval(trans('firefly.spent')), $chartData);
 | |
| 
 | |
|         $cache->store($data);
 | |
| 
 | |
|         return Response::json($data);
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * Shows the amount left in a specific budget limit.
 | |
|      *
 | |
|      * @SuppressWarnings(PHPMD.CyclomaticComplexity) // it's exactly five.
 | |
|      *
 | |
|      * @param Budget      $budget
 | |
|      * @param BudgetLimit $budgetLimit
 | |
|      *
 | |
|      * @return \Symfony\Component\HttpFoundation\Response
 | |
|      *
 | |
|      * @throws FireflyException
 | |
|      */
 | |
|     public function budgetLimit(Budget $budget, BudgetLimit $budgetLimit)
 | |
|     {
 | |
|         if ($budgetLimit->budget->id !== $budget->id) {
 | |
|             throw new FireflyException('This budget limit is not part of this budget.');
 | |
|         }
 | |
| 
 | |
|         $start = clone $budgetLimit->start_date;
 | |
|         $end   = clone $budgetLimit->end_date;
 | |
|         $cache = new CacheProperties();
 | |
|         $cache->addProperty($start);
 | |
|         $cache->addProperty($end);
 | |
|         $cache->addProperty('chart.budget.budget.limit');
 | |
|         $cache->addProperty($budgetLimit->id);
 | |
|         $cache->addProperty($budget->id);
 | |
| 
 | |
|         if ($cache->has()) {
 | |
|             return Response::json($cache->get()); // @codeCoverageIgnore
 | |
|         }
 | |
| 
 | |
|         $entries          = [];
 | |
|         $amount           = $budgetLimit->amount;
 | |
|         $budgetCollection = new Collection([$budget]);
 | |
|         while ($start <= $end) {
 | |
|             $spent            = $this->repository->spentInPeriod($budgetCollection, new Collection, $start, $start);
 | |
|             $amount           = bcadd($amount, $spent);
 | |
|             $format           = $start->formatLocalized(strval(trans('config.month_and_day')));
 | |
|             $entries[$format] = $amount;
 | |
| 
 | |
|             $start->addDay();
 | |
|         }
 | |
|         $data = $this->generator->singleSet(strval(trans('firefly.left')), $entries);
 | |
|         $cache->store($data);
 | |
| 
 | |
|         return Response::json($data);
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @param Budget           $budget
 | |
|      * @param BudgetLimit|null $budgetLimit
 | |
|      *
 | |
|      * @return \Illuminate\Http\JsonResponse
 | |
|      */
 | |
|     public function expenseAsset(Budget $budget, ?BudgetLimit $budgetLimit)
 | |
|     {
 | |
|         $cache = new CacheProperties;
 | |
|         $cache->addProperty($budget->id);
 | |
|         $cache->addProperty($budgetLimit->id ?? 0);
 | |
|         $cache->addProperty('chart.budget.expense-asset');
 | |
|         if ($cache->has()) {
 | |
|             return Response::json($cache->get()); // @codeCoverageIgnore
 | |
|         }
 | |
| 
 | |
|         /** @var JournalCollectorInterface $collector */
 | |
|         $collector = app(JournalCollectorInterface::class);
 | |
|         $collector->setAllAssetAccounts()->setBudget($budget);
 | |
|         if (null !== $budgetLimit->id) {
 | |
|             $collector->setRange($budgetLimit->start_date, $budgetLimit->end_date);
 | |
|         }
 | |
| 
 | |
|         $transactions = $collector->getJournals();
 | |
|         $result       = [];
 | |
|         $chartData    = [];
 | |
|         /** @var Transaction $transaction */
 | |
|         foreach ($transactions as $transaction) {
 | |
|             $assetId          = intval($transaction->account_id);
 | |
|             $result[$assetId] = $result[$assetId] ?? '0';
 | |
|             $result[$assetId] = bcadd($transaction->transaction_amount, $result[$assetId]);
 | |
|         }
 | |
| 
 | |
|         $names = $this->getAccountNames(array_keys($result));
 | |
|         foreach ($result as $assetId => $amount) {
 | |
|             $chartData[$names[$assetId]] = $amount;
 | |
|         }
 | |
| 
 | |
|         $data = $this->generator->pieChart($chartData);
 | |
|         $cache->store($data);
 | |
| 
 | |
|         return Response::json($data);
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @param Budget           $budget
 | |
|      * @param BudgetLimit|null $budgetLimit
 | |
|      *
 | |
|      * @return \Illuminate\Http\JsonResponse
 | |
|      */
 | |
|     public function expenseCategory(Budget $budget, ?BudgetLimit $budgetLimit)
 | |
|     {
 | |
|         $cache = new CacheProperties;
 | |
|         $cache->addProperty($budget->id);
 | |
|         $cache->addProperty($budgetLimit->id ?? 0);
 | |
|         $cache->addProperty('chart.budget.expense-category');
 | |
|         if ($cache->has()) {
 | |
|             return Response::json($cache->get()); // @codeCoverageIgnore
 | |
|         }
 | |
| 
 | |
|         /** @var JournalCollectorInterface $collector */
 | |
|         $collector = app(JournalCollectorInterface::class);
 | |
|         $collector->setAllAssetAccounts()->setBudget($budget)->withCategoryInformation();
 | |
|         if (null !== $budgetLimit->id) {
 | |
|             $collector->setRange($budgetLimit->start_date, $budgetLimit->end_date);
 | |
|         }
 | |
| 
 | |
|         $transactions = $collector->getJournals();
 | |
|         $result       = [];
 | |
|         $chartData    = [];
 | |
|         /** @var Transaction $transaction */
 | |
|         foreach ($transactions as $transaction) {
 | |
|             $jrnlCatId           = intval($transaction->transaction_journal_category_id);
 | |
|             $transCatId          = intval($transaction->transaction_category_id);
 | |
|             $categoryId          = max($jrnlCatId, $transCatId);
 | |
|             $result[$categoryId] = $result[$categoryId] ?? '0';
 | |
|             $result[$categoryId] = bcadd($transaction->transaction_amount, $result[$categoryId]);
 | |
|         }
 | |
| 
 | |
|         $names = $this->getCategoryNames(array_keys($result));
 | |
|         foreach ($result as $categoryId => $amount) {
 | |
|             $chartData[$names[$categoryId]] = $amount;
 | |
|         }
 | |
| 
 | |
|         $data = $this->generator->pieChart($chartData);
 | |
|         $cache->store($data);
 | |
| 
 | |
|         return Response::json($data);
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @param Budget           $budget
 | |
|      * @param BudgetLimit|null $budgetLimit
 | |
|      *
 | |
|      * @return \Illuminate\Http\JsonResponse
 | |
|      */
 | |
|     public function expenseExpense(Budget $budget, ?BudgetLimit $budgetLimit)
 | |
|     {
 | |
|         $cache = new CacheProperties;
 | |
|         $cache->addProperty($budget->id);
 | |
|         $cache->addProperty($budgetLimit->id ?? 0);
 | |
|         $cache->addProperty('chart.budget.expense-expense');
 | |
|         if ($cache->has()) {
 | |
|             return Response::json($cache->get()); // @codeCoverageIgnore
 | |
|         }
 | |
| 
 | |
|         /** @var JournalCollectorInterface $collector */
 | |
|         $collector = app(JournalCollectorInterface::class);
 | |
|         $collector->setAllAssetAccounts()->setTypes([TransactionType::WITHDRAWAL])->setBudget($budget)->withOpposingAccount();
 | |
|         if (null !== $budgetLimit->id) {
 | |
|             $collector->setRange($budgetLimit->start_date, $budgetLimit->end_date);
 | |
|         }
 | |
| 
 | |
|         $transactions = $collector->getJournals();
 | |
|         $result       = [];
 | |
|         $chartData    = [];
 | |
|         /** @var Transaction $transaction */
 | |
|         foreach ($transactions as $transaction) {
 | |
|             $opposingId          = intval($transaction->opposing_account_id);
 | |
|             $result[$opposingId] = $result[$opposingId] ?? '0';
 | |
|             $result[$opposingId] = bcadd($transaction->transaction_amount, $result[$opposingId]);
 | |
|         }
 | |
| 
 | |
|         $names = $this->getAccountNames(array_keys($result));
 | |
|         foreach ($result as $opposingId => $amount) {
 | |
|             $name             = $names[$opposingId] ?? 'no name';
 | |
|             $chartData[$name] = $amount;
 | |
|         }
 | |
| 
 | |
|         $data = $this->generator->pieChart($chartData);
 | |
|         $cache->store($data);
 | |
| 
 | |
|         return Response::json($data);
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * Shows a budget list with spent/left/overspent.
 | |
|      *
 | |
|      * @SuppressWarnings(PHPMD.CyclomaticComplexity) // it's exactly five.
 | |
|      * @SuppressWarnings(PHPMD.ExcessiveMethodLength) // 46 lines, I'm fine with this.
 | |
|      *
 | |
|      * @return \Symfony\Component\HttpFoundation\Response
 | |
|      */
 | |
|     public function frontpage()
 | |
|     {
 | |
|         $start = session('start', Carbon::now()->startOfMonth());
 | |
|         $end   = session('end', Carbon::now()->endOfMonth());
 | |
|         // chart properties for cache:
 | |
|         $cache = new CacheProperties();
 | |
|         $cache->addProperty($start);
 | |
|         $cache->addProperty($end);
 | |
|         $cache->addProperty('chart.budget.frontpage');
 | |
|         if ($cache->has()) {
 | |
|             return Response::json($cache->get()); // @codeCoverageIgnore
 | |
|         }
 | |
|         $budgets   = $this->repository->getActiveBudgets();
 | |
|         $chartData = [
 | |
|             ['label' => strval(trans('firefly.spent_in_budget')), 'entries' => [], 'type' => 'bar'],
 | |
|             ['label' => strval(trans('firefly.left_to_spend')), 'entries' => [], 'type' => 'bar'],
 | |
|             ['label' => strval(trans('firefly.overspent')), 'entries' => [], 'type' => 'bar'],
 | |
|         ];
 | |
| 
 | |
|         /** @var Budget $budget */
 | |
|         foreach ($budgets as $budget) {
 | |
|             // get relevant repetitions:
 | |
|             $limits   = $this->repository->getBudgetLimits($budget, $start, $end);
 | |
|             $expenses = $this->getExpensesForBudget($limits, $budget, $start, $end);
 | |
| 
 | |
|             foreach ($expenses as $name => $row) {
 | |
|                 $chartData[0]['entries'][$name] = $row['spent'];
 | |
|                 $chartData[1]['entries'][$name] = $row['left'];
 | |
|                 $chartData[2]['entries'][$name] = $row['overspent'];
 | |
|             }
 | |
|         }
 | |
|         // for no budget:
 | |
|         $spent = $this->spentInPeriodWithout($start, $end);
 | |
|         $name  = strval(trans('firefly.no_budget'));
 | |
|         if (0 !== bccomp($spent, '0')) {
 | |
|             $chartData[0]['entries'][$name] = bcmul($spent, '-1');
 | |
|             $chartData[1]['entries'][$name] = '0';
 | |
|             $chartData[2]['entries'][$name] = '0';
 | |
|         }
 | |
| 
 | |
|         $data = $this->generator->multiSet($chartData);
 | |
|         $cache->store($data);
 | |
| 
 | |
|         return Response::json($data);
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @SuppressWarnings(PHPMD.CyclomaticComplexity) // it's exactly five.
 | |
|      *
 | |
|      * @param Budget     $budget
 | |
|      * @param Carbon     $start
 | |
|      * @param Carbon     $end
 | |
|      * @param Collection $accounts
 | |
|      *
 | |
|      * @return \Illuminate\Http\JsonResponse
 | |
|      */
 | |
|     public function period(Budget $budget, Collection $accounts, Carbon $start, Carbon $end)
 | |
|     {
 | |
|         // chart properties for cache:
 | |
|         $cache = new CacheProperties();
 | |
|         $cache->addProperty($start);
 | |
|         $cache->addProperty($end);
 | |
|         $cache->addProperty($accounts);
 | |
|         $cache->addProperty($budget->id);
 | |
|         $cache->addProperty('chart.budget.period');
 | |
|         if ($cache->has()) {
 | |
|             return Response::json($cache->get()); // @codeCoverageIgnore
 | |
|         }
 | |
|         $periods  = app('navigation')->listOfPeriods($start, $end);
 | |
|         $entries  = $this->repository->getBudgetPeriodReport(new Collection([$budget]), $accounts, $start, $end); // get the expenses
 | |
|         $budgeted = $this->getBudgetedInPeriod($budget, $start, $end);
 | |
| 
 | |
|         // join them into one set of data:
 | |
|         $chartData = [
 | |
|             ['label' => strval(trans('firefly.spent')), 'type' => 'bar', 'entries' => []],
 | |
|             ['label' => strval(trans('firefly.budgeted')), 'type' => 'bar', 'entries' => []],
 | |
|         ];
 | |
| 
 | |
|         foreach (array_keys($periods) as $period) {
 | |
|             $label                           = $periods[$period];
 | |
|             $spent                           = isset($entries[$budget->id]['entries'][$period]) ? $entries[$budget->id]['entries'][$period] : '0';
 | |
|             $limit                           = isset($budgeted[$period]) ? $budgeted[$period] : 0;
 | |
|             $chartData[0]['entries'][$label] = round(bcmul($spent, '-1'), 12);
 | |
|             $chartData[1]['entries'][$label] = $limit;
 | |
|         }
 | |
|         $data = $this->generator->multiSet($chartData);
 | |
|         $cache->store($data);
 | |
| 
 | |
|         return Response::json($data);
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @param Collection $accounts
 | |
|      * @param Carbon     $start
 | |
|      * @param Carbon     $end
 | |
|      *
 | |
|      * @return \Illuminate\Http\JsonResponse
 | |
|      */
 | |
|     public function periodNoBudget(Collection $accounts, Carbon $start, Carbon $end)
 | |
|     {
 | |
|         // chart properties for cache:
 | |
|         $cache = new CacheProperties();
 | |
|         $cache->addProperty($start);
 | |
|         $cache->addProperty($end);
 | |
|         $cache->addProperty($accounts);
 | |
|         $cache->addProperty('chart.budget.no-budget');
 | |
|         if ($cache->has()) {
 | |
|             return Response::json($cache->get()); // @codeCoverageIgnore
 | |
|         }
 | |
| 
 | |
|         // the expenses:
 | |
|         $periods   = app('navigation')->listOfPeriods($start, $end);
 | |
|         $entries   = $this->repository->getNoBudgetPeriodReport($accounts, $start, $end);
 | |
|         $chartData = [];
 | |
| 
 | |
|         // join them:
 | |
|         foreach (array_keys($periods) as $period) {
 | |
|             $label             = $periods[$period];
 | |
|             $spent             = isset($entries['entries'][$period]) ? $entries['entries'][$period] : '0';
 | |
|             $chartData[$label] = bcmul($spent, '-1');
 | |
|         }
 | |
|         $data = $this->generator->singleSet(strval(trans('firefly.spent')), $chartData);
 | |
|         $cache->store($data);
 | |
| 
 | |
|         return Response::json($data);
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @param array $accountIds
 | |
|      *
 | |
|      * @return array
 | |
|      */
 | |
|     private function getAccountNames(array $accountIds): array
 | |
|     {
 | |
|         /** @var AccountRepositoryInterface $repository */
 | |
|         $repository = app(AccountRepositoryInterface::class);
 | |
|         $accounts   = $repository->getAccountsByType([AccountType::ASSET, AccountType::DEFAULT, AccountType::EXPENSE, AccountType::CASH]);
 | |
|         $grouped    = $accounts->groupBy('id')->toArray();
 | |
|         $return     = [];
 | |
|         foreach ($accountIds as $accountId) {
 | |
|             if (isset($grouped[$accountId])) {
 | |
|                 $return[$accountId] = $grouped[$accountId][0]['name'];
 | |
|             }
 | |
|         }
 | |
|         $return[0] = '(no name)';
 | |
| 
 | |
|         return $return;
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @param Budget $budget
 | |
|      * @param Carbon $start
 | |
|      * @param Carbon $end
 | |
|      *
 | |
|      * @return array
 | |
|      */
 | |
|     private function getBudgetedInPeriod(Budget $budget, Carbon $start, Carbon $end): array
 | |
|     {
 | |
|         $key      = app('navigation')->preferredCarbonFormat($start, $end);
 | |
|         $range    = app('navigation')->preferredRangeFormat($start, $end);
 | |
|         $current  = clone $start;
 | |
|         $budgeted = [];
 | |
|         while ($current < $end) {
 | |
|             $currentStart     = app('navigation')->startOfPeriod($current, $range);
 | |
|             $currentEnd       = app('navigation')->endOfPeriod($current, $range);
 | |
|             $budgetLimits     = $this->repository->getBudgetLimits($budget, $currentStart, $currentEnd);
 | |
|             $index            = $currentStart->format($key);
 | |
|             $budgeted[$index] = $budgetLimits->sum('amount');
 | |
|             $currentEnd->addDay();
 | |
|             $current = clone $currentEnd;
 | |
|         }
 | |
| 
 | |
|         return $budgeted;
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * Small helper function for some of the charts.
 | |
|      *
 | |
|      * @param array $categoryIds
 | |
|      *
 | |
|      * @return array
 | |
|      */
 | |
|     private function getCategoryNames(array $categoryIds): array
 | |
|     {
 | |
|         /** @var CategoryRepositoryInterface $repository */
 | |
|         $repository = app(CategoryRepositoryInterface::class);
 | |
|         $categories = $repository->getCategories();
 | |
|         $grouped    = $categories->groupBy('id')->toArray();
 | |
|         $return     = [];
 | |
|         foreach ($categoryIds as $categoryId) {
 | |
|             if (isset($grouped[$categoryId])) {
 | |
|                 $return[$categoryId] = $grouped[$categoryId][0]['name'];
 | |
|             }
 | |
|         }
 | |
|         $return[0] = trans('firefly.noCategory');
 | |
| 
 | |
|         return $return;
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @SuppressWarnings(PHPMD.CyclomaticComplexity) // it's 6 but ok.
 | |
|      *
 | |
|      * @param Collection $limits
 | |
|      * @param Budget     $budget
 | |
|      * @param Carbon     $start
 | |
|      * @param Carbon     $end
 | |
|      *
 | |
|      * @return array
 | |
|      */
 | |
|     private function getExpensesForBudget(Collection $limits, Budget $budget, Carbon $start, Carbon $end): array
 | |
|     {
 | |
|         $return = [];
 | |
|         if (0 === $limits->count()) {
 | |
|             $spent = $this->repository->spentInPeriod(new Collection([$budget]), new Collection, $start, $end);
 | |
|             if (0 !== bccomp($spent, '0')) {
 | |
|                 $return[$budget->name]['spent']     = bcmul($spent, '-1');
 | |
|                 $return[$budget->name]['left']      = 0;
 | |
|                 $return[$budget->name]['overspent'] = 0;
 | |
|             }
 | |
| 
 | |
|             return $return;
 | |
|         }
 | |
| 
 | |
|         $rows = $this->spentInPeriodMulti($budget, $limits);
 | |
|         foreach ($rows as $name => $row) {
 | |
|             if (0 !== bccomp($row['spent'], '0') || 0 !== bccomp($row['left'], '0')) {
 | |
|                 $return[$name] = $row;
 | |
|             }
 | |
|         }
 | |
|         unset($rows, $row);
 | |
| 
 | |
|         return $return;
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @SuppressWarnings(PHPMD.CyclomaticComplexity) // it's exactly five.
 | |
|      *
 | |
|      * Returns an array with the following values:
 | |
|      * 0 =>
 | |
|      *   'name' => name of budget + repetition
 | |
|      *   'left' => left in budget repetition (always zero)
 | |
|      *   'overspent' => spent more than budget repetition? (always zero)
 | |
|      *   'spent' => actually spent in period for budget
 | |
|      * 1 => (etc)
 | |
|      *
 | |
|      * @param Budget     $budget
 | |
|      * @param Collection $limits
 | |
|      *
 | |
|      * @return array
 | |
|      */
 | |
|     private function spentInPeriodMulti(Budget $budget, Collection $limits): array
 | |
|     {
 | |
|         $return = [];
 | |
|         $format = strval(trans('config.month_and_day'));
 | |
|         $name   = $budget->name;
 | |
|         /** @var BudgetLimit $budgetLimit */
 | |
|         foreach ($limits as $budgetLimit) {
 | |
|             $expenses = $this->repository->spentInPeriod(new Collection([$budget]), new Collection, $budgetLimit->start_date, $budgetLimit->end_date);
 | |
|             $expenses = Steam::positive($expenses);
 | |
| 
 | |
|             if ($limits->count() > 1) {
 | |
|                 $name = $budget->name . ' ' . trans(
 | |
|                         'firefly.between_dates',
 | |
|                         [
 | |
|                             'start' => $budgetLimit->start_date->formatLocalized($format),
 | |
|                             'end'   => $budgetLimit->end_date->formatLocalized($format),
 | |
|                         ]
 | |
|                     );
 | |
|             }
 | |
|             /*
 | |
|              * amount: amount of budget limit
 | |
|              * left: amount of budget limit min spent, or 0 when < 0.
 | |
|              * spent: spent, or amount of budget limit when > amount
 | |
|              */
 | |
|             $amount       = $budgetLimit->amount;
 | |
|             $leftInLimit  = bcsub($amount, $expenses);
 | |
|             $hasOverspent = bccomp($leftInLimit, '0') === -1;
 | |
| 
 | |
|             $left      = $hasOverspent ? '0' : bcsub($amount, $expenses);
 | |
|             $spent     = $hasOverspent ? $amount : $expenses;
 | |
|             $overspent = $hasOverspent ? Steam::positive($leftInLimit) : '0';
 | |
| 
 | |
|             $return[$name] = [
 | |
|                 'left'      => $left,
 | |
|                 'overspent' => $overspent,
 | |
|                 'spent'     => $spent,
 | |
|             ];
 | |
|         }
 | |
| 
 | |
|         return $return;
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * Returns an array with the following values:
 | |
|      * 'name' => "no budget" in local language
 | |
|      * 'repetition_left' => left in budget repetition (always zero)
 | |
|      * 'repetition_overspent' => spent more than budget repetition? (always zero)
 | |
|      * 'spent' => actually spent in period for budget.
 | |
|      *
 | |
|      * @param Carbon $start
 | |
|      * @param Carbon $end
 | |
|      *
 | |
|      * @return string
 | |
|      */
 | |
|     private function spentInPeriodWithout(Carbon $start, Carbon $end): string
 | |
|     {
 | |
|         // collector
 | |
|         /** @var JournalCollectorInterface $collector */
 | |
|         $collector = app(JournalCollectorInterface::class);
 | |
|         $types     = [TransactionType::WITHDRAWAL];
 | |
|         $collector->setAllAssetAccounts()->setTypes($types)->setRange($start, $end)->withoutBudget();
 | |
|         $journals = $collector->getJournals();
 | |
|         $sum      = '0';
 | |
|         /** @var Transaction $entry */
 | |
|         foreach ($journals as $entry) {
 | |
|             $sum = bcadd($entry->transaction_amount, $sum);
 | |
|         }
 | |
| 
 | |
|         return $sum;
 | |
|     }
 | |
| }
 |