. */ declare(strict_types=1); namespace FireflyIII\Http\Controllers\Budget; use Carbon\Carbon; use FireflyIII\Enums\TransactionTypeEnum; use FireflyIII\Exceptions\FireflyException; use FireflyIII\Helpers\Collector\GroupCollectorInterface; use FireflyIII\Http\Controllers\Controller; use FireflyIII\Models\Budget; use FireflyIII\Models\BudgetLimit; use FireflyIII\Models\TransactionJournal; use FireflyIII\Repositories\Budget\BudgetRepositoryInterface; use FireflyIII\Repositories\Journal\JournalRepositoryInterface; use FireflyIII\Support\Http\Controllers\AugumentData; use FireflyIII\Support\Http\Controllers\PeriodOverview; use Illuminate\Contracts\View\Factory; use Illuminate\Http\Request; use Illuminate\View\View; use Psr\Container\ContainerExceptionInterface; use Psr\Container\NotFoundExceptionInterface; /** * Class ShowController */ class ShowController extends Controller { use AugumentData; use PeriodOverview; protected JournalRepositoryInterface $journalRepos; private BudgetRepositoryInterface $repository; /** * ShowController constructor. */ public function __construct() { app('view')->share('showCategory', true); parent::__construct(); $this->middleware( function ($request, $next) { app('view')->share('title', (string) trans('firefly.budgets')); app('view')->share('mainTitleIcon', 'fa-pie-chart'); $this->journalRepos = app(JournalRepositoryInterface::class); $this->repository = app(BudgetRepositoryInterface::class); return $next($request); } ); } /** * Show transactions without a budget. * * @return Factory|View * * @throws ContainerExceptionInterface * @throws FireflyException * @throws NotFoundExceptionInterface */ public function noBudget(Request $request, ?Carbon $start = null, ?Carbon $end = null): Factory|\Illuminate\Contracts\View\View { $start ??= session('start'); $end ??= session('end'); /** @var Carbon $start */ /** @var Carbon $end */ $subTitle = trans( 'firefly.without_budget_between', ['start' => $start->isoFormat($this->monthAndDayFormat), 'end' => $end->isoFormat($this->monthAndDayFormat)] ); // get first journal ever to set off the budget period overview. $first = $this->journalRepos->firstNull(); $firstDate = $first instanceof TransactionJournal ? $first->date : $start; $periods = $this->getNoModelPeriodOverview('budget', $firstDate, $end); $page = (int) $request->get('page'); $pageSize = (int) app('preferences')->get('listPageSize', 50)->data; /** @var GroupCollectorInterface $collector */ $collector = app(GroupCollectorInterface::class); $collector->setRange($start, $end)->setTypes([TransactionTypeEnum::WITHDRAWAL->value])->setLimit($pageSize)->setPage($page) ->withoutBudget()->withAccountInformation()->withCategoryInformation() ; $groups = $collector->getPaginatedGroups(); $groups->setPath(route('budgets.no-budget')); return view('budgets.no-budget', ['groups' => $groups, 'subTitle' => $subTitle, 'periods' => $periods, 'start' => $start, 'end' => $end]); } /** * Shows ALL transactions without a budget. * * @return Factory|View * * @throws ContainerExceptionInterface * @throws NotFoundExceptionInterface */ public function noBudgetAll(Request $request): Factory|\Illuminate\Contracts\View\View { $subTitle = (string) trans('firefly.all_journals_without_budget'); $first = $this->journalRepos->firstNull(); $start = $first instanceof TransactionJournal ? $first->date : new Carbon(); $end = today(config('app.timezone')); $page = (int) $request->get('page'); $pageSize = (int) app('preferences')->get('listPageSize', 50)->data; /** @var GroupCollectorInterface $collector */ $collector = app(GroupCollectorInterface::class); $collector->setRange($start, $end)->setTypes([TransactionTypeEnum::WITHDRAWAL->value])->setLimit($pageSize)->setPage($page) ->withoutBudget()->withAccountInformation()->withCategoryInformation() ; $groups = $collector->getPaginatedGroups(); $groups->setPath(route('budgets.no-budget-all')); return view('budgets.no-budget', ['groups' => $groups, 'subTitle' => $subTitle, 'start' => $start, 'end' => $end]); } /** * Show a single budget. * * @return Factory|View * * @throws ContainerExceptionInterface * @throws NotFoundExceptionInterface */ public function show(Request $request, Budget $budget): Factory|\Illuminate\Contracts\View\View { /** @var Carbon $allStart */ $allStart = session('first', today(config('app.timezone'))->startOfYear()); $allEnd = today(); $page = (int) $request->get('page'); $pageSize = (int) app('preferences')->get('listPageSize', 50)->data; $limits = $this->getLimits($budget, $allStart, $allEnd); $repetition = null; $attachments = $this->repository->getAttachments($budget); // collector: /** @var GroupCollectorInterface $collector */ $collector = app(GroupCollectorInterface::class); $collector->setRange($allStart, $allEnd)->setBudget($budget) ->withAccountInformation() ->setLimit($pageSize)->setPage($page)->withBudgetInformation()->withCategoryInformation() ; $groups = $collector->getPaginatedGroups(); $groups->setPath(route('budgets.show', [$budget->id])); $subTitle = (string) trans('firefly.all_journals_for_budget', ['name' => $budget->name]); return view('budgets.show', ['limits' => $limits, 'attachments' => $attachments, 'budget' => $budget, 'repetition' => $repetition, 'groups' => $groups, 'subTitle' => $subTitle]); } /** * Show a single budget by a budget limit. * * @return Factory|View * * @throws FireflyException * @throws ContainerExceptionInterface * @throws NotFoundExceptionInterface */ public function showByBudgetLimit(Request $request, Budget $budget, BudgetLimit $budgetLimit): Factory|\Illuminate\Contracts\View\View { if ($budgetLimit->budget->id !== $budget->id) { throw new FireflyException('This budget limit is not part of this budget.'); } $currencySymbol = $budgetLimit->transactionCurrency->symbol; $page = (int) $request->get('page'); $pageSize = (int) app('preferences')->get('listPageSize', 50)->data; $subTitle = trans( 'firefly.budget_in_period', [ 'name' => $budget->name, 'start' => $budgetLimit->start_date->isoFormat($this->monthAndDayFormat), 'end' => $budgetLimit->end_date->isoFormat($this->monthAndDayFormat), 'currency' => $budgetLimit->transactionCurrency->name, ] ); if ($this->convertToPrimary) { $currencySymbol = $this->primaryCurrency->symbol; } // collector: /** @var GroupCollectorInterface $collector */ $collector = app(GroupCollectorInterface::class); $collector->setRange($budgetLimit->start_date, $budgetLimit->end_date)->withAccountInformation() ->setBudget($budget)->setLimit($pageSize)->setPage($page)->withBudgetInformation()->withCategoryInformation() ; $groups = $collector->getPaginatedGroups(); $groups->setPath(route('budgets.show.limit', [$budget->id, $budgetLimit->id])); /** @var Carbon $start */ $start = session('first', today(config('app.timezone'))->startOfYear()); $end = today(config('app.timezone')); $attachments = $this->repository->getAttachments($budget); $limits = $this->getLimits($budget, $start, $end); return view('budgets.show', ['limits' => $limits, 'attachments' => $attachments, 'budget' => $budget, 'budgetLimit' => $budgetLimit, 'groups' => $groups, 'subTitle' => $subTitle, 'currencySymbol' => $currencySymbol]); } }