run phpcs

This commit is contained in:
James Cole
2025-01-05 07:31:26 +01:00
parent 0f69e0d672
commit c3ffd39450
29 changed files with 112 additions and 94 deletions

View File

@@ -8,7 +8,7 @@ on:
- develop - develop
env: env:
DB_CONNECTION: sqlite DB_CONNECTION: sqlite
APP_KEY: UfpBqqeXx7zpNodsC6yjYQcRfDdm4Bxh APP_KEY: TestTestTestTestTestTestTestTest
jobs: jobs:
sonarcloud: sonarcloud:
name: SonarCloud name: SonarCloud
@@ -46,7 +46,9 @@ jobs:
run: composer install --prefer-dist --no-interaction --no-progress --no-scripts run: composer install --prefer-dist --no-interaction --no-progress --no-scripts
- name: "Create database file" - name: "Create database file"
run: touch storage/database/database.sqlite run: |
touch storage/database/database.sqlite
wget -q https://github.com/firefly-iii/test-fixtures/raw/refs/heads/main/test-database.sqlite -O storage/database/database.sqlite
- name: "Upgrades the database to the latest version" - name: "Upgrades the database to the latest version"
run: php artisan firefly-iii:upgrade-database run: php artisan firefly-iii:upgrade-database

View File

@@ -25,7 +25,6 @@ declare(strict_types=1);
namespace FireflyIII\Api\V1\Controllers; namespace FireflyIII\Api\V1\Controllers;
use Carbon\Carbon; use Carbon\Carbon;
use Carbon\Exceptions\InvalidDateException;
use Carbon\Exceptions\InvalidFormatException; use Carbon\Exceptions\InvalidFormatException;
use FireflyIII\Models\Preference; use FireflyIII\Models\Preference;
use FireflyIII\Models\TransactionCurrency; use FireflyIII\Models\TransactionCurrency;

View File

@@ -64,7 +64,7 @@ class ConvertsDatesToUTC extends Command
// this variable is ALWAYS en_US. // this variable is ALWAYS en_US.
// stops phpstan complaining about dead code. // stops phpstan complaining about dead code.
if (config('app.fallback_locale') === 'en_US') { if ('en_US' === config('app.fallback_locale')) {
return Command::SUCCESS; return Command::SUCCESS;
} }

View File

@@ -111,6 +111,7 @@ class CorrectsAccountTypes extends Command
$this->friendlyLine(sprintf('Found %d journals that need to be fixed.', $resultSet->count())); $this->friendlyLine(sprintf('Found %d journals that need to be fixed.', $resultSet->count()));
foreach ($resultSet as $entry) { foreach ($resultSet as $entry) {
app('log')->debug(sprintf('Now fixing journal #%d', $entry->id)); app('log')->debug(sprintf('Now fixing journal #%d', $entry->id));
/** @var null|TransactionJournal $journal */ /** @var null|TransactionJournal $journal */
$journal = TransactionJournal::find($entry->id); $journal = TransactionJournal::find($entry->id);
if (null !== $journal) { if (null !== $journal) {

View File

@@ -236,7 +236,7 @@ class CorrectsNativeAmounts extends Command
TransactionObserver::$recalculate = false; TransactionObserver::$recalculate = false;
foreach ($set as $item) { foreach ($set as $item) {
// here we are. // here we are.
/** @var Transaction|null $transaction */ /** @var null|Transaction $transaction */
$transaction = Transaction::find($item->id); $transaction = Transaction::find($item->id);
$transaction?->touch(); $transaction?->touch();
} }

View File

@@ -66,7 +66,7 @@ class RemovesEmptyJournals extends Command
if (1 === $count % 2) { if (1 === $count % 2) {
// uneven number, delete journal and transactions: // uneven number, delete journal and transactions:
try { try {
/** @var TransactionJournal|null $journal */ /** @var null|TransactionJournal $journal */
$journal = TransactionJournal::find($row->transaction_journal_id); $journal = TransactionJournal::find($row->transaction_journal_id);
$journal?->delete(); $journal?->delete();
} catch (QueryException $e) { } catch (QueryException $e) {
@@ -89,11 +89,12 @@ class RemovesEmptyJournals extends Command
$set = TransactionJournal::leftJoin('transactions', 'transactions.transaction_journal_id', '=', 'transaction_journals.id') $set = TransactionJournal::leftJoin('transactions', 'transactions.transaction_journal_id', '=', 'transaction_journals.id')
->groupBy('transaction_journals.id') ->groupBy('transaction_journals.id')
->whereNull('transactions.transaction_journal_id') ->whereNull('transactions.transaction_journal_id')
->get(['transaction_journals.id']); ->get(['transaction_journals.id'])
;
foreach ($set as $entry) { foreach ($set as $entry) {
try { try {
/** @var TransactionJournal|null $journal */ /** @var null|TransactionJournal $journal */
$journal = TransactionJournal::find($entry->id); $journal = TransactionJournal::find($entry->id);
$journal?->delete(); $journal?->delete();
} catch (QueryException $e) { } catch (QueryException $e) {

View File

@@ -69,7 +69,7 @@ class RemovesOrphanedTransactions extends Command
} }
$this->friendlyInfo(sprintf('Found %d orphaned journal(s).', $count)); $this->friendlyInfo(sprintf('Found %d orphaned journal(s).', $count));
foreach ($set as $entry) { foreach ($set as $entry) {
/** @var TransactionJournal|null $journal */ /** @var null|TransactionJournal $journal */
$journal = TransactionJournal::withTrashed()->find($entry->id); $journal = TransactionJournal::withTrashed()->find($entry->id);
if (null !== $journal) { if (null !== $journal) {
$journal->delete(); $journal->delete();
@@ -131,7 +131,7 @@ class RemovesOrphanedTransactions extends Command
/** @var Transaction $transaction */ /** @var Transaction $transaction */
foreach ($set as $transaction) { foreach ($set as $transaction) {
// delete journals // delete journals
/** @var TransactionJournal|null $journal */ /** @var null|TransactionJournal $journal */
$journal = TransactionJournal::find($transaction->transaction_journal_id); $journal = TransactionJournal::find($transaction->transaction_journal_id);
if (null !== $journal) { if (null !== $journal) {
$journal->delete(); $journal->delete();

View File

@@ -264,7 +264,8 @@ class ForcesDecimalSize extends Command
$pow = 10 ** $currency->decimal_places; $pow = 10 ** $currency->decimal_places;
$correct = bcdiv((string) round($value * $pow), (string) $pow, 12); $correct = bcdiv((string) round($value * $pow), (string) $pow, 12);
$this->friendlyInfo(sprintf('Account #%d has %s with value "%s", this has been corrected to "%s".', $account->id, $field, $value, $correct)); $this->friendlyInfo(sprintf('Account #%d has %s with value "%s", this has been corrected to "%s".', $account->id, $field, $value, $correct));
/** @var Account|null $updateAccount */
/** @var null|Account $updateAccount */
$updateAccount = Account::find($account->id); $updateAccount = Account::find($account->id);
$updateAccount?->update([$field => $correct]); $updateAccount?->update([$field => $correct]);
} }
@@ -315,7 +316,8 @@ class ForcesDecimalSize extends Command
$pow = 10 ** $currency->decimal_places; $pow = 10 ** $currency->decimal_places;
$correct = bcdiv((string) round($value * $pow), (string) $pow, 12); $correct = bcdiv((string) round($value * $pow), (string) $pow, 12);
$this->friendlyWarning(sprintf('%s #%d has %s with value "%s", this has been corrected to "%s".', $table, $item->id, $field, $value, $correct)); $this->friendlyWarning(sprintf('%s #%d has %s with value "%s", this has been corrected to "%s".', $table, $item->id, $field, $value, $correct));
/** @var Model|null $model */
/** @var null|Model $model */
$model = $class::find($item->id); $model = $class::find($item->id);
$model?->update([$field => $correct]); $model?->update([$field => $correct]);
} }
@@ -369,7 +371,8 @@ class ForcesDecimalSize extends Command
$this->friendlyWarning( $this->friendlyWarning(
sprintf('Piggy bank event #%d has %s with value "%s", this has been corrected to "%s".', $item->id, $field, $value, $correct) sprintf('Piggy bank event #%d has %s with value "%s", this has been corrected to "%s".', $item->id, $field, $value, $correct)
); );
/** @var PiggyBankEvent|null $event */
/** @var null|PiggyBankEvent $event */
$event = PiggyBankEvent::find($item->id); $event = PiggyBankEvent::find($item->id);
$event?->update([$field => $correct]); $event?->update([$field => $correct]);
} }
@@ -424,7 +427,8 @@ class ForcesDecimalSize extends Command
$this->friendlyWarning( $this->friendlyWarning(
sprintf('Piggy bank repetition #%d has %s with value "%s", this has been corrected to "%s".', $item->id, $field, $value, $correct) sprintf('Piggy bank repetition #%d has %s with value "%s", this has been corrected to "%s".', $item->id, $field, $value, $correct)
); );
/** @var PiggyBankRepetition|null $repetition */
/** @var null|PiggyBankRepetition $repetition */
$repetition = PiggyBankRepetition::find($item->id); $repetition = PiggyBankRepetition::find($item->id);
$repetition->update([$field => $correct]); $repetition->update([$field => $correct]);
} }
@@ -475,7 +479,8 @@ class ForcesDecimalSize extends Command
$pow = 10 ** $currency->decimal_places; $pow = 10 ** $currency->decimal_places;
$correct = bcdiv((string) round($value * $pow), (string) $pow, 12); $correct = bcdiv((string) round($value * $pow), (string) $pow, 12);
$this->friendlyWarning(sprintf('Piggy bank #%d has %s with value "%s", this has been corrected to "%s".', $item->id, $field, $value, $correct)); $this->friendlyWarning(sprintf('Piggy bank #%d has %s with value "%s", this has been corrected to "%s".', $item->id, $field, $value, $correct));
/** @var PiggyBank|null $piggyBank */
/** @var null|PiggyBank $piggyBank */
$piggyBank = PiggyBank::find($item->id); $piggyBank = PiggyBank::find($item->id);
$piggyBank?->update([$field => $correct]); $piggyBank?->update([$field => $correct]);
} }
@@ -510,7 +515,8 @@ class ForcesDecimalSize extends Command
$pow = (float) 10 ** $currency->decimal_places; $pow = (float) 10 ** $currency->decimal_places;
$correct = bcdiv((string) round((float) $value * $pow), (string) $pow, 12); $correct = bcdiv((string) round((float) $value * $pow), (string) $pow, 12);
$this->friendlyWarning(sprintf('Transaction #%d has amount with value "%s", this has been corrected to "%s".', $item->id, $value, $correct)); $this->friendlyWarning(sprintf('Transaction #%d has amount with value "%s", this has been corrected to "%s".', $item->id, $value, $correct));
/** @var Transaction|null $transaction */
/** @var null|Transaction $transaction */
$transaction = Transaction::find($item->id); $transaction = Transaction::find($item->id);
$transaction?->update(['amount' => $correct]); $transaction?->update(['amount' => $correct]);
} }
@@ -542,7 +548,8 @@ class ForcesDecimalSize extends Command
$this->friendlyWarning( $this->friendlyWarning(
sprintf('Transaction #%d has foreign amount with value "%s", this has been corrected to "%s".', $item->id, $value, $correct) sprintf('Transaction #%d has foreign amount with value "%s", this has been corrected to "%s".', $item->id, $value, $correct)
); );
/** @var Transaction|null $transaction */
/** @var null|Transaction $transaction */
$transaction = Transaction::find($item->id); $transaction = Transaction::find($item->id);
$transaction?->update(['foreign_amount' => $correct]); $transaction?->update(['foreign_amount' => $correct]);
} }

View File

@@ -53,11 +53,13 @@ class BudgetLimitHandler
private function updateAvailableBudget(BudgetLimit $budgetLimit): void private function updateAvailableBudget(BudgetLimit $budgetLimit): void
{ {
Log::debug(sprintf('Now in updateAvailableBudget(limit #%d)', $budgetLimit->id)); Log::debug(sprintf('Now in updateAvailableBudget(limit #%d)', $budgetLimit->id));
/** @var Budget|null $budget */
/** @var null|Budget $budget */
$budget = Budget::find($budgetLimit->budget_id); $budget = Budget::find($budgetLimit->budget_id);
if (null === $budget) { if (null === $budget) {
Log::warning('Budget is null, probably deleted, find deleted version.'); Log::warning('Budget is null, probably deleted, find deleted version.');
/** @var Budget|null $budget */
/** @var null|Budget $budget */
$budget = Budget::withTrashed()->find($budgetLimit->budget_id); $budget = Budget::withTrashed()->find($budgetLimit->budget_id);
} }
if (null === $budget) { if (null === $budget) {

View File

@@ -251,10 +251,11 @@ trait AccountCollection
if (0 === $accountId) { if (0 === $accountId) {
return false; return false;
} }
// in theory, this could lead to finding other users accounts. // in theory, this could lead to finding other users accounts.
/** @var Account|null $account */ /** @var null|Account $account */
$account = Account::find($accountId); $account = Account::find($accountId);
if(null === $account) { if (null === $account) {
continue; continue;
} }
$balance = Steam::finalAccountBalance($account, $transaction['date']); $balance = Steam::finalAccountBalance($account, $transaction['date']);

View File

@@ -121,6 +121,7 @@ class DebugController extends Controller
echo sprintf('<h2>%s</h2>', $count); echo sprintf('<h2>%s</h2>', $count);
} }
} }
exit; exit;
} }

View File

@@ -28,7 +28,6 @@ use Carbon\Carbon;
use FireflyIII\Http\Controllers\Controller; use FireflyIII\Http\Controllers\Controller;
use FireflyIII\Models\Account; use FireflyIII\Models\Account;
use FireflyIII\Models\PiggyBank; use FireflyIII\Models\PiggyBank;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Repositories\PiggyBank\PiggyBankRepositoryInterface; use FireflyIII\Repositories\PiggyBank\PiggyBankRepositoryInterface;
use Illuminate\Contracts\View\Factory; use Illuminate\Contracts\View\Factory;
use Illuminate\Http\RedirectResponse; use Illuminate\Http\RedirectResponse;

View File

@@ -28,7 +28,6 @@ use FireflyIII\Helpers\Attachments\AttachmentHelperInterface;
use FireflyIII\Http\Controllers\Controller; use FireflyIII\Http\Controllers\Controller;
use FireflyIII\Http\Requests\PiggyBankUpdateRequest; use FireflyIII\Http\Requests\PiggyBankUpdateRequest;
use FireflyIII\Models\PiggyBank; use FireflyIII\Models\PiggyBank;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Repositories\PiggyBank\PiggyBankRepositoryInterface; use FireflyIII\Repositories\PiggyBank\PiggyBankRepositoryInterface;
use Illuminate\Contracts\View\Factory; use Illuminate\Contracts\View\Factory;
use Illuminate\Http\RedirectResponse; use Illuminate\Http\RedirectResponse;

View File

@@ -42,6 +42,7 @@ class CreateController extends Controller
app('log')->debug(sprintf('Now at %s', __METHOD__)); app('log')->debug(sprintf('Now at %s', __METHOD__));
return view('administrations.create') // @phpstan-ignore-line return view('administrations.create') // @phpstan-ignore-line
->with(compact('title', 'subTitle', 'mainTitleIcon')); ->with(compact('title', 'subTitle', 'mainTitleIcon'))
;
} }
} }

View File

@@ -43,6 +43,7 @@ class EditController extends Controller
app('log')->debug(sprintf('Now at %s', __METHOD__)); app('log')->debug(sprintf('Now at %s', __METHOD__));
return view('administrations.edit') // @phpstan-ignore-line return view('administrations.edit') // @phpstan-ignore-line
->with(compact('title', 'subTitle', 'mainTitleIcon')); ->with(compact('title', 'subTitle', 'mainTitleIcon'))
;
} }
} }

View File

@@ -47,7 +47,7 @@ class UserRegistration extends Notification
private User $user; private User $user;
public function __construct( User $user) public function __construct(User $user)
{ {
$this->user = $user; $this->user = $user;
} }

View File

@@ -34,13 +34,13 @@ class UserPolicy
public function view(User $user, User $user1): bool public function view(User $user, User $user1): bool
{ {
return true; return true;
// return auth()->check() && $user->id === $account->user_id; // return auth()->check() && $user->id === $account->user_id;
} }
public function viewAccounts(User $user): bool public function viewAccounts(User $user): bool
{ {
return true; return true;
// return auth()->check(); // return auth()->check();
} }
/** /**
@@ -51,6 +51,6 @@ class UserPolicy
public function viewAny(): bool public function viewAny(): bool
{ {
return true; return true;
// return auth()->check(); // return auth()->check();
} }
} }

View File

@@ -524,7 +524,7 @@ class AccountRepository implements AccountRepositoryInterface
->first(['transaction_journals.id']) ->first(['transaction_journals.id'])
; ;
if (null !== $first) { if (null !== $first) {
/** @var TransactionJournal|null */ /** @var null|TransactionJournal */
return TransactionJournal::find($first->id); return TransactionJournal::find($first->id);
} }

View File

@@ -325,7 +325,8 @@ trait ModifiesPiggyBanks
->where('accounts.user_id', $this->user->id) ->where('accounts.user_id', $this->user->id)
->where('piggy_banks.order', '<=', $newOrder)->where('piggy_banks.order', '>', $oldOrder) ->where('piggy_banks.order', '<=', $newOrder)->where('piggy_banks.order', '>', $oldOrder)
->where('piggy_banks.id', '!=', $piggyBank->id) ->where('piggy_banks.id', '!=', $piggyBank->id)
->distinct()->decrement('piggy_banks.order'); ->distinct()->decrement('piggy_banks.order')
;
$piggyBank->order = $newOrder; $piggyBank->order = $newOrder;
Log::debug(sprintf('[1] Order of piggy #%d ("%s") from %d to %d', $piggyBank->id, $piggyBank->name, $oldOrder, $newOrder)); Log::debug(sprintf('[1] Order of piggy #%d ("%s") from %d to %d', $piggyBank->id, $piggyBank->name, $oldOrder, $newOrder));
@@ -338,7 +339,8 @@ trait ModifiesPiggyBanks
->where('accounts.user_id', $this->user->id) ->where('accounts.user_id', $this->user->id)
->where('piggy_banks.order', '>=', $newOrder)->where('piggy_banks.order', '<', $oldOrder) ->where('piggy_banks.order', '>=', $newOrder)->where('piggy_banks.order', '<', $oldOrder)
->where('piggy_banks.id', '!=', $piggyBank->id) ->where('piggy_banks.id', '!=', $piggyBank->id)
->distinct()->increment('piggy_banks.order'); ->distinct()->increment('piggy_banks.order')
;
$piggyBank->order = $newOrder; $piggyBank->order = $newOrder;
Log::debug(sprintf('[2] Order of piggy #%d ("%s") from %d to %d', $piggyBank->id, $piggyBank->name, $oldOrder, $newOrder)); Log::debug(sprintf('[2] Order of piggy #%d ("%s") from %d to %d', $piggyBank->id, $piggyBank->name, $oldOrder, $newOrder));

View File

@@ -268,7 +268,7 @@ class UserRepository implements UserRepositoryInterface
public function inviteUser(null|Authenticatable|User $user, string $email): InvitedUser public function inviteUser(null|Authenticatable|User $user, string $email): InvitedUser
{ {
if(!($user instanceof User)) { if (!$user instanceof User) {
throw new FireflyException('User is not a User object.'); throw new FireflyException('User is not a User object.');
} }
$now = today(config('app.timezone')); $now = today(config('app.timezone'));

View File

@@ -91,7 +91,8 @@ class AccountDestroyService
$transaction->delete(); $transaction->delete();
$ibAccount->delete(); $ibAccount->delete();
} }
/** @var TransactionJournal|null $journal */
/** @var null|TransactionJournal $journal */
$journal = TransactionJournal::find($journalId); $journal = TransactionJournal::find($journalId);
if (null !== $journal) { if (null !== $journal) {
/** @var JournalDestroyService $service */ /** @var JournalDestroyService $service */

View File

@@ -177,7 +177,7 @@ class Amount
return $cache->get(); return $cache->get();
} }
/** @var TransactionCurrency|null $default */ /** @var null|TransactionCurrency $default */
$default = $userGroup->currencies()->where('group_default', true)->first(); $default = $userGroup->currencies()->where('group_default', true)->first();
if (null === $default) { if (null === $default) {
$default = $this->getSystemCurrency(); $default = $this->getSystemCurrency();

View File

@@ -50,6 +50,7 @@ class CurrencyForm
/** /**
* @throws FireflyException * @throws FireflyException
*
* @phpstan-param view-string $view * @phpstan-param view-string $view
*/ */
protected function currencyField(string $name, string $view, mixed $value = null, ?array $options = null): string protected function currencyField(string $name, string $view, mixed $value = null, ?array $options = null): string

View File

@@ -156,7 +156,7 @@ class AccountBalanceCalculator
* @var array $currencies * @var array $currencies
*/ */
foreach ($balances as $accountId => $currencies) { foreach ($balances as $accountId => $currencies) {
/** @var Account|null $account */ /** @var null|Account $account */
$account = Account::find($accountId); $account = Account::find($accountId);
if (null === $account) { if (null === $account) {
Log::error(sprintf('Could not find account #%d, will not save account balance.', $accountId)); Log::error(sprintf('Could not find account #%d, will not save account balance.', $accountId));
@@ -169,7 +169,7 @@ class AccountBalanceCalculator
* @var array $balance * @var array $balance
*/ */
foreach ($currencies as $currencyId => $balance) { foreach ($currencies as $currencyId => $balance) {
/** @var TransactionCurrency|null $currency */ /** @var null|TransactionCurrency $currency */
$currency = TransactionCurrency::find($currencyId); $currency = TransactionCurrency::find($currencyId);
if (null === $currency) { if (null === $currency) {
Log::error(sprintf('Could not find currency #%d, will not save account balance.', $currencyId)); Log::error(sprintf('Could not find currency #%d, will not save account balance.', $currencyId));
@@ -207,5 +207,4 @@ class AccountBalanceCalculator
} }
$object->optimizedCalculation($accounts, $transactionJournal->date); $object->optimizedCalculation($accounts, $transactionJournal->date);
} }
} }

View File

@@ -129,6 +129,7 @@ class Steam
// find currency of this entry. // find currency of this entry.
$currencies[$entry->transaction_currency_id] ??= TransactionCurrency::find($entry->transaction_currency_id); $currencies[$entry->transaction_currency_id] ??= TransactionCurrency::find($entry->transaction_currency_id);
/** @var TransactionCurrency $entryCurrency */ /** @var TransactionCurrency $entryCurrency */
$entryCurrency = $currencies[$entry->transaction_currency_id]; $entryCurrency = $currencies[$entry->transaction_currency_id];

View File

@@ -174,7 +174,7 @@ class AccountTransformer extends AbstractTransformer
private function getBalanceDifference(Collection $accounts, Carbon $start, Carbon $end): void private function getBalanceDifference(Collection $accounts, Carbon $start, Carbon $end): void
{ {
if (config('app.fallback_locale') === 'en_US') { if ('en_US' === config('app.fallback_locale')) {
throw new FireflyException('Used deprecated method, rethink this.'); throw new FireflyException('Used deprecated method, rethink this.');
} }
// collect balances, start and end for both native and converted. // collect balances, start and end for both native and converted.

View File

@@ -115,7 +115,7 @@ class PiggyBankTransformer extends AbstractTransformer
// grab repetitions (for current amount): // grab repetitions (for current amount):
$repetitions = PiggyBankRepetition::whereIn('piggy_bank_id', $piggyBanks)->get(); $repetitions = PiggyBankRepetition::whereIn('piggy_bank_id', $piggyBanks)->get();
if (config('app.fallback_locale') === 'en_US') { if ('en_US' === config('app.fallback_locale')) {
throw new FireflyException('[d] Piggy bank repetitions are EOL.'); throw new FireflyException('[d] Piggy bank repetitions are EOL.');
} }

View File

@@ -102,7 +102,7 @@ class FireflyValidator extends Validator
/** /**
* @SuppressWarnings("PHPMD.UnusedFormalParameter") * @SuppressWarnings("PHPMD.UnusedFormalParameter")
*/ */
public function validateBic(mixed $attribute,mixed $value): bool public function validateBic(mixed $attribute, mixed $value): bool
{ {
$regex = '/^[a-z]{6}[0-9a-z]{2}([0-9a-z]{3})?\z/i'; $regex = '/^[a-z]{6}[0-9a-z]{2}([0-9a-z]{3})?\z/i';
$result = preg_match($regex, $value); $result = preg_match($regex, $value);