mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-11-03 20:55:05 +00:00
434 lines
16 KiB
PHP
434 lines
16 KiB
PHP
<?php
|
|
/**
|
|
* BudgetController.php
|
|
* Copyright (C) 2016 thegrumpydictator@gmail.com
|
|
*
|
|
* This software may be modified and distributed under the terms of the
|
|
* Creative Commons Attribution-ShareAlike 4.0 International License.
|
|
*
|
|
* See the LICENSE file for details.
|
|
*/
|
|
|
|
declare(strict_types = 1);
|
|
|
|
namespace FireflyIII\Http\Controllers;
|
|
|
|
use Amount;
|
|
use Carbon\Carbon;
|
|
use FireflyIII\Exceptions\FireflyException;
|
|
use FireflyIII\Helpers\Collector\JournalCollectorInterface;
|
|
use FireflyIII\Http\Requests\BudgetFormRequest;
|
|
use FireflyIII\Http\Requests\BudgetIncomeRequest;
|
|
use FireflyIII\Models\AccountType;
|
|
use FireflyIII\Models\Budget;
|
|
use FireflyIII\Models\LimitRepetition;
|
|
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
|
|
use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
|
|
use Illuminate\Http\Request;
|
|
use Illuminate\Support\Collection;
|
|
use Preferences;
|
|
use Response;
|
|
use Session;
|
|
use URL;
|
|
use View;
|
|
|
|
/**
|
|
* Class BudgetController
|
|
*
|
|
* @package FireflyIII\Http\Controllers
|
|
*/
|
|
class BudgetController extends Controller
|
|
{
|
|
|
|
/** @var BudgetRepositoryInterface */
|
|
private $repository;
|
|
|
|
/**
|
|
*
|
|
*/
|
|
public function __construct()
|
|
{
|
|
parent::__construct();
|
|
|
|
View::share('hideBudgets', true);
|
|
|
|
$this->middleware(
|
|
function ($request, $next) {
|
|
View::share('title', trans('firefly.budgets'));
|
|
View::share('mainTitleIcon', 'fa-tasks');
|
|
$this->repository = app(BudgetRepositoryInterface::class);
|
|
|
|
return $next($request);
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param Request $request
|
|
* @param BudgetRepositoryInterface $repository
|
|
* @param Budget $budget
|
|
*
|
|
* @return \Illuminate\Http\JsonResponse
|
|
*/
|
|
public function amount(Request $request, BudgetRepositoryInterface $repository, Budget $budget)
|
|
{
|
|
$amount = intval($request->get('amount'));
|
|
/** @var Carbon $start */
|
|
$start = session('start', Carbon::now()->startOfMonth());
|
|
/** @var Carbon $end */
|
|
$end = session('end', Carbon::now()->endOfMonth());
|
|
$viewRange = Preferences::get('viewRange', '1M')->data;
|
|
$limitRepetition = $repository->updateLimitAmount($budget, $start, $end, $viewRange, $amount);
|
|
if ($amount == 0) {
|
|
$limitRepetition = null;
|
|
}
|
|
Preferences::mark();
|
|
|
|
return Response::json(['name' => $budget->name, 'repetition' => $limitRepetition ? $limitRepetition->id : 0, 'amount' => $amount]);
|
|
|
|
}
|
|
|
|
/**
|
|
* @return View
|
|
*/
|
|
public function create()
|
|
{
|
|
// put previous url in session if not redirect from store (not "create another").
|
|
if (session('budgets.create.fromStore') !== true) {
|
|
Session::put('budgets.create.url', URL::previous());
|
|
}
|
|
Session::forget('budgets.create.fromStore');
|
|
Session::flash('gaEventCategory', 'budgets');
|
|
Session::flash('gaEventAction', 'create');
|
|
$subTitle = (string)trans('firefly.create_new_budget');
|
|
|
|
return view('budgets.create', compact('subTitle'));
|
|
}
|
|
|
|
/**
|
|
* @param Budget $budget
|
|
*
|
|
* @return View
|
|
*/
|
|
public function delete(Budget $budget)
|
|
{
|
|
$subTitle = trans('firefly.delete_budget', ['name' => $budget->name]);
|
|
|
|
// put previous url in session
|
|
Session::put('budgets.delete.url', URL::previous());
|
|
Session::flash('gaEventCategory', 'budgets');
|
|
Session::flash('gaEventAction', 'delete');
|
|
|
|
return view('budgets.delete', compact('budget', 'subTitle'));
|
|
}
|
|
|
|
/**
|
|
* @param Budget $budget
|
|
* @param BudgetRepositoryInterface $repository
|
|
*
|
|
* @return \Illuminate\Http\RedirectResponse
|
|
*/
|
|
public function destroy(Budget $budget, BudgetRepositoryInterface $repository)
|
|
{
|
|
|
|
$name = $budget->name;
|
|
$budgetId = $budget->id;
|
|
$repository->destroy($budget);
|
|
|
|
|
|
Session::flash('success', strval(trans('firefly.deleted_budget', ['name' => e($name)])));
|
|
Preferences::mark();
|
|
|
|
$uri = session('budgets.delete.url');
|
|
if (!(strpos($uri, sprintf('budgets/show/%s', $budgetId)) === false)) {
|
|
// uri would point back to budget
|
|
$uri = route('budgets.index');
|
|
}
|
|
|
|
return redirect($uri);
|
|
}
|
|
|
|
/**
|
|
* @param Budget $budget
|
|
*
|
|
* @return View
|
|
*/
|
|
public function edit(Budget $budget)
|
|
{
|
|
$subTitle = trans('firefly.edit_budget', ['name' => $budget->name]);
|
|
|
|
// put previous url in session if not redirect from store (not "return_to_edit").
|
|
if (session('budgets.edit.fromUpdate') !== true) {
|
|
Session::put('budgets.edit.url', URL::previous());
|
|
}
|
|
Session::forget('budgets.edit.fromUpdate');
|
|
Session::flash('gaEventCategory', 'budgets');
|
|
Session::flash('gaEventAction', 'edit');
|
|
|
|
return view('budgets.edit', compact('budget', 'subTitle'));
|
|
|
|
}
|
|
|
|
/**
|
|
* @return View
|
|
*/
|
|
public function index()
|
|
{
|
|
$this->repository->cleanupBudgets();
|
|
|
|
$budgets = $this->repository->getActiveBudgets();
|
|
$inactive = $this->repository->getInactiveBudgets();
|
|
$start = session('start', new Carbon);
|
|
$end = session('end', new Carbon);
|
|
$periodStart = $start->formatLocalized($this->monthAndDayFormat);
|
|
$periodEnd = $end->formatLocalized($this->monthAndDayFormat);
|
|
$budgetInformation = $this->collectBudgetInformation($budgets, $start, $end);
|
|
$defaultCurrency = Amount::getDefaultCurrency();
|
|
$available = $this->repository->getAvailableBudget($defaultCurrency, $start, $end);
|
|
$spent = array_sum(array_column($budgetInformation, 'spent'));
|
|
$budgeted = array_sum(array_column($budgetInformation, 'budgeted'));
|
|
|
|
return view(
|
|
'budgets.index',
|
|
compact('available', 'periodStart', 'periodEnd', 'budgetInformation', 'defaultCurrency', 'inactive', 'budgets', 'spent', 'budgeted')
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param Request $request
|
|
*
|
|
* @return View
|
|
*/
|
|
public function noBudget(Request $request)
|
|
{
|
|
/** @var Carbon $start */
|
|
$start = session('start', Carbon::now()->startOfMonth());
|
|
/** @var Carbon $end */
|
|
$end = session('end', Carbon::now()->endOfMonth());
|
|
$page = intval($request->get('page')) == 0 ? 1 : intval($request->get('page'));
|
|
$pageSize = intval(Preferences::get('transactionPageSize', 50)->data);
|
|
$subTitle = trans(
|
|
'firefly.without_budget_between',
|
|
['start' => $start->formatLocalized($this->monthAndDayFormat), 'end' => $end->formatLocalized($this->monthAndDayFormat)]
|
|
);
|
|
|
|
// collector
|
|
/** @var JournalCollectorInterface $collector */
|
|
$collector = app(JournalCollectorInterface::class, [auth()->user()]);
|
|
$collector->setAllAssetAccounts()->setRange($start, $end)->setLimit($pageSize)->setPage($page)->withoutBudget();
|
|
$journals = $collector->getPaginatedJournals();
|
|
$journals->setPath('/budgets/list/noBudget');
|
|
|
|
return view('budgets.no-budget', compact('journals', 'subTitle'));
|
|
}
|
|
|
|
/**
|
|
* @return \Illuminate\Http\RedirectResponse
|
|
*/
|
|
public function postUpdateIncome(BudgetIncomeRequest $request)
|
|
{
|
|
$start = session('start', new Carbon);
|
|
$end = session('end', new Carbon);
|
|
$defaultCurrency = Amount::getDefaultCurrency();
|
|
$amount = $request->get('amount');
|
|
|
|
$this->repository->setAvailableBudget($defaultCurrency, $start, $end, $amount);
|
|
Preferences::mark();
|
|
|
|
return redirect(route('budgets.index'));
|
|
}
|
|
|
|
/**
|
|
* @param Request $request
|
|
* @param BudgetRepositoryInterface $repository
|
|
* @param AccountRepositoryInterface $accountRepository
|
|
* @param Budget $budget
|
|
*
|
|
* @return View
|
|
*/
|
|
public function show(Request $request, BudgetRepositoryInterface $repository, AccountRepositoryInterface $accountRepository, Budget $budget)
|
|
{
|
|
/** @var Carbon $start */
|
|
$start = session('first', Carbon::create()->startOfYear());
|
|
$end = new Carbon;
|
|
$page = intval($request->get('page')) == 0 ? 1 : intval($request->get('page'));
|
|
$pageSize = intval(Preferences::get('transactionPageSize', 50)->data);
|
|
$accounts = $accountRepository->getAccountsByType([AccountType::DEFAULT, AccountType::ASSET, AccountType::CASH]);
|
|
$repetition = null;
|
|
// collector:
|
|
/** @var JournalCollectorInterface $collector */
|
|
$collector = app(JournalCollectorInterface::class, [auth()->user()]);
|
|
$collector->setAllAssetAccounts()->setRange($start, $end)->setBudget($budget)->setLimit($pageSize)->setPage($page)->withCategoryInformation();
|
|
$journals = $collector->getPaginatedJournals();
|
|
$journals->setPath('/budgets/show/' . $budget->id);
|
|
|
|
|
|
$set = $budget->limitrepetitions()->orderBy('startdate', 'DESC')->get();
|
|
$subTitle = e($budget->name);
|
|
$limits = new Collection();
|
|
|
|
/** @var LimitRepetition $entry */
|
|
foreach ($set as $entry) {
|
|
$entry->spent = $repository->spentInPeriod(new Collection([$budget]), $accounts, $entry->startdate, $entry->enddate);
|
|
$limits->push($entry);
|
|
}
|
|
|
|
return view('budgets.show', compact('limits', 'budget', 'repetition', 'journals', 'subTitle'));
|
|
}
|
|
|
|
/**
|
|
* @param Request $request
|
|
* @param Budget $budget
|
|
* @param LimitRepetition $repetition
|
|
*
|
|
* @return View
|
|
* @throws FireflyException
|
|
*/
|
|
public function showByRepetition(Request $request, Budget $budget, LimitRepetition $repetition)
|
|
{
|
|
if ($repetition->budgetLimit->budget->id != $budget->id) {
|
|
throw new FireflyException('This budget limit is not part of this budget.');
|
|
}
|
|
|
|
/** @var BudgetRepositoryInterface $repository */
|
|
$repository = app(BudgetRepositoryInterface::class);
|
|
/** @var AccountRepositoryInterface $accountRepository */
|
|
$accountRepository = app(AccountRepositoryInterface::class);
|
|
$start = $repetition->startdate;
|
|
$end = $repetition->enddate;
|
|
$page = intval($request->get('page')) == 0 ? 1 : intval($request->get('page'));
|
|
$pageSize = intval(Preferences::get('transactionPageSize', 50)->data);
|
|
$subTitle = trans(
|
|
'firefly.budget_in_month', ['name' => $budget->name, 'month' => $repetition->startdate->formatLocalized($this->monthFormat)]
|
|
);
|
|
$accounts = $accountRepository->getAccountsByType([AccountType::DEFAULT, AccountType::ASSET, AccountType::CASH]);
|
|
|
|
|
|
// collector:
|
|
/** @var JournalCollectorInterface $collector */
|
|
$collector = app(JournalCollectorInterface::class, [auth()->user()]);
|
|
$collector->setAllAssetAccounts()->setRange($start, $end)->setBudget($budget)->setLimit($pageSize)->setPage($page)->withCategoryInformation();
|
|
$journals = $collector->getPaginatedJournals();
|
|
$journals->setPath('/budgets/show/' . $budget->id . '/' . $repetition->id);
|
|
|
|
|
|
$repetition->spent = $repository->spentInPeriod(new Collection([$budget]), $accounts, $repetition->startdate, $repetition->enddate);
|
|
$limits = new Collection([$repetition]);
|
|
|
|
return view('budgets.show', compact('limits', 'budget', 'repetition', 'journals', 'subTitle'));
|
|
|
|
}
|
|
|
|
/**
|
|
* @param BudgetFormRequest $request
|
|
* @param BudgetRepositoryInterface $repository
|
|
*
|
|
* @return \Illuminate\Http\RedirectResponse
|
|
*/
|
|
public function store(BudgetFormRequest $request, BudgetRepositoryInterface $repository)
|
|
{
|
|
$data = $request->getBudgetData();
|
|
$budget = $repository->store($data);
|
|
|
|
Session::flash('success', strval(trans('firefly.stored_new_budget', ['name' => e($budget->name)])));
|
|
Preferences::mark();
|
|
|
|
if (intval($request->get('create_another')) === 1) {
|
|
// set value so create routine will not overwrite URL:
|
|
Session::put('budgets.create.fromStore', true);
|
|
|
|
return redirect(route('budgets.create'))->withInput();
|
|
}
|
|
|
|
// redirect to previous URL.
|
|
return redirect(session('budgets.create.url'));
|
|
|
|
}
|
|
|
|
/**
|
|
* @param BudgetFormRequest $request
|
|
* @param BudgetRepositoryInterface $repository
|
|
* @param Budget $budget
|
|
*
|
|
* @return \Illuminate\Http\RedirectResponse
|
|
*/
|
|
public function update(BudgetFormRequest $request, BudgetRepositoryInterface $repository, Budget $budget)
|
|
{
|
|
$data = $request->getBudgetData();
|
|
$repository->update($budget, $data);
|
|
|
|
Session::flash('success', strval(trans('firefly.updated_budget', ['name' => e($budget->name)])));
|
|
Preferences::mark();
|
|
|
|
if (intval($request->get('return_to_edit')) === 1) {
|
|
// set value so edit routine will not overwrite URL:
|
|
Session::put('budgets.edit.fromUpdate', true);
|
|
|
|
return redirect(route('budgets.edit', [$budget->id]))->withInput(['return_to_edit' => 1]);
|
|
}
|
|
|
|
// redirect to previous URL.
|
|
return redirect(session('budgets.edit.url'));
|
|
|
|
}
|
|
|
|
/**
|
|
* @return View
|
|
*/
|
|
public function updateIncome()
|
|
{
|
|
$start = session('start', new Carbon);
|
|
$end = session('end', new Carbon);
|
|
$defaultCurrency = Amount::getDefaultCurrency();
|
|
$available = $this->repository->getAvailableBudget($defaultCurrency, $start, $end);
|
|
|
|
|
|
return view('budgets.income', compact('available', 'start', 'end'));
|
|
}
|
|
|
|
/**
|
|
* @param Collection $budgets
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
*
|
|
* @return array
|
|
*/
|
|
private function collectBudgetInformation(Collection $budgets, Carbon $start, Carbon $end): array
|
|
{
|
|
// get account information
|
|
$accountRepository = app(AccountRepositoryInterface::class);
|
|
$accounts = $accountRepository->getAccountsByType([AccountType::DEFAULT, AccountType::ASSET, AccountType::CASH]);
|
|
$return = [];
|
|
/** @var Budget $budget */
|
|
foreach ($budgets as $budget) {
|
|
$budgetId = $budget->id;
|
|
$return[$budgetId] = [
|
|
'spent' => $this->repository->spentInPeriod(new Collection([$budget]), $accounts, $start, $end),
|
|
'budgeted' => '0',
|
|
'currentRep' => false,
|
|
];
|
|
$allRepetitions = $this->repository->getAllBudgetLimitRepetitions($start, $end);
|
|
$otherRepetitions = new Collection;
|
|
|
|
// get all the limit repetitions relevant between start and end and examine them:
|
|
/** @var LimitRepetition $repetition */
|
|
foreach ($allRepetitions as $repetition) {
|
|
if ($repetition->budget_id == $budget->id) {
|
|
if ($repetition->startdate->isSameDay($start) && $repetition->enddate->isSameDay($end)
|
|
) {
|
|
$return[$budgetId]['currentRep'] = $repetition;
|
|
$return[$budgetId]['budgeted'] = $repetition->amount;
|
|
continue;
|
|
}
|
|
// otherwise it's just one of the many relevant repetitions:
|
|
$otherRepetitions->push($repetition);
|
|
}
|
|
}
|
|
$return[$budgetId]['otherRepetitions'] = $otherRepetitions;
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
}
|