Rector code cleanup

2025-10-22 20:16:22 +00:00 · 2025-05-24 16:39:20 +02:00
parent 6a82a813e0
commit 6e5a08245c
62 changed files with 172 additions and 115 deletions
--- a/app/Api/V1/Controllers/Autocomplete/TransactionController.php
+++ b/app/Api/V1/Controllers/Autocomplete/TransactionController.php
@@ -24,6 +24,7 @@ declare(strict_types=1);

 namespace FireflyIII\Api\V1\Controllers\Autocomplete;

+use FireflyIII\Models\TransactionGroup;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Autocomplete\AutocompleteRequest;
 use FireflyIII\Enums\UserRoleEnum;
@@ -102,7 +103,7 @@ class TransactionController extends Controller
        if (is_numeric($data['query'])) {
            // search for group, not journal.
            $firstResult = $this->groupRepository->find((int) $data['query']);
-            if (null !== $firstResult) {
+            if ($firstResult instanceof TransactionGroup) {
                // group may contain multiple journals, each a result:
                foreach ($firstResult->transactionJournals as $journal) {
                    $result->push($journal);
--- a/app/Api/V1/Controllers/Chart/AccountController.php
+++ b/app/Api/V1/Controllers/Chart/AccountController.php
@@ -24,6 +24,7 @@ declare(strict_types=1);

 namespace FireflyIII\Api\V1\Controllers\Chart;

+use FireflyIII\Models\TransactionCurrency;
 use Carbon\Carbon;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Chart\ChartRequest;
@@ -99,7 +100,7 @@ class AccountController extends Controller
    private function renderAccountData(array $params, Account $account): void
    {
        $currency     = $this->repository->getAccountCurrency($account);
-        if (null === $currency) {
+        if (!$currency instanceof TransactionCurrency) {
            $currency = $this->default;
        }
        $currentSet   = [
--- a/app/Api/V1/Controllers/Models/CurrencyExchangeRate/DestroyController.php
+++ b/app/Api/V1/Controllers/Models/CurrencyExchangeRate/DestroyController.php
@@ -24,6 +24,7 @@ declare(strict_types=1);

 namespace FireflyIII\Api\V1\Controllers\Models\CurrencyExchangeRate;

+use Carbon\Carbon;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Models\CurrencyExchangeRate\DestroyRequest;
 use FireflyIII\Enums\UserRoleEnum;
@@ -59,11 +60,11 @@ class DestroyController extends Controller
    public function destroy(DestroyRequest $request, TransactionCurrency $from, TransactionCurrency $to): JsonResponse
    {
        $date = $request->getDate();
-        if (null === $date) {
+        if (!$date instanceof Carbon) {
            throw new ValidationException('Date is required');
        }
        $rate = $this->repository->getSpecificRateOnDate($from, $to, $date);
-        if (null === $rate) {
+        if (!$rate instanceof CurrencyExchangeRate) {
            throw new NotFoundHttpException();
        }
        $this->repository->deleteRate($rate);
--- a/app/Api/V1/Controllers/Models/CurrencyExchangeRate/StoreController.php
+++ b/app/Api/V1/Controllers/Models/CurrencyExchangeRate/StoreController.php
@@ -24,6 +24,7 @@ declare(strict_types=1);

 namespace FireflyIII\Api\V1\Controllers\Models\CurrencyExchangeRate;

+use FireflyIII\Models\CurrencyExchangeRate;
 use FireflyIII\Api\V1\Requests\Models\CurrencyExchangeRate\StoreRequest;
 use FireflyIII\Api\V2\Controllers\Controller;
 use FireflyIII\Repositories\ExchangeRate\ExchangeRateRepositoryInterface;
@@ -61,11 +62,11 @@ class StoreController extends Controller

        // already has rate?
        $object      = $this->repository->getSpecificRateOnDate($from, $to, $date);
-        if (null !== $object) {
+        if ($object instanceof CurrencyExchangeRate) {
            // just update it, no matter.
            $rate = $this->repository->updateExchangeRate($object, $rate, $date);
        }
-        if (null === $object) {
+        if (!$object instanceof CurrencyExchangeRate) {
            // store new
            $rate = $this->repository->storeExchangeRate($from, $to, $rate, $date);
        }
--- a/app/Api/V1/Controllers/Models/RuleGroup/TriggerController.php
+++ b/app/Api/V1/Controllers/Models/RuleGroup/TriggerController.php
@@ -24,6 +24,7 @@ declare(strict_types=1);

 namespace FireflyIII\Api\V1\Controllers\Models\RuleGroup;

+use Exception;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Models\RuleGroup\TestRequest;
 use FireflyIII\Api\V1\Requests\Models\RuleGroup\TriggerRequest;
@@ -128,7 +129,7 @@ class TriggerController extends Controller
     *
     * Execute the given rule group on a set of existing transactions.
     *
-     * @throws \Exception
+     * @throws Exception
     */
    public function triggerGroup(TriggerRequest $request, RuleGroup $group): JsonResponse
    {
--- a/app/Api/V1/Controllers/Models/TransactionCurrency/DestroyController.php
+++ b/app/Api/V1/Controllers/Models/TransactionCurrency/DestroyController.php
@@ -24,6 +24,7 @@ declare(strict_types=1);

 namespace FireflyIII\Api\V1\Controllers\Models\TransactionCurrency;

+use Validator;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\TransactionCurrency;
@@ -74,15 +75,15 @@ class DestroyController extends Controller
        if (!$this->userRepository->hasRole($admin, 'owner')) {
            // access denied:
            $messages = ['currency_code' => '200005: You need the "owner" role to do this.'];
-            \Validator::make([], $rules, $messages)->validate();
+            Validator::make([], $rules, $messages)->validate();
        }
        if ($this->repository->currencyInUse($currency)) {
            $messages = ['currency_code' => '200006: Currency in use.'];
-            \Validator::make([], $rules, $messages)->validate();
+            Validator::make([], $rules, $messages)->validate();
        }
        if ($this->repository->isFallbackCurrency($currency)) {
            $messages = ['currency_code' => '200026: Currency is fallback.'];
-            \Validator::make([], $rules, $messages)->validate();
+            Validator::make([], $rules, $messages)->validate();
        }

        $this->repository->destroy($currency);
--- a/app/Api/V1/Controllers/Models/TransactionLink/StoreController.php
+++ b/app/Api/V1/Controllers/Models/TransactionLink/StoreController.php
@@ -24,6 +24,7 @@ declare(strict_types=1);

 namespace FireflyIII\Api\V1\Controllers\Models\TransactionLink;

+use FireflyIII\Models\TransactionJournal;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Models\TransactionLink\StoreRequest;
 use FireflyIII\Exceptions\FireflyException;
@@ -81,7 +82,7 @@ class StoreController extends Controller
        $data              = $request->getAll();
        $inward            = $this->journalRepository->find($data['inward_id'] ?? 0);
        $outward           = $this->journalRepository->find($data['outward_id'] ?? 0);
-        if (null === $inward || null === $outward) {
+        if (!$inward instanceof TransactionJournal || !$outward instanceof TransactionJournal) {
            throw new FireflyException('200024: Source or destination does not exist.');
        }
        $data['direction'] = 'inward';
--- a/app/Api/V1/Controllers/Models/TransactionLinkType/StoreController.php
+++ b/app/Api/V1/Controllers/Models/TransactionLinkType/StoreController.php
@@ -24,6 +24,7 @@ declare(strict_types=1);

 namespace FireflyIII\Api\V1\Controllers\Models\TransactionLinkType;

+use Validator;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Models\TransactionLinkType\StoreRequest;
 use FireflyIII\Exceptions\FireflyException;
@@ -81,7 +82,7 @@ class StoreController extends Controller
        if (!$this->userRepository->hasRole($admin, 'owner')) {
            // access denied:
            $messages = ['name' => '200005: You need the "owner" role to do this.'];
-            \Validator::make([], $rules, $messages)->validate();
+            Validator::make([], $rules, $messages)->validate();
        }
        $data        = $request->getAll();
        // if currency ID is 0, find the currency by the code:
--- a/app/Api/V1/Controllers/Models/TransactionLinkType/UpdateController.php
+++ b/app/Api/V1/Controllers/Models/TransactionLinkType/UpdateController.php
@@ -24,6 +24,7 @@ declare(strict_types=1);

 namespace FireflyIII\Api\V1\Controllers\Models\TransactionLinkType;

+use Validator;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Models\TransactionLinkType\UpdateRequest;
 use FireflyIII\Exceptions\FireflyException;
@@ -85,7 +86,7 @@ class UpdateController extends Controller

        if (!$this->userRepository->hasRole($admin, 'owner')) {
            $messages = ['name' => '200005: You need the "owner" role to do this.'];
-            \Validator::make([], $rules, $messages)->validate();
+            Validator::make([], $rules, $messages)->validate();
        }

        $data        = $request->getAll();
--- a/app/Api/V1/Controllers/Summary/BasicController.php
+++ b/app/Api/V1/Controllers/Summary/BasicController.php
@@ -24,6 +24,7 @@ declare(strict_types=1);

 namespace FireflyIII\Api\V1\Controllers\Summary;

+use Exception;
 use Carbon\Carbon;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Data\DateRequest;
@@ -91,7 +92,7 @@ class BasicController extends Controller
     * This endpoint is documented at:
     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/summary/getBasicSummary
     *
-     * @throws \Exception
+     * @throws Exception
     */
    public function basic(DateRequest $request): JsonResponse
    {
@@ -467,7 +468,7 @@ class BasicController extends Controller
    }

    /**
-     * @throws \Exception
+     * @throws Exception
     */
    private function getLeftToSpendInfo(Carbon $start, Carbon $end): array
    {
@@ -674,15 +675,14 @@ class BasicController extends Controller
     */
    protected function notInDateRange(Carbon $date, Carbon $start, Carbon $end): bool // Validate a preference
    {
-        $result = false;
        if ($start->greaterThanOrEqualTo($date) && $end->greaterThanOrEqualTo($date)) {
-            $result = true;
+            return true;
        }
        // start and end in the past? use $end
        if ($start->lessThanOrEqualTo($date) && $end->lessThanOrEqualTo($date)) {
-            $result = true;
+            return true;
        }

-        return $result;
+        return false;
    }
 }
--- a/app/Api/V1/Controllers/System/ConfigurationController.php
+++ b/app/Api/V1/Controllers/System/ConfigurationController.php
@@ -24,6 +24,7 @@ declare(strict_types=1);

 namespace FireflyIII\Api\V1\Controllers\System;

+use Validator;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\System\UpdateRequest;
 use FireflyIII\Exceptions\FireflyException;
@@ -158,7 +159,7 @@ class ConfigurationController extends Controller
        $rules     = ['value' => 'required'];
        if (!$this->repository->hasRole(auth()->user(), 'owner')) {
            $messages = ['value' => '200005: You need the "owner" role to do this.'];
-            \Validator::make([], $rules, $messages)->validate();
+            Validator::make([], $rules, $messages)->validate();
        }
        $data      = $request->getAll();
        $shortName = str_replace('configuration.', '', $name);
--- a/app/Api/V1/Middleware/ApiDemoUser.php
+++ b/app/Api/V1/Middleware/ApiDemoUser.php
@@ -23,6 +23,7 @@ declare(strict_types=1);

 namespace FireflyIII\Api\V1\Middleware;

+use Closure;
 use FireflyIII\User;
 use Illuminate\Http\Request;

@@ -36,7 +37,7 @@ class ApiDemoUser
     *
     * @return mixed
     */
-    public function handle(Request $request, \Closure $next)
+    public function handle(Request $request, Closure $next)
    {
        /** @var null|User $user */
        $user = $request->user();
--- a/app/Api/V1/Requests/Data/Bulk/TransactionRequest.php
+++ b/app/Api/V1/Requests/Data/Bulk/TransactionRequest.php
@@ -24,6 +24,7 @@ declare(strict_types=1);

 namespace FireflyIII\Api\V1\Requests\Data\Bulk;

+use JsonException;
 use FireflyIII\Enums\ClauseType;
 use FireflyIII\Rules\IsValidBulkClause;
 use FireflyIII\Support\Request\ChecksLogin;
@@ -52,7 +53,7 @@ class TransactionRequest extends FormRequest
            $data = [
                'query' => json_decode($this->get('query'), true, 8, JSON_THROW_ON_ERROR),
            ];
-        } catch (\JsonException $e) {
+        } catch (JsonException $e) {
            // dont really care. the validation should catch invalid json.
            app('log')->error($e->getMessage());
        }
--- a/app/Api/V1/Requests/Models/Bill/StoreRequest.php
+++ b/app/Api/V1/Requests/Models/Bill/StoreRequest.php
@@ -24,6 +24,8 @@ declare(strict_types=1);

 namespace FireflyIII\Api\V1\Requests\Models\Bill;

+use ValueError;
+use TypeError;
 use FireflyIII\Rules\IsBoolean;
 use FireflyIII\Rules\IsValidPositiveAmount;
 use FireflyIII\Support\Request\ChecksLogin;
@@ -109,7 +111,7 @@ class StoreRequest extends FormRequest

                try {
                    $result = bccomp($min, $max);
-                } catch (\ValueError $e) {
+                } catch (ValueError $e) {
                    Log::error($e->getMessage());
                    $validator->errors()->add('amount_min', (string) trans('validation.generic_invalid'));
                    $validator->errors()->add('amount_max', (string) trans('validation.generic_invalid'));
@@ -124,7 +126,7 @@ class StoreRequest extends FormRequest

        try {
            $failed = $validator->fails();
-        } catch (\TypeError $e) {
+        } catch (TypeError $e) {
            Log::error($e->getMessage());
            $failed = false;
        }
--- a/app/Api/V1/Requests/System/CronRequest.php
+++ b/app/Api/V1/Requests/System/CronRequest.php
@@ -24,6 +24,7 @@ declare(strict_types=1);

 namespace FireflyIII\Api\V1\Requests\System;

+use Carbon\Carbon;
 use FireflyIII\Support\Request\ConvertsDataTypes;
 use Illuminate\Foundation\Http\FormRequest;

@@ -58,7 +59,7 @@ class CronRequest extends FormRequest
            $data['date'] = $this->getCarbonDate('date');
        }
        // catch NULL.
-        if (null === $data['date']) {
+        if (!$data['date'] instanceof Carbon) {
            $data['date'] = today(config('app.timezone'));
        }

--- a/app/Api/V2/Controllers/Autocomplete/AccountController.php
+++ b/app/Api/V2/Controllers/Autocomplete/AccountController.php
@@ -90,7 +90,7 @@ class AccountController extends Controller
            'meta'  => [
                'type'                    => $account->accountType->type,
                // TODO is multi currency property.
-                'currency_id'             => null === $currency ? null : (string) $currency->id,
+                'currency_id'             => $currency instanceof TransactionCurrency ? (string) $currency->id : null,
                'currency_code'           => $currency?->code,
                'currency_symbol'         => $currency?->symbol,
                'currency_decimal_places' => $currency?->decimal_places,
--- a/app/Api/V2/Controllers/Chart/AccountController.php
+++ b/app/Api/V2/Controllers/Chart/AccountController.php
@@ -94,7 +94,7 @@ class AccountController extends Controller
    private function renderAccountData(array $params, Account $account): void
    {
        $currency       = $this->repository->getAccountCurrency($account);
-        if (null === $currency) {
+        if (!$currency instanceof TransactionCurrency) {
            $currency = $this->default;
        }
        $currentSet     = [
--- a/app/Api/V2/Controllers/Controller.php
+++ b/app/Api/V2/Controllers/Controller.php
@@ -117,7 +117,7 @@ class Controller extends BaseController
                    app('log')->warning(sprintf('Ignored invalid date "%s" in API v2 controller parameter check: %s', substr((string) $date, 0, 20), $e->getMessage()));
                }
                // out of range? set to null.
-                if (null !== $obj && ($obj->year <= 1900 || $obj->year > 2099)) {
+                if ($obj instanceof Carbon && ($obj->year <= 1900 || $obj->year > 2099)) {
                    app('log')->warning(sprintf('Refuse to use date "%s" in API v2 controller parameter check: %s', $field, $obj->toAtomString()));
                    $obj = null;
                }
--- a/app/Api/V2/Controllers/Summary/BasicController.php
+++ b/app/Api/V2/Controllers/Summary/BasicController.php
@@ -24,6 +24,7 @@ declare(strict_types=1);

 namespace FireflyIII\Api\V2\Controllers\Summary;

+use Exception;
 use Carbon\Carbon;
 use FireflyIII\Api\V2\Controllers\Controller;
 use FireflyIII\Api\V2\Request\Generic\DateRequest;
@@ -92,7 +93,7 @@ class BasicController extends Controller
     * This endpoint is documented at:
     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v2)#/summary/getBasicSummary
     *
-     * @throws \Exception
+     * @throws Exception
     *
     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
     */
@@ -398,15 +399,14 @@ class BasicController extends Controller
     */
    protected function notInDateRange(Carbon $date, Carbon $start, Carbon $end): bool // Validate a preference
    {
-        $result = false;
        if ($start->greaterThanOrEqualTo($date) && $end->greaterThanOrEqualTo($date)) {
-            $result = true;
+            return true;
        }
        // start and end in the past? use $end
        if ($start->lessThanOrEqualTo($date) && $end->lessThanOrEqualTo($date)) {
-            $result = true;
+            return true;
        }

-        return $result;
+        return false;
    }
 }
--- a/app/Api/V2/Controllers/Transaction/List/AccountController.php
+++ b/app/Api/V2/Controllers/Transaction/List/AccountController.php
@@ -24,6 +24,7 @@ declare(strict_types=1);

 namespace FireflyIII\Api\V2\Controllers\Transaction\List;

+use Carbon\Carbon;
 use FireflyIII\Api\V2\Controllers\Controller;
 use FireflyIII\Api\V2\Request\Model\Transaction\ListRequest;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
@@ -62,11 +63,11 @@ class AccountController extends Controller

        $start     = $request->getStartDate();
        $end       = $request->getEndDate();
-        if (null !== $start) {
+        if ($start instanceof Carbon) {
            app('log')->debug(sprintf('Set start date to %s', $start->toIso8601String()));
            $collector->setStart($start);
        }
-        if (null !== $end) {
+        if ($end instanceof Carbon) {
            app('log')->debug(sprintf('Set end date to %s', $start->toIso8601String()));
            $collector->setEnd($end);
        }
--- a/app/Api/V2/Request/Model/Transaction/InfiniteListRequest.php
+++ b/app/Api/V2/Request/Model/Transaction/InfiniteListRequest.php
@@ -53,7 +53,7 @@ class InfiniteListRequest extends FormRequest

        $start = $this->getStartDate();
        $end   = $this->getEndDate();
-        if (null !== $start && null !== $end) {
+        if ($start instanceof Carbon && $end instanceof Carbon) {
            $array['start'] = $start->format('Y-m-d');
            $array['end']   = $end->format('Y-m-d');
        }
--- a/app/Api/V2/Request/Model/Transaction/ListRequest.php
+++ b/app/Api/V2/Request/Model/Transaction/ListRequest.php
@@ -49,7 +49,7 @@ class ListRequest extends FormRequest

        $start = $this->getStartDate();
        $end   = $this->getEndDate();
-        if (null !== $start && null !== $end) {
+        if ($start instanceof Carbon && $end instanceof Carbon) {
            $array['start'] = $start->format('Y-m-d');
            $array['end']   = $end->format('Y-m-d');
        }
--- a/app/Api/V2/Request/Model/Transaction/UpdateRequest.php
+++ b/app/Api/V2/Request/Model/Transaction/UpdateRequest.php
@@ -24,6 +24,7 @@ declare(strict_types=1);

 namespace FireflyIII\Api\V2\Request\Model\Transaction;

+use Override;
 use FireflyIII\Api\V1\Requests\Models\AvailableBudget\Request;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\TransactionGroup;
@@ -64,7 +65,7 @@ class UpdateRequest extends Request
     *
     * @throws FireflyException
     */
-    #[\Override]
+    #[Override]
    public function getAll(): array
    {
        app('log')->debug(sprintf('Now in %s', __METHOD__));
@@ -248,7 +249,7 @@ class UpdateRequest extends Request
    /**
     * The rules that the incoming request must be matched against.
     */
-    #[\Override]
+    #[Override]
    public function rules(): array
    {
        app('log')->debug(sprintf('Now in %s', __METHOD__));
@@ -332,7 +333,7 @@ class UpdateRequest extends Request
    /**
     * Configure the validator instance.
     */
-    #[\Override]
+    #[Override]
    public function withValidator(Validator $validator): void
    {
        app('log')->debug('Now in withValidator');
--- a/app/Api/V2/Response/Sum/AutoSum.php
+++ b/app/Api/V2/Response/Sum/AutoSum.php
@@ -24,6 +24,7 @@ declare(strict_types=1);

 namespace FireflyIII\Api\V2\Response\Sum;

+use Closure;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\TransactionCurrency;
 use Illuminate\Database\Eloquent\Model;
@@ -39,7 +40,7 @@ class AutoSum
    /**
     * @throws FireflyException
     */
-    public function autoSum(Collection $objects, \Closure $getCurrency, \Closure $getSum): array
+    public function autoSum(Collection $objects, Closure $getCurrency, Closure $getSum): array
    {
        $return = [];