kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-09-29 18:20:01 +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:42:40 +01:00
parent 6cfdc58cb1
commit 56b9b66352
38 changed files with 763 additions and 691 deletions
Download Patch File Download Diff File Expand all files Collapse all files

134
app/Validation/TransactionValidation.php
View File

@@ -39,7 +39,7 @@ trait TransactionValidation
/**
* Validates the given account information. Switches on given transaction type.
*
* @param Validator $validator
* @param Validator $validator
*/
public function validateAccountInformation(Validator $validator): void
{
@@ -51,7 +51,7 @@ trait TransactionValidation
Log::debug(sprintf('Going to loop %d transaction(s)', count($transactions)));
/**
* @var int $index
* @var int $index
* @var array $transaction
*/
foreach ($transactions as $index => $transaction) {
@@ -63,7 +63,7 @@ trait TransactionValidation
}
/**
* @param Validator $validator
* @param Validator $validator
*
* @return array
*/
@@ -87,10 +87,10 @@ trait TransactionValidation
}
/**
* @param Validator $validator
* @param int $index
* @param string $transactionType
* @param array $transaction
* @param Validator $validator
* @param int $index
* @param string $transactionType
* @param array $transaction
*/
protected function validateSingleAccount(Validator $validator, int $index, string $transactionType, array $transaction): void
{
@@ -101,10 +101,10 @@ trait TransactionValidation
$accountValidator->setTransactionType($transactionType);
// validate source account.
$sourceId = array_key_exists('source_id', $transaction) ? (int) $transaction['source_id'] : null;
$sourceName = array_key_exists('source_name', $transaction) ? (string) $transaction['source_name'] : null;
$sourceIban = array_key_exists('source_iban', $transaction) ? (string) $transaction['source_iban'] : null;
$sourceNumber = array_key_exists('source_number', $transaction) ? (string) $transaction['source_number'] : null;
$sourceId = array_key_exists('source_id', $transaction) ? (int)$transaction['source_id'] : null;
$sourceName = array_key_exists('source_name', $transaction) ? (string)$transaction['source_name'] : null;
$sourceIban = array_key_exists('source_iban', $transaction) ? (string)$transaction['source_iban'] : null;
$sourceNumber = array_key_exists('source_number', $transaction) ? (string)$transaction['source_number'] : null;
$source = [
'id' => $sourceId,
'name' => $sourceName,
@@ -121,10 +121,10 @@ trait TransactionValidation
return;
}
// validate destination account
$destinationId = array_key_exists('destination_id', $transaction) ? (int) $transaction['destination_id'] : null;
$destinationName = array_key_exists('destination_name', $transaction) ? (string) $transaction['destination_name'] : null;
$destinationIban = array_key_exists('destination_iban', $transaction) ? (string) $transaction['destination_iban'] : null;
$destinationNumber = array_key_exists('destination_number', $transaction) ? (string) $transaction['destination_number'] : null;
$destinationId = array_key_exists('destination_id', $transaction) ? (int)$transaction['destination_id'] : null;
$destinationName = array_key_exists('destination_name', $transaction) ? (string)$transaction['destination_name'] : null;
$destinationIban = array_key_exists('destination_iban', $transaction) ? (string)$transaction['destination_iban'] : null;
$destinationNumber = array_key_exists('destination_number', $transaction) ? (string)$transaction['destination_number'] : null;
$destination = [
'id' => $destinationId,
'name' => $destinationName,
@@ -143,11 +143,11 @@ trait TransactionValidation
}
/**
* @param Validator $validator
* @param string $transactionType
* @param int $index
* @param array $source
* @param array $destination
* @param Validator $validator
* @param string $transactionType
* @param int $index
* @param array $source
* @param array $destination
* @return void
*/
protected function sanityCheckReconciliation(Validator $validator, string $transactionType, int $index, array $source, array $destination): void
@@ -177,8 +177,8 @@ trait TransactionValidation
/**
* Validates the given account information. Switches on given transaction type.
*
* @param Validator $validator
* @param TransactionGroup $transactionGroup
* @param Validator $validator
* @param TransactionGroup $transactionGroup
*/
public function validateAccountInformationUpdate(Validator $validator, TransactionGroup $transactionGroup): void
{
@@ -186,7 +186,7 @@ trait TransactionValidation
$transactions = $this->getTransactionsArray($validator);
/**
* @var int $index
* @var int $index
* @var array $transaction
*/
foreach ($transactions as $index => $transaction) {
@@ -195,10 +195,10 @@ trait TransactionValidation
}
/**
* @param Validator $validator
* @param int $index
* @param array $transaction
* @param TransactionGroup $transactionGroup
* @param Validator $validator
* @param int $index
* @param array $transaction
* @param TransactionGroup $transactionGroup
*/
protected function validateSingleUpdate(Validator $validator, int $index, array $transaction, TransactionGroup $transactionGroup): void
{
@@ -224,7 +224,7 @@ trait TransactionValidation
// validate if the submitted source and / or name are valid
if (array_key_exists('source_id', $transaction) || array_key_exists('source_name', $transaction)) {
Log::debug('Will try to validate source account information.');
$sourceId = (int) ($transaction['source_id'] ?? 0);
$sourceId = (int)($transaction['source_id'] ?? 0);
$sourceName = $transaction['source_name'] ?? null;
$validSource = $accountValidator->validateSource(['id' => $sourceId, 'name' => $sourceName]);
@@ -252,7 +252,7 @@ trait TransactionValidation
$accountValidator->source = $source;
}
}
$destinationId = (int) ($transaction['destination_id'] ?? 0);
$destinationId = (int)($transaction['destination_id'] ?? 0);
$destinationName = $transaction['destination_name'] ?? null;
$array = ['id' => $destinationId, 'name' => $destinationName,];
$validDestination = $accountValidator->validateDestination($array);
@@ -268,8 +268,8 @@ trait TransactionValidation
}
/**
* @param TransactionGroup $group
* @param array $transactions
* @param TransactionGroup $group
* @param array $transactions
*
* @return string
*/
@@ -279,8 +279,8 @@ trait TransactionValidation
}
/**
* @param array $transaction
* @param TransactionGroup $transactionGroup
* @param array $transaction
* @param TransactionGroup $transactionGroup
*
* @return Account|null
*/
@@ -293,7 +293,7 @@ trait TransactionValidation
}
/** @var TransactionJournal $journal */
foreach ($transactionGroup->transactionJournals as $journal) {
if ((int) $journal->id === (int) $transaction['transaction_journal_id']) {
if ((int)$journal->id === (int)$transaction['transaction_journal_id']) {
return $journal->transactions()->where('amount', '<', 0)->first()->account;
}
}
@@ -304,7 +304,7 @@ trait TransactionValidation
/**
* Adds an error to the validator when there are no transactions in the array of data.
*
* @param Validator $validator
* @param Validator $validator
*/
public function validateOneRecurrenceTransaction(Validator $validator): void
{
@@ -313,14 +313,14 @@ trait TransactionValidation
// need at least one transaction
if (0 === count($transactions)) {
$validator->errors()->add('transactions', (string) trans('validation.at_least_one_transaction'));
$validator->errors()->add('transactions', (string)trans('validation.at_least_one_transaction'));
}
}
/**
* Adds an error to the validator when there are no transactions in the array of data.
*
* @param Validator $validator
* @param Validator $validator
*/
public function validateOneTransaction(Validator $validator): void
{
@@ -328,7 +328,7 @@ trait TransactionValidation
$transactions = $this->getTransactionsArray($validator);
// need at least one transaction
if (0 === count($transactions)) {
$validator->errors()->add('transactions.0.description', (string) trans('validation.at_least_one_transaction'));
$validator->errors()->add('transactions.0.description', (string)trans('validation.at_least_one_transaction'));
Log::debug('Added error: at_least_one_transaction.');
return;
@@ -337,14 +337,14 @@ trait TransactionValidation
}
/**
* @param Validator $validator
* @param Validator $validator
*/
public function validateTransactionArray(Validator $validator): void
{
$transactions = $this->getTransactionsArray($validator);
foreach ($transactions as $key => $value) {
if (!is_int($key)) {
$validator->errors()->add('transactions.0.description', (string) trans('validation.at_least_one_transaction'));
$validator->errors()->add('transactions.0.description', (string)trans('validation.at_least_one_transaction'));
Log::debug('Added error: at_least_one_transaction.');
return;
@@ -355,7 +355,7 @@ trait TransactionValidation
/**
* All types of splits must be equal.
*
* @param Validator $validator
* @param Validator $validator
*/
public function validateTransactionTypes(Validator $validator): void
{
@@ -368,20 +368,20 @@ trait TransactionValidation
}
$unique = array_unique($types);
if (count($unique) > 1) {
$validator->errors()->add('transactions.0.type', (string) trans('validation.transaction_types_equal'));
$validator->errors()->add('transactions.0.type', (string)trans('validation.transaction_types_equal'));
return;
}
$first = $unique[0] ?? 'invalid';
if ('invalid' === $first) {
$validator->errors()->add('transactions.0.type', (string) trans('validation.invalid_transaction_type'));
$validator->errors()->add('transactions.0.type', (string)trans('validation.invalid_transaction_type'));
}
}
/**
* All types of splits must be equal.
*
* @param Validator $validator
* @param Validator $validator
*/
public function validateTransactionTypesForUpdate(Validator $validator): void
{
@@ -389,14 +389,14 @@ trait TransactionValidation
$transactions = $this->getTransactionsArray($validator);
$types = [];
foreach ($transactions as $transaction) {
$originalType = $this->getOriginalType((int) ($transaction['transaction_journal_id'] ?? 0));
$originalType = $this->getOriginalType((int)($transaction['transaction_journal_id'] ?? 0));
// if type is not set, fall back to the type of the journal, if one is given.
$types[] = $transaction['type'] ?? $originalType;
}
$unique = array_unique($types);
if (count($unique) > 1) {
app('log')->warning('Add error for mismatch transaction types.');
$validator->errors()->add('transactions.0.type', (string) trans('validation.transaction_types_equal'));
$validator->errors()->add('transactions.0.type', (string)trans('validation.transaction_types_equal'));
return;
}
@@ -404,7 +404,7 @@ trait TransactionValidation
}
/**
* @param int $journalId
* @param int $journalId
*
* @return string
*/
@@ -423,7 +423,7 @@ trait TransactionValidation
}
/**
* @param Validator $validator
* @param Validator $validator
*/
private function validateEqualAccounts(Validator $validator): void
{
@@ -447,26 +447,26 @@ trait TransactionValidation
default:
case 'withdrawal':
if (count($sources) > 1) {
$validator->errors()->add('transactions.0.source_id', (string) trans('validation.all_accounts_equal'));
$validator->errors()->add('transactions.0.source_id', (string)trans('validation.all_accounts_equal'));
}
break;
case 'deposit':
if (count($dests) > 1) {
$validator->errors()->add('transactions.0.destination_id', (string) trans('validation.all_accounts_equal'));
$validator->errors()->add('transactions.0.destination_id', (string)trans('validation.all_accounts_equal'));
}
break;
case'transfer':
if (count($sources) > 1 || count($dests) > 1) {
$validator->errors()->add('transactions.0.source_id', (string) trans('validation.all_accounts_equal'));
$validator->errors()->add('transactions.0.destination_id', (string) trans('validation.all_accounts_equal'));
$validator->errors()->add('transactions.0.source_id', (string)trans('validation.all_accounts_equal'));
$validator->errors()->add('transactions.0.destination_id', (string)trans('validation.all_accounts_equal'));
}
break;
}
}
/**
* @param Validator $validator
* @param TransactionGroup $transactionGroup
* @param Validator $validator
* @param TransactionGroup $transactionGroup
*/
private function validateEqualAccountsForUpdate(Validator $validator, TransactionGroup $transactionGroup): void
{
@@ -489,14 +489,14 @@ trait TransactionValidation
$result = $this->compareAccountData($type, $comparison);
if (false === $result) {
if ('withdrawal' === $type) {
$validator->errors()->add('transactions.0.source_id', (string) trans('validation.all_accounts_equal'));
$validator->errors()->add('transactions.0.source_id', (string)trans('validation.all_accounts_equal'));
}
if ('deposit' === $type) {
$validator->errors()->add('transactions.0.destination_id', (string) trans('validation.all_accounts_equal'));
$validator->errors()->add('transactions.0.destination_id', (string)trans('validation.all_accounts_equal'));
}
if ('transfer' === $type) {
$validator->errors()->add('transactions.0.source_id', (string) trans('validation.all_accounts_equal'));
$validator->errors()->add('transactions.0.destination_id', (string) trans('validation.all_accounts_equal'));
$validator->errors()->add('transactions.0.source_id', (string)trans('validation.all_accounts_equal'));
$validator->errors()->add('transactions.0.destination_id', (string)trans('validation.all_accounts_equal'));
}
app('log')->warning('Add error about equal accounts.');
@@ -506,7 +506,7 @@ trait TransactionValidation
}
/**
* @param array $transactions
* @param array $transactions
*
* @return array
*/
@@ -519,7 +519,7 @@ trait TransactionValidation
/** @var array $transaction */
foreach ($transactions as $transaction) {
// source or destination may be omitted. If this is the case, use the original source / destination name + ID.
$originalData = $this->getOriginalData((int) ($transaction['transaction_journal_id'] ?? 0));
$originalData = $this->getOriginalData((int)($transaction['transaction_journal_id'] ?? 0));
// get field.
$comparison[$field][] = $transaction[$field] ?? $originalData[$field];
@@ -530,7 +530,7 @@ trait TransactionValidation
}
/**
* @param int $journalId
* @param int $journalId
*
* @return array
*/
@@ -562,8 +562,8 @@ trait TransactionValidation
}
/**
* @param string $type
* @param array $comparison
* @param string $type
* @param array $comparison
*
* @return bool
*/
@@ -577,7 +577,7 @@ trait TransactionValidation
}
/**
* @param array $comparison
* @param array $comparison
*
* @return bool
*/
@@ -596,7 +596,7 @@ trait TransactionValidation
}
/**
* @param array $array
* @param array $array
*
* @return bool
*/
@@ -606,7 +606,7 @@ trait TransactionValidation
}
/**
* @param array $comparison
* @param array $comparison
*
* @return bool
*/
@@ -625,7 +625,7 @@ trait TransactionValidation
}
/**
* @param array $comparison
* @param array $comparison
*
* @return bool
*/