Clean up comments

2025-11-18 15:39:50 +00:00 · 2023-02-22 18:03:31 +01:00
parent 68f398f97c
commit e6dc881f56
119 changed files with 317 additions and 234 deletions
--- a/app/Http/Controllers/Account/ReconcileController.php
+++ b/app/Http/Controllers/Account/ReconcileController.php
@@ -209,7 +209,7 @@ class ReconcileController extends Controller
     *
     * @return RedirectResponse|Redirector|string
     * @throws DuplicateTransactionException
-     *
+     * @throws JsonException
     */
    private function createReconciliation(Account $account, Carbon $start, Carbon $end, string $difference)
    {
--- a/app/Http/Controllers/Admin/UpdateController.php
+++ b/app/Http/Controllers/Admin/UpdateController.php
@@ -63,7 +63,6 @@ class UpdateController extends Controller
     * Show page with update options.
     *
     * @return Factory|View
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Http/Controllers/Admin/UserController.php
+++ b/app/Http/Controllers/Admin/UserController.php
@@ -36,6 +36,8 @@ use Illuminate\Http\RedirectResponse;
 use Illuminate\Routing\Redirector;
 use Illuminate\View\View;
 use Log;
+use Psr\Container\ContainerExceptionInterface;
+use Psr\Container\NotFoundExceptionInterface;

 /**
 * Class UserController.
@@ -142,6 +144,8 @@ class UserController extends Controller
     * Show index of user manager.
     *
     * @return Factory|View
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
     */
    public function index()
    {
--- a/app/Http/Controllers/Auth/LoginController.php
+++ b/app/Http/Controllers/Auth/LoginController.php
@@ -81,7 +81,6 @@ class LoginController extends Controller
    /**
     * Handle a login request to the application.
     *
-     * @param  Request  $request
     *
     * @throws ValidationException
     */
--- a/app/Http/Controllers/Auth/RegisterController.php
+++ b/app/Http/Controllers/Auth/RegisterController.php
@@ -144,7 +144,6 @@ class RegisterController extends Controller
    /**
     * Show the application registration form if the invitation code is valid.
     *
-     * @param  Request  $request
     *
     * @return Factory|View
     * @throws ContainerExceptionInterface
--- a/app/Http/Controllers/Bill/ShowController.php
+++ b/app/Http/Controllers/Bill/ShowController.php
@@ -126,7 +126,6 @@ class ShowController extends Controller
     * @param  Bill  $bill
     *
     * @return Factory|View
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Http/Controllers/Budget/ShowController.php
+++ b/app/Http/Controllers/Budget/ShowController.php
@@ -83,7 +83,6 @@ class ShowController extends Controller
     *
     * @return Factory|View
     * @throws FireflyException
-     * @throws JsonException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
@@ -121,7 +120,6 @@ class ShowController extends Controller
     * @param  Request  $request
     *
     * @return Factory|View
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
@@ -151,8 +149,6 @@ class ShowController extends Controller
     * @param  Budget  $budget
     *
     * @return Factory|View
-     * @throws FireflyException
-     * @throws JsonException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
@@ -190,7 +186,6 @@ class ShowController extends Controller
     *
     * @return Factory|View
     * @throws FireflyException
-     * @throws JsonException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Http/Controllers/Category/IndexController.php
+++ b/app/Http/Controllers/Category/IndexController.php
@@ -69,7 +69,6 @@ class IndexController extends Controller
     * @param  Request  $request
     *
     * @return Factory|View
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Http/Controllers/Category/ShowController.php
+++ b/app/Http/Controllers/Category/ShowController.php
@@ -81,7 +81,6 @@ class ShowController extends Controller
     *
     * @return Factory|View
     * @throws FireflyException
-     * @throws JsonException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
@@ -126,7 +125,6 @@ class ShowController extends Controller
     * @param  Category  $category
     *
     * @return Factory|View
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Http/Controllers/Chart/AccountController.php
+++ b/app/Http/Controllers/Chart/AccountController.php
@@ -180,7 +180,6 @@ class AccountController extends Controller
     * @param  Account  $account
     *
     * @return JsonResponse
-     * @throws JsonException
     */
    public function expenseBudgetAll(AccountRepositoryInterface $repository, Account $account): JsonResponse
    {
@@ -255,7 +254,6 @@ class AccountController extends Controller
     * @param  Account  $account
     *
     * @return JsonResponse
-     * @throws JsonException
     */
    public function expenseCategoryAll(AccountRepositoryInterface $repository, Account $account): JsonResponse
    {
@@ -356,7 +354,6 @@ class AccountController extends Controller
     * @param  Account  $account
     *
     * @return JsonResponse
-     * @throws JsonException
     */
    public function incomeCategoryAll(AccountRepositoryInterface $repository, Account $account): JsonResponse
    {
--- a/app/Http/Controllers/Chart/TransactionController.php
+++ b/app/Http/Controllers/Chart/TransactionController.php
@@ -98,7 +98,6 @@ class TransactionController extends Controller
     * @param  Carbon  $end
     *
     * @return JsonResponse
-     * @throws FireflyException
     */
    public function categories(string $objectType, Carbon $start, Carbon $end)
    {
@@ -152,7 +151,6 @@ class TransactionController extends Controller
     * @param  Carbon  $end
     *
     * @return JsonResponse
-     * @throws FireflyException
     */
    public function destinationAccounts(string $objectType, Carbon $start, Carbon $end)
    {
@@ -206,7 +204,6 @@ class TransactionController extends Controller
     * @param  Carbon  $end
     *
     * @return JsonResponse
-     * @throws FireflyException
     */
    public function sourceAccounts(string $objectType, Carbon $start, Carbon $end)
    {
--- a/app/Http/Controllers/CurrencyController.php
+++ b/app/Http/Controllers/CurrencyController.php
@@ -326,7 +326,6 @@ class CurrencyController extends Controller
     * @param  Request  $request
     *
     * @return Factory|View
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Http/Controllers/DebugController.php
+++ b/app/Http/Controllers/DebugController.php
@@ -81,6 +81,7 @@ class DebugController extends Controller
     * @param  Request  $request
     *
     * @return RedirectResponse|Redirector
+     * @throws FireflyException
     */
    public function flush(Request $request)
    {
--- a/app/Http/Controllers/JavascriptController.php
+++ b/app/Http/Controllers/JavascriptController.php
@@ -51,7 +51,6 @@ class JavascriptController extends Controller
     * @param  CurrencyRepositoryInterface  $currencyRepository
     *
     * @return Response
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Http/Controllers/Json/FrontpageController.php
+++ b/app/Http/Controllers/Json/FrontpageController.php
@@ -42,6 +42,7 @@ class FrontpageController extends Controller
     * @param  PiggyBankRepositoryInterface  $repository
     *
     * @return JsonResponse
+     * @throws FireflyException
     */
    public function piggyBanks(PiggyBankRepositoryInterface $repository): JsonResponse
    {
--- a/app/Http/Controllers/Json/RuleController.php
+++ b/app/Http/Controllers/Json/RuleController.php
@@ -41,6 +41,7 @@ class RuleController extends Controller
     * @param  Request  $request
     *
     * @return JsonResponse
+     * @throws FireflyException
     */
    public function action(Request $request): JsonResponse
    {
@@ -67,6 +68,7 @@ class RuleController extends Controller
     * @param  Request  $request
     *
     * @return JsonResponse
+     * @throws FireflyException
     */
    public function trigger(Request $request): JsonResponse
    {
--- a/app/Http/Controllers/PiggyBank/ShowController.php
+++ b/app/Http/Controllers/PiggyBank/ShowController.php
@@ -25,6 +25,7 @@ declare(strict_types=1);
 namespace FireflyIII\Http\Controllers\PiggyBank;

 use Carbon\Carbon;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Http\Controllers\Controller;
 use FireflyIII\Models\PiggyBank;
 use FireflyIII\Repositories\PiggyBank\PiggyBankRepositoryInterface;
@@ -67,6 +68,8 @@ class ShowController extends Controller
     * @param  PiggyBank  $piggyBank
     *
     * @return Factory|View
+     * @throws FireflyException
+     * @throws \JsonException
     */
    public function show(PiggyBank $piggyBank)
    {
--- a/app/Http/Controllers/Popup/ReportController.php
+++ b/app/Http/Controllers/Popup/ReportController.php
@@ -23,6 +23,7 @@ declare(strict_types=1);

 namespace FireflyIII\Http\Controllers\Popup;

+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Http\Controllers\Controller;
 use FireflyIII\Support\Http\Controllers\RenderPartialViews;
 use Illuminate\Http\JsonResponse;
@@ -42,7 +43,7 @@ class ReportController extends Controller
     * @param  Request  $request
     *
     * @return JsonResponse
-     *
+     * @throws FireflyException
     */
    public function general(Request $request): JsonResponse
    {
--- a/app/Http/Controllers/ProfileController.php
+++ b/app/Http/Controllers/ProfileController.php
@@ -216,7 +216,6 @@ class ProfileController extends Controller
    /**
     * Delete 2FA routine.
     *
-     * @return RedirectResponse|Redirector
     */
    public function deleteCode(Request $request): RedirectResponse|Redirector
    {
@@ -245,7 +244,6 @@ class ProfileController extends Controller
    /**
     * Enable 2FA screen.
     *
-     * @return RedirectResponse|Redirector
     */
    public function enable2FA(Request $request): RedirectResponse|Redirector
    {
@@ -643,7 +641,7 @@ class ProfileController extends Controller
     * @param  Request  $request
     *
     * @return RedirectResponse|Redirector
-     * @throws FireflyException
+     * @throws \Exception
     */
    public function regenerate(Request $request)
    {
--- a/app/Http/Controllers/Report/AccountController.php
+++ b/app/Http/Controllers/Report/AccountController.php
@@ -45,6 +45,7 @@ class AccountController extends Controller
     * @param  Carbon  $end
     *
     * @return mixed|string
+     * @throws FireflyException
     */
    public function general(Collection $accounts, Carbon $start, Carbon $end)
    {
--- a/app/Http/Controllers/Report/BalanceController.php
+++ b/app/Http/Controllers/Report/BalanceController.php
@@ -67,6 +67,7 @@ class BalanceController extends Controller
     * @param  Carbon  $end
     *
     * @return string
+     * @throws FireflyException
     */
    public function general(Collection $accounts, Carbon $start, Carbon $end)
    {
--- a/app/Http/Controllers/Report/BillController.php
+++ b/app/Http/Controllers/Report/BillController.php
@@ -43,6 +43,7 @@ class BillController extends Controller
     * @param  Carbon  $end
     *
     * @return mixed|string
+     * @throws FireflyException
     */
    public function overview(Collection $accounts, Carbon $start, Carbon $end)
    {   // chart properties for cache:
--- a/app/Http/Controllers/Report/BudgetController.php
+++ b/app/Http/Controllers/Report/BudgetController.php
@@ -74,6 +74,8 @@ class BudgetController extends Controller
     * @param  Carbon  $end
     *
     * @return Factory|View
+     * @throws FireflyException
+     * @throws JsonException
     */
    public function accountPerBudget(Collection $accounts, Collection $budgets, Carbon $start, Carbon $end)
    {
@@ -155,6 +157,7 @@ class BudgetController extends Controller
     * @param  Carbon  $end
     *
     * @return string
+     * @throws FireflyException
     */
    public function avgExpenses(Collection $accounts, Collection $budgets, Carbon $start, Carbon $end)
    {
@@ -276,6 +279,8 @@ class BudgetController extends Controller
     * @param  Carbon  $end
     *
     * @return string
+     * @throws FireflyException
+     * @throws JsonException
     */
    public function general(Collection $accounts, Carbon $start, Carbon $end)
    {
@@ -301,7 +306,7 @@ class BudgetController extends Controller
     * @param  Carbon  $end
     *
     * @return mixed|string
-     * @throws JsonException
+     * @throws FireflyException
     */
    public function period(Collection $accounts, Carbon $start, Carbon $end)
    {
@@ -365,6 +370,7 @@ class BudgetController extends Controller
     * @param  Carbon  $end
     *
     * @return string
+     * @throws FireflyException
     */
    public function topExpenses(Collection $accounts, Collection $budgets, Carbon $start, Carbon $end)
    {
--- a/app/Http/Controllers/Report/CategoryController.php
+++ b/app/Http/Controllers/Report/CategoryController.php
@@ -278,6 +278,7 @@ class CategoryController extends Controller
     * @param  Carbon  $end
     *
     * @return string
+     * @throws FireflyException
     */
    public function avgExpenses(Collection $accounts, Collection $categories, Carbon $start, Carbon $end)
    {
@@ -330,6 +331,7 @@ class CategoryController extends Controller
     * @param  Carbon  $end
     *
     * @return string
+     * @throws FireflyException
     */
    public function avgIncome(Collection $accounts, Collection $categories, Carbon $start, Carbon $end)
    {
@@ -491,7 +493,7 @@ class CategoryController extends Controller
     * @param  Carbon  $end
     *
     * @return mixed|string
-     * @throws JsonException
+     * @throws FireflyException
     */
    public function expenses(Collection $accounts, Carbon $start, Carbon $end)
    {
@@ -572,7 +574,7 @@ class CategoryController extends Controller
     * @param  Carbon  $end
     *
     * @return string
-     * @throws JsonException
+     * @throws FireflyException
     */
    public function income(Collection $accounts, Carbon $start, Carbon $end): string
    {
@@ -650,6 +652,7 @@ class CategoryController extends Controller
     * @param  Carbon  $end
     *
     * @return string
+     * @throws FireflyException
     */
    public function operations(Collection $accounts, Carbon $start, Carbon $end): string
    {
@@ -691,6 +694,7 @@ class CategoryController extends Controller
     * @param  Carbon  $end
     *
     * @return string
+     * @throws FireflyException
     */
    public function topExpenses(Collection $accounts, Collection $categories, Carbon $start, Carbon $end)
    {
@@ -741,6 +745,7 @@ class CategoryController extends Controller
     * @param  Carbon  $end
     *
     * @return string
+     * @throws FireflyException
     */
    public function topIncome(Collection $accounts, Collection $categories, Carbon $start, Carbon $end)
    {
--- a/app/Http/Controllers/Report/DoubleController.php
+++ b/app/Http/Controllers/Report/DoubleController.php
@@ -77,6 +77,7 @@ class DoubleController extends Controller
     * @param  Carbon  $end
     *
     * @return string
+     * @throws FireflyException
     */
    public function avgExpenses(Collection $accounts, Collection $doubles, Carbon $start, Carbon $end)
    {
@@ -129,6 +130,7 @@ class DoubleController extends Controller
     * @param  Carbon  $end
     *
     * @return string
+     * @throws FireflyException
     */
    public function avgIncome(Collection $accounts, Collection $doubles, Carbon $start, Carbon $end)
    {
@@ -425,6 +427,7 @@ class DoubleController extends Controller
     * @param  Carbon  $end
     *
     * @return string
+     * @throws FireflyException
     */
    public function topExpenses(Collection $accounts, Collection $doubles, Carbon $start, Carbon $end)
    {
@@ -475,6 +478,7 @@ class DoubleController extends Controller
     * @param  Carbon  $end
     *
     * @return string
+     * @throws FireflyException
     */
    public function topIncome(Collection $accounts, Collection $doubles, Carbon $start, Carbon $end)
    {
--- a/app/Http/Controllers/Report/OperationsController.php
+++ b/app/Http/Controllers/Report/OperationsController.php
@@ -67,6 +67,7 @@ class OperationsController extends Controller
     * @param  Carbon  $end
     *
     * @return mixed|string
+     * @throws FireflyException
     */
    public function expenses(Collection $accounts, Carbon $start, Carbon $end)
    {
@@ -102,6 +103,7 @@ class OperationsController extends Controller
     * @param  Carbon  $end
     *
     * @return string
+     * @throws FireflyException
     */
    public function income(Collection $accounts, Carbon $start, Carbon $end): string
    {
@@ -137,6 +139,7 @@ class OperationsController extends Controller
     * @param  Carbon  $end
     *
     * @return mixed|string
+     * @throws FireflyException
     */
    public function operations(Collection $accounts, Carbon $start, Carbon $end)
    {
--- a/app/Http/Controllers/Report/TagController.php
+++ b/app/Http/Controllers/Report/TagController.php
@@ -270,6 +270,7 @@ class TagController extends Controller
     * @param  Carbon  $end
     *
     * @return string
+     * @throws FireflyException
     */
    public function avgExpenses(Collection $accounts, Collection $tags, Carbon $start, Carbon $end)
    {
@@ -322,6 +323,7 @@ class TagController extends Controller
     * @param  Carbon  $end
     *
     * @return string
+     * @throws FireflyException
     */
    public function avgIncome(Collection $accounts, Collection $tags, Carbon $start, Carbon $end)
    {
@@ -482,6 +484,7 @@ class TagController extends Controller
     * @param  Carbon  $end
     *
     * @return string
+     * @throws FireflyException
     */
    public function topExpenses(Collection $accounts, Collection $tags, Carbon $start, Carbon $end)
    {
@@ -532,6 +535,7 @@ class TagController extends Controller
     * @param  Carbon  $end
     *
     * @return string
+     * @throws FireflyException
     */
    public function topIncome(Collection $accounts, Collection $tags, Carbon $start, Carbon $end)
    {
--- a/app/Http/Controllers/ReportController.php
+++ b/app/Http/Controllers/ReportController.php
@@ -265,7 +265,6 @@ class ReportController extends Controller
     * @param  AccountRepositoryInterface  $repository
     *
     * @return Factory|View
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
@@ -309,7 +308,7 @@ class ReportController extends Controller
     * @param  string  $reportType
     *
     * @return JsonResponse
-     *
+     * @throws FireflyException
     */
    public function options(string $reportType)
    {
--- a/app/Http/Controllers/Rule/CreateController.php
+++ b/app/Http/Controllers/Rule/CreateController.php
@@ -23,6 +23,7 @@ declare(strict_types=1);

 namespace FireflyIII\Http\Controllers\Rule;

+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Http\Controllers\Controller;
 use FireflyIII\Http\Requests\RuleFormRequest;
 use FireflyIII\Models\Bill;
@@ -77,6 +78,7 @@ class CreateController extends Controller
     * @param  RuleGroup|null  $ruleGroup
     *
     * @return Factory|View
+     * @throws FireflyException
     */
    public function create(Request $request, RuleGroup $ruleGroup = null)
    {
@@ -139,6 +141,7 @@ class CreateController extends Controller
     * @param  Bill  $bill
     *
     * @return Factory|View
+     * @throws FireflyException
     */
    public function createFromBill(Request $request, Bill $bill)
    {
@@ -190,6 +193,7 @@ class CreateController extends Controller
     * @param  TransactionJournal  $journal
     *
     * @return Factory|\Illuminate\Contracts\View\View
+     * @throws FireflyException
     */
    public function createFromJournal(Request $request, TransactionJournal $journal)
    {
--- a/app/Http/Controllers/Rule/EditController.php
+++ b/app/Http/Controllers/Rule/EditController.php
@@ -78,6 +78,7 @@ class EditController extends Controller
     * @param  Rule  $rule
     *
     * @return Factory|View
+     * @throws FireflyException
     */
    public function edit(Request $request, Rule $rule)
    {
@@ -142,6 +143,7 @@ class EditController extends Controller
     * @param  array  $submittedOperators
     *
     * @return array
+     * @throws FireflyException
     */
    private function parseFromOperators(array $submittedOperators): array
    {
--- a/app/Http/Controllers/Rule/SelectController.php
+++ b/app/Http/Controllers/Rule/SelectController.php
@@ -132,7 +132,7 @@ class SelectController extends Controller
     * @param  TestRuleFormRequest  $request
     *
     * @return JsonResponse
-     *
+     * @throws FireflyException
     */
    public function testTriggers(TestRuleFormRequest $request): JsonResponse
    {
@@ -194,7 +194,7 @@ class SelectController extends Controller
     * @param  Rule  $rule
     *
     * @return JsonResponse
-     *
+     * @throws FireflyException
     */
    public function testTriggersByRule(Rule $rule): JsonResponse
    {
--- a/app/Http/Controllers/SearchController.php
+++ b/app/Http/Controllers/SearchController.php
@@ -103,6 +103,7 @@ class SearchController extends Controller
     * @param  SearchInterface  $searcher
     *
     * @return JsonResponse
+     * @throws FireflyException
     */
    public function search(Request $request, SearchInterface $searcher): JsonResponse
    {
--- a/app/Http/Controllers/TagController.php
+++ b/app/Http/Controllers/TagController.php
@@ -280,7 +280,6 @@ class TagController extends Controller
     * @param  Tag  $tag
     *
     * @return Factory|View
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Http/Controllers/Transaction/IndexController.php
+++ b/app/Http/Controllers/Transaction/IndexController.php
@@ -134,7 +134,6 @@ class IndexController extends Controller
     * @param  string  $objectType
     *
     * @return Factory|View
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Http/Controllers/Webhooks/DeleteController.php
+++ b/app/Http/Controllers/Webhooks/DeleteController.php
@@ -62,7 +62,7 @@ class DeleteController extends Controller
     *
     * @param  Webhook  $webhook
     *
-     * @return Factory|RedirectResponse|Redirector|View
+     * @return Factory|\Illuminate\Contracts\Foundation\Application|\Illuminate\Contracts\View\View
     */
    public function index(Webhook $webhook)
    {
--- a/app/Http/Controllers/Webhooks/EditController.php
+++ b/app/Http/Controllers/Webhooks/EditController.php
@@ -61,7 +61,7 @@ class EditController extends Controller
     *
     * @param  Webhook  $webhook
     *
-     * @return Factory|RedirectResponse|Redirector|View
+     * @return Factory|\Illuminate\Contracts\Foundation\Application|\Illuminate\Contracts\View\View
     */
    public function index(Webhook $webhook)
    {
--- a/app/Http/Controllers/Webhooks/IndexController.php
+++ b/app/Http/Controllers/Webhooks/IndexController.php
@@ -59,7 +59,6 @@ class IndexController extends Controller
     * @param  Request  $request
     *
     * @return Factory|View
-     * @throws FireflyException
     */
    public function index(Request $request)
    {
--- a/app/Http/Controllers/Webhooks/ShowController.php
+++ b/app/Http/Controllers/Webhooks/ShowController.php
@@ -61,7 +61,7 @@ class ShowController extends Controller
     *
     * @param  Webhook  $webhook
     *
-     * @return Factory|RedirectResponse|Redirector|View
+     * @return Factory|\Illuminate\Contracts\Foundation\Application|\Illuminate\Contracts\View\View
     */
    public function index(Webhook $webhook)
    {