kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-09-05 12:12:18 +00:00
Code Issues Projects Releases Wiki Activity

Various PSR12 code cleanup

Browse Source
This commit is contained in:
James Cole
2022-12-29 19:41:57 +01:00
parent 0022009dd5
commit dbf3e76ecc
340 changed files with 4079 additions and 3816 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
app/Factory/AccountFactory.php
View File

@@ -70,8 +70,8 @@ class AccountFactory
}
/**
* @param string $accountName
* @param string $accountType
* @param string $accountName
* @param string $accountType
*
* @return Account
* @throws FireflyException
@@ -106,7 +106,7 @@ class AccountFactory
}
/**
* @param array $data
* @param array $data
*
* @return Account
* @throws FireflyException
@@ -132,14 +132,14 @@ class AccountFactory
}
/**
* @param array $data
* @param array $data
*
* @return AccountType|null
* @throws FireflyException
*/
protected function getAccountType(array $data): ?AccountType
{
$accountTypeId = array_key_exists('account_type_id', $data) ? (int) $data['account_type_id'] : 0;
$accountTypeId = array_key_exists('account_type_id', $data) ? (int)$data['account_type_id'] : 0;
$accountTypeName = array_key_exists('account_type_name', $data) ? $data['account_type_name'] : null;
$result = null;
// find by name or ID
@@ -167,8 +167,8 @@ class AccountFactory
}
/**
* @param string $accountName
* @param string $accountType
* @param string $accountName
* @param string $accountType
*
* @return Account|null
*/
@@ -180,8 +180,8 @@ class AccountFactory
}
/**
* @param AccountType $type
* @param array $data
* @param AccountType $type
* @param array $data
*
* @return Account
* @throws FireflyException
@@ -194,16 +194,17 @@ class AccountFactory
// create it:
$virtualBalance = array_key_exists('virtual_balance', $data) ? $data['virtual_balance'] : null;
$active = array_key_exists('active', $data) ? $data['active'] : true;
$databaseData = ['user_id' => $this->user->id,
'account_type_id' => $type->id,
'name' => $data['name'],
'order' => 25000,
'virtual_balance' => $virtualBalance,
'active' => $active,
'iban' => $data['iban'],
$databaseData = [
'user_id' => $this->user->id,
'account_type_id' => $type->id,
'name' => $data['name'],
'order' => 25000,
'virtual_balance' => $virtualBalance,
'active' => $active,
'iban' => $data['iban'],
];
// fix virtual balance when it's empty
if ('' === (string) $databaseData['virtual_balance']) {
if ('' === (string)$databaseData['virtual_balance']) {
$databaseData['virtual_balance'] = null;
}
// remove virtual balance when not an asset account
@@ -248,16 +249,16 @@ class AccountFactory
}
/**
* @param Account $account
* @param array $data
* @param Account $account
* @param array $data
*
* @return array
*/
private function cleanMetaDataArray(Account $account, array $data): array
{
$currencyId = array_key_exists('currency_id', $data) ? (int) $data['currency_id'] : 0;
$currencyCode = array_key_exists('currency_code', $data) ? (string) $data['currency_code'] : '';
$accountRole = array_key_exists('account_role', $data) ? (string) $data['account_role'] : null;
$currencyId = array_key_exists('currency_id', $data) ? (int)$data['currency_id'] : 0;
$currencyCode = array_key_exists('currency_code', $data) ? (string)$data['currency_code'] : '';
$accountRole = array_key_exists('account_role', $data) ? (string)$data['account_role'] : null;
$currency = $this->getCurrency($currencyId, $currencyCode);
// only asset account may have a role:
@@ -275,8 +276,8 @@ class AccountFactory
}
/**
* @param Account $account
* @param array $data
* @param Account $account
* @param array $data
*/
private function storeMetaData(Account $account, array $data): void
{
@@ -312,14 +313,14 @@ class AccountFactory
$data[$field] = 1;
}
$factory->crud($account, $field, (string) $data[$field]);
$factory->crud($account, $field, (string)$data[$field]);
}
}
}
/**
* @param Account $account
* @param array $data
* @param Account $account
* @param array $data
*
* @throws FireflyException
*/
@@ -340,8 +341,8 @@ class AccountFactory
}
/**
* @param Account $account
* @param array $data
* @param Account $account
* @param array $data
*
* @throws FireflyException
*/
@@ -369,8 +370,8 @@ class AccountFactory
}
/**
* @param Account $account
* @param array $data
* @param Account $account
* @param array $data
*
* @throws FireflyException
*/
@@ -383,7 +384,7 @@ class AccountFactory
$order = $maxOrder + 1;
}
if (array_key_exists('order', $data)) {
$order = (int) ($data['order'] > $maxOrder ? $maxOrder + 1 : $data['order']);
$order = (int)($data['order'] > $maxOrder ? $maxOrder + 1 : $data['order']);
$order = 0 === $order ? $maxOrder + 1 : $order;
}
@@ -393,7 +394,7 @@ class AccountFactory
}
/**
* @param User $user
* @param User $user
*/
public function setUser(User $user): void
{

8
app/Factory/AccountMetaFactory.php
View File

@@ -37,9 +37,9 @@ class AccountMetaFactory
/**
* Create update or delete meta data.
*
* @param Account $account
* @param string $field
* @param string $value
* @param Account $account
* @param string $field
* @param string $value
*
* @return AccountMeta|null
*/
@@ -75,7 +75,7 @@ class AccountMetaFactory
}
/**
* @param array $data
* @param array $data
*
* @return AccountMeta|null
*/

8
app/Factory/AttachmentFactory.php
View File

@@ -38,7 +38,7 @@ class AttachmentFactory
private User $user;
/**
* @param array $data
* @param array $data
*
* @return Attachment|null
* @throws FireflyException
@@ -52,7 +52,7 @@ class AttachmentFactory
// get journal instead of transaction.
if (Transaction::class === $model) {
/** @var Transaction $transaction */
$transaction = $this->user->transactions()->find((int) $data['attachable_id']);
$transaction = $this->user->transactions()->find((int)$data['attachable_id']);
if (null === $transaction) {
throw new FireflyException('Unexpectedly could not find transaction');
}
@@ -75,7 +75,7 @@ class AttachmentFactory
'uploaded' => 0,
]
);
$notes = (string) ($data['notes'] ?? '');
$notes = (string)($data['notes'] ?? '');
if ('' !== $notes) {
$note = new Note();
$note->noteable()->associate($attachment);
@@ -87,7 +87,7 @@ class AttachmentFactory
}
/**
* @param User $user
* @param User $user
*/
public function setUser(User $user): void
{

23
app/Factory/BillFactory.php
View File

@@ -30,6 +30,7 @@ use FireflyIII\Repositories\ObjectGroup\CreatesObjectGroups;
use FireflyIII\Services\Internal\Support\BillServiceTrait;
use FireflyIII\User;
use Illuminate\Database\QueryException;
use JsonException;
use Log;
/**
@@ -43,17 +44,17 @@ class BillFactory
private User $user;
/**
* @param array $data
* @param array $data
*
* @return Bill|null
* @throws FireflyException
* @throws \JsonException
* @throws JsonException
*/
public function create(array $data): ?Bill
{
Log::debug(sprintf('Now in %s', __METHOD__), $data);
$factory = app(TransactionCurrencyFactory::class);
$currency = $factory->find((int) ($data['currency_id'] ?? null), (string) ($data['currency_code'] ?? null)) ??
$currency = $factory->find((int)($data['currency_id'] ?? null), (string)($data['currency_code'] ?? null)) ??
app('amount')->getDefaultCurrencyByUser($this->user);
try {
@@ -84,7 +85,7 @@ class BillFactory
}
if (array_key_exists('notes', $data)) {
$this->updateNote($bill, (string) $data['notes']);
$this->updateNote($bill, (string)$data['notes']);
}
$objectGroupTitle = $data['object_group_title'] ?? '';
if ('' !== $objectGroupTitle) {
@@ -95,7 +96,7 @@ class BillFactory
}
}
// try also with ID:
$objectGroupId = (int) ($data['object_group_id'] ?? 0);
$objectGroupId = (int)($data['object_group_id'] ?? 0);
if (0 !== $objectGroupId) {
$objectGroup = $this->findObjectGroupById($objectGroupId);
if (null !== $objectGroup) {
@@ -108,15 +109,15 @@ class BillFactory
}
/**
* @param int|null $billId
* @param null|string $billName
* @param int|null $billId
* @param null|string $billName
*
* @return Bill|null
*/
public function find(?int $billId, ?string $billName): ?Bill
{
$billId = (int) $billId;
$billName = (string) $billName;
$billId = (int)$billId;
$billName = (string)$billName;
$bill = null;
// first find by ID:
if ($billId > 0) {
@@ -133,7 +134,7 @@ class BillFactory
}
/**
* @param string $name
* @param string $name
*
* @return Bill|null
*/
@@ -143,7 +144,7 @@ class BillFactory
}
/**
* @param User $user
* @param User $user
*/
public function setUser(User $user): void
{

13
app/Factory/BudgetFactory.php
View File

@@ -1,4 +1,5 @@
<?php
/**
* BudgetFactory.php
* Copyright (c) 2019 james@firefly-iii.org
@@ -33,15 +34,15 @@ class BudgetFactory
private User $user;
/**
* @param int|null $budgetId
* @param null|string $budgetName
* @param int|null $budgetId
* @param null|string $budgetName
*
* @return Budget|null
*/
public function find(?int $budgetId, ?string $budgetName): ?Budget
{
$budgetId = (int) $budgetId;
$budgetName = (string) $budgetName;
$budgetId = (int)$budgetId;
$budgetName = (string)$budgetName;
if (0 === $budgetId && '' === $budgetName) {
return null;
@@ -67,7 +68,7 @@ class BudgetFactory
}
/**
* @param string $name
* @param string $name
*
* @return Budget|null
*/
@@ -77,7 +78,7 @@ class BudgetFactory
}
/**
* @param User $user
* @param User $user
*/
public function setUser(User $user): void
{

13
app/Factory/CategoryFactory.php
View File

@@ -1,4 +1,5 @@
<?php
/**
* CategoryFactory.php
* Copyright (c) 2019 james@firefly-iii.org
@@ -36,16 +37,16 @@ class CategoryFactory
private User $user;
/**
* @param int|null $categoryId
* @param null|string $categoryName
* @param int|null $categoryId
* @param null|string $categoryName
*
* @return Category|null
* @throws FireflyException
*/
public function findOrCreate(?int $categoryId, ?string $categoryName): ?Category
{
$categoryId = (int) $categoryId;
$categoryName = (string) $categoryName;
$categoryId = (int)$categoryId;
$categoryName = (string)$categoryName;
Log::debug(sprintf('Going to find category with ID %d and name "%s"', $categoryId, $categoryName));
@@ -83,7 +84,7 @@ class CategoryFactory
}
/**
* @param string $name
* @param string $name
*
* @return Category|null
*/
@@ -93,7 +94,7 @@ class CategoryFactory
}
/**
* @param User $user
* @param User $user
*/
public function setUser(User $user): void
{

7
app/Factory/PiggyBankEventFactory.php
View File

@@ -1,4 +1,5 @@
<?php
/**
* PiggyBankEventFactory.php
* Copyright (c) 2019 james@firefly-iii.org
@@ -22,9 +23,7 @@ declare(strict_types=1);
namespace FireflyIII\Factory;
use FireflyIII\Events\ChangedPiggyBankAmount;
use FireflyIII\Models\PiggyBank;
use FireflyIII\Models\PiggyBankEvent;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\Models\TransactionType;
use FireflyIII\Repositories\PiggyBank\PiggyBankRepositoryInterface;
@@ -38,8 +37,8 @@ use Log;
class PiggyBankEventFactory
{
/**
* @param TransactionJournal $journal
* @param PiggyBank|null $piggyBank
* @param TransactionJournal $journal
* @param PiggyBank|null $piggyBank
*/
public function create(TransactionJournal $journal, ?PiggyBank $piggyBank): void
{

13
app/Factory/PiggyBankFactory.php
View File

@@ -1,4 +1,5 @@
<?php
/**
* PiggyBankFactory.php
* Copyright (c) 2019 james@firefly-iii.org
@@ -33,15 +34,15 @@ class PiggyBankFactory
private User $user;
/**
* @param int|null $piggyBankId
* @param null|string $piggyBankName
* @param int|null $piggyBankId
* @param null|string $piggyBankName
*
* @return PiggyBank|null
*/
public function find(?int $piggyBankId, ?string $piggyBankName): ?PiggyBank
{
$piggyBankId = (int) $piggyBankId;
$piggyBankName = (string) $piggyBankName;
$piggyBankId = (int)$piggyBankId;
$piggyBankName = (string)$piggyBankName;
if ('' === $piggyBankName && 0 === $piggyBankId) {
return null;
}
@@ -67,7 +68,7 @@ class PiggyBankFactory
}
/**
* @param string $name
* @param string $name
*
* @return PiggyBank|null
*/
@@ -77,7 +78,7 @@ class PiggyBankFactory
}
/**
* @param User $user
* @param User $user
*/
public function setUser(User $user): void
{

8
app/Factory/RecurrenceFactory.php
View File

@@ -54,7 +54,7 @@ class RecurrenceFactory
}
/**
* @param array $data
* @param array $data
*
* @return Recurrence
* @throws FireflyException
@@ -83,7 +83,7 @@ class RecurrenceFactory
$firstDate = $data['recurrence']['first_date'];
}
if (array_key_exists('nr_of_repetitions', $data['recurrence'])) {
$repetitions = (int) $data['recurrence']['nr_of_repetitions'];
$repetitions = (int)$data['recurrence']['nr_of_repetitions'];
}
if (array_key_exists('repeat_until', $data['recurrence'])) {
$repeatUntil = $data['recurrence']['repeat_until'];
@@ -119,7 +119,7 @@ class RecurrenceFactory
$recurrence->save();
if (array_key_exists('notes', $data['recurrence'])) {
$this->updateNote($recurrence, (string) $data['recurrence']['notes']);
$this->updateNote($recurrence, (string)$data['recurrence']['notes']);
}
$this->createRepetitions($recurrence, $data['repetitions'] ?? []);
@@ -146,7 +146,7 @@ class RecurrenceFactory
}
/**
* @param User $user
* @param User $user
*/
public function setUser(User $user): void
{

12
app/Factory/TagFactory.php
View File

@@ -36,7 +36,7 @@ class TagFactory
private User $user;
/**
* @param string $tag
* @param string $tag
*
* @return Tag|null
*/
@@ -73,15 +73,15 @@ class TagFactory
}
/**
* @param array $data
* @param array $data
*
* @return Tag|null
*/
public function create(array $data): ?Tag
{
$zoomLevel = 0 === (int) $data['zoom_level'] ? null : (int) $data['zoom_level'];
$latitude = 0.0 === (float) $data['latitude'] ? null : (float) $data['latitude']; // intentional float
$longitude = 0.0 === (float) $data['longitude'] ? null : (float) $data['longitude']; // intentional float
$zoomLevel = 0 === (int)$data['zoom_level'] ? null : (int)$data['zoom_level'];
$latitude = 0.0 === (float)$data['latitude'] ? null : (float)$data['latitude']; // intentional float
$longitude = 0.0 === (float)$data['longitude'] ? null : (float)$data['longitude']; // intentional float
$array = [
'user_id' => $this->user->id,
'tag' => trim($data['tag']),
@@ -107,7 +107,7 @@ class TagFactory
}
/**
* @param User $user
* @param User $user
*/
public function setUser(User $user): void
{

10
app/Factory/TransactionCurrencyFactory.php
View File

@@ -34,7 +34,7 @@ use Log;
class TransactionCurrencyFactory
{
/**
* @param array $data
* @param array $data
*
* @return TransactionCurrency
* @throws FireflyException
@@ -71,15 +71,15 @@ class TransactionCurrencyFactory
}
/**
* @param int|null $currencyId
* @param null|string $currencyCode
* @param int|null $currencyId
* @param null|string $currencyCode
*
* @return TransactionCurrency|null
*/
public function find(?int $currencyId, ?string $currencyCode): ?TransactionCurrency
{
$currencyCode = (string) $currencyCode;
$currencyId = (int) $currencyId;
$currencyCode = (string)$currencyCode;
$currencyId = (int)$currencyId;
if ('' === $currencyCode && 0 === $currencyId) {
Log::debug('Cannot find anything on empty currency code and empty currency ID!');

24
app/Factory/TransactionFactory.php
View File

@@ -58,8 +58,8 @@ class TransactionFactory
/**
* Create transaction with negative amount (for source accounts).
*
* @param string $amount
* @param string|null $foreignAmount
* @param string $amount
* @param string|null $foreignAmount
*
* @return Transaction
* @throws FireflyException
@@ -77,8 +77,8 @@ class TransactionFactory
}
/**
* @param string $amount
* @param string|null $foreignAmount
* @param string $amount
* @param string|null $foreignAmount
*
* @return Transaction
* @throws FireflyException
@@ -138,8 +138,8 @@ class TransactionFactory
/**
* Create transaction with positive amount (for destination accounts).
*
* @param string $amount
* @param string|null $foreignAmount
* @param string $amount
* @param string|null $foreignAmount
*
* @return Transaction
* @throws FireflyException
@@ -157,7 +157,7 @@ class TransactionFactory
}
/**
* @param Account $account
* @param Account $account
*
* @codeCoverageIgnore
*/
@@ -167,7 +167,7 @@ class TransactionFactory
}
/**
* @param TransactionCurrency $currency
* @param TransactionCurrency $currency
*
* @codeCoverageIgnore
*/
@@ -177,7 +177,7 @@ class TransactionFactory
}
/**
* @param TransactionCurrency|null $foreignCurrency |null
* @param TransactionCurrency|null $foreignCurrency |null
*
* @codeCoverageIgnore
*/
@@ -187,7 +187,7 @@ class TransactionFactory
}
/**
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @codeCoverageIgnore
*/
@@ -197,7 +197,7 @@ class TransactionFactory
}
/**
* @param bool $reconciled
* @param bool $reconciled
*
* @codeCoverageIgnore
*/
@@ -207,7 +207,7 @@ class TransactionFactory
}
/**
* @param User $user
* @param User $user
*
* @codeCoverageIgnore
*/

9
app/Factory/TransactionGroupFactory.php
View File

@@ -27,6 +27,7 @@ use FireflyIII\Exceptions\DuplicateTransactionException;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\TransactionGroup;
use FireflyIII\User;
use JsonException;
use Log;
/**
@@ -37,7 +38,7 @@ use Log;
class TransactionGroupFactory
{
private TransactionJournalFactory $journalFactory;
private User $user;
private User $user;
/**
* TransactionGroupFactory constructor.
@@ -50,12 +51,12 @@ class TransactionGroupFactory
/**
* Store a new transaction journal.
*
* @param array $data
* @param array $data
*
* @return TransactionGroup
* @throws DuplicateTransactionException
* @throws FireflyException
* @throws \JsonException
* @throws JsonException
*/
public function create(array $data): TransactionGroup
{
@@ -91,7 +92,7 @@ class TransactionGroupFactory
/**
* Set the user.
*
* @param User $user
* @param User $user
*/
public function setUser(User $user): void
{

94
app/Factory/TransactionJournalFactory.php
View File

@@ -313,7 +313,7 @@ class TransactionJournalFactory
unset($dataRow['import_hash_v2'], $dataRow['original_source']);
$json = json_encode($dataRow, JSON_THROW_ON_ERROR);
if (false === $json) {
$json = json_encode((string) microtime(), JSON_THROW_ON_ERROR);
$json = json_encode((string)microtime(), JSON_THROW_ON_ERROR);
Log::error(sprintf('Could not hash the original row! %s', json_last_error_msg()), $dataRow);
}
$hash = hash('sha256', $json);
@@ -399,6 +399,52 @@ class TransactionJournalFactory
}
}
/**
* Set the user.
*
* @param User $user
*/
public function setUser(User $user): void
{
$this->user = $user;
$this->currencyRepository->setUser($this->user);
$this->tagFactory->setUser($user);
$this->billRepository->setUser($this->user);
$this->budgetRepository->setUser($this->user);
$this->categoryRepository->setUser($this->user);
$this->piggyRepository->setUser($this->user);
$this->accountRepository->setUser($this->user);
}
/**
* @param Account|null $sourceAccount
* @param Account|null $destinationAccount
* @return array
*/
private function reconciliationSanityCheck(?Account $sourceAccount, ?Account $destinationAccount): array
{
Log::debug(sprintf('Now in %s', __METHOD__));
if (null !== $sourceAccount && null !== $destinationAccount) {
Log::debug('Both accounts exist, simply return them.');
return [$sourceAccount, $destinationAccount];
}
if (null !== $sourceAccount && null === $destinationAccount) {
Log::debug('Destination account is NULL, source account is not.');
$account = $this->accountRepository->getReconciliation($sourceAccount);
Log::debug(sprintf('Will return account #%d ("%s") of type "%s"', $account->id, $account->name, $account->accountType->type));
return [$sourceAccount, $account];
}
if (null === $sourceAccount && null !== $destinationAccount) {
Log::debug('Source account is NULL, destination account is not.');
$account = $this->accountRepository->getReconciliation($destinationAccount);
Log::debug(sprintf('Will return account #%d ("%s") of type "%s"', $account->id, $account->name, $account->accountType->type));
return [$account, $destinationAccount];
}
Log::debug('Unused fallback');
return [$sourceAccount, $destinationAccount];
}
/**
* @param string $type
* @param TransactionCurrency|null $currency
@@ -585,50 +631,4 @@ class TransactionJournalFactory
Log::info('Will trigger duplication alert for this journal.');
}
}
/**
* Set the user.
*
* @param User $user
*/
public function setUser(User $user): void
{
$this->user = $user;
$this->currencyRepository->setUser($this->user);
$this->tagFactory->setUser($user);
$this->billRepository->setUser($this->user);
$this->budgetRepository->setUser($this->user);
$this->categoryRepository->setUser($this->user);
$this->piggyRepository->setUser($this->user);
$this->accountRepository->setUser($this->user);
}
/**
* @param Account|null $sourceAccount
* @param Account|null $destinationAccount
* @return array
*/
private function reconciliationSanityCheck(?Account $sourceAccount, ?Account $destinationAccount): array
{
Log::debug(sprintf('Now in %s', __METHOD__));
if (null !== $sourceAccount && null !== $destinationAccount) {
Log::debug('Both accounts exist, simply return them.');
return [$sourceAccount, $destinationAccount];
}
if (null !== $sourceAccount && null === $destinationAccount) {
Log::debug('Destination account is NULL, source account is not.');
$account = $this->accountRepository->getReconciliation($sourceAccount);
Log::debug(sprintf('Will return account #%d ("%s") of type "%s"', $account->id, $account->name, $account->accountType->type));
return [$sourceAccount, $account];
}
if (null === $sourceAccount && null !== $destinationAccount) {
Log::debug('Source account is NULL, destination account is not.');
$account = $this->accountRepository->getReconciliation($destinationAccount);
Log::debug(sprintf('Will return account #%d ("%s") of type "%s"', $account->id, $account->name, $account->accountType->type));
return [$account, $destinationAccount];
}
Log::debug('Unused fallback');
return [$sourceAccount, $destinationAccount];
}
}

5
app/Factory/TransactionJournalMetaFactory.php
View File

@@ -24,7 +24,6 @@ declare(strict_types=1);
namespace FireflyIII\Factory;
use Carbon\Carbon;
use Exception;
use FireflyIII\Models\TransactionJournalMeta;
use Illuminate\Database\QueryException;
use Log;
@@ -35,7 +34,7 @@ use Log;
class TransactionJournalMetaFactory
{
/**
* @param array $data
* @param array $data
*
* @return TransactionJournalMeta|null
*/
@@ -60,7 +59,7 @@ class TransactionJournalMetaFactory
Log::debug('Is a carbon object.');
$value = $data['data']->toW3cString();
}
if ('' === (string) $value) {
if ('' === (string)$value) {
// Log::debug('Is an empty string.');
// don't store blank strings.
if (null !== $entry) {

2
app/Factory/TransactionTypeFactory.php
View File

@@ -32,7 +32,7 @@ use FireflyIII\Models\TransactionType;
class TransactionTypeFactory
{
/**
* @param string $type
* @param string $type
*
* @return TransactionType|null
*/