Simplify method.

This commit is contained in:
James Cole
2020-10-19 06:41:01 +02:00
parent 1f5934d6e2
commit 348452ec7d

View File

@@ -126,8 +126,8 @@ trait TransactionValidation
{ {
/** @var AccountValidator $accountValidator */ /** @var AccountValidator $accountValidator */
$accountValidator = app(AccountValidator::class); $accountValidator = app(AccountValidator::class);
$originalType = $this->getOriginalType((int)($transaction['transaction_journal_id'] ?? 0)); $originalType = $this->getOriginalType((int) ($transaction['transaction_journal_id'] ?? 0));
$originalData = $this->getOriginalData((int)($transaction['transaction_journal_id'] ?? 0)); $originalData = $this->getOriginalData((int) ($transaction['transaction_journal_id'] ?? 0));
$transactionType = $transaction['type'] ?? $originalType; $transactionType = $transaction['type'] ?? $originalType;
$accountValidator->setTransactionType($transactionType); $accountValidator->setTransactionType($transactionType);
@@ -140,7 +140,7 @@ trait TransactionValidation
} }
// validate source account. // validate source account.
$sourceId = isset($transaction['source_id']) ? (int)$transaction['source_id'] : $originalData['source_id']; $sourceId = isset($transaction['source_id']) ? (int) $transaction['source_id'] : $originalData['source_id'];
$sourceName = $transaction['source_name'] ?? $originalData['source_name']; $sourceName = $transaction['source_name'] ?? $originalData['source_name'];
$validSource = $accountValidator->validateSource($sourceId, $sourceName, null); $validSource = $accountValidator->validateSource($sourceId, $sourceName, null);
@@ -152,7 +152,7 @@ trait TransactionValidation
return; return;
} }
// validate destination account // validate destination account
$destinationId = isset($transaction['destination_id']) ? (int)$transaction['destination_id'] : $originalData['destination_id']; $destinationId = isset($transaction['destination_id']) ? (int) $transaction['destination_id'] : $originalData['destination_id'];
$destinationName = $transaction['destination_name'] ?? $originalData['destination_name']; $destinationName = $transaction['destination_name'] ?? $originalData['destination_name'];
$validDestination = $accountValidator->validateDestination($destinationId, $destinationName, null); $validDestination = $accountValidator->validateDestination($destinationId, $destinationName, null);
// do something with result: // do something with result:
@@ -174,7 +174,7 @@ trait TransactionValidation
// need at least one transaction // need at least one transaction
if (0 === count($transactions)) { 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'));
} }
} }
@@ -189,7 +189,7 @@ trait TransactionValidation
$transactions = $this->getTransactionsArray($validator); $transactions = $this->getTransactionsArray($validator);
// need at least one transaction // need at least one transaction
if (0 === count($transactions)) { 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.'); Log::debug('Added error: at_least_one_transaction.');
return; return;
} }
@@ -212,13 +212,13 @@ trait TransactionValidation
} }
$unique = array_unique($types); $unique = array_unique($types);
if (count($unique) > 1) { 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; return;
} }
$first = $unique[0] ?? 'invalid'; $first = $unique[0] ?? 'invalid';
if ('invalid' === $first) { 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'));
} }
} }
@@ -233,7 +233,7 @@ trait TransactionValidation
$transactions = $this->getTransactionsArray($validator); $transactions = $this->getTransactionsArray($validator);
$types = []; $types = [];
foreach ($transactions as $transaction) { 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. // if type is not set, fall back to the type of the journal, if one is given.
@@ -241,7 +241,7 @@ trait TransactionValidation
} }
$unique = array_unique($types); $unique = array_unique($types);
if (count($unique) > 1) { 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; return;
} }
@@ -357,23 +357,132 @@ trait TransactionValidation
default: default:
case 'withdrawal': case 'withdrawal':
if (count($sources) > 1) { 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; break;
case 'deposit': case 'deposit':
if (count($dests) > 1) { 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; break;
case'transfer': case'transfer':
if (count($sources) > 1 || count($dests) > 1) { 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.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.destination_id', (string) trans('validation.all_accounts_equal'));
} }
break; break;
} }
} }
/**
* @param TransactionGroup $group
* @param array $transactions
* @return string
*/
private function getTransactionType(TransactionGroup $group, array $transactions): string
{
return $transactions[0]['type'] ?? strtolower($group->transactionJournals()->first()->transactionType->type);
}
/**
* @param array $transactions
* @return array
*/
private function collectComparisonData(array $transactions): array
{
$fields = ['source_id', 'destination_id', 'source_name', 'destination_name'];
$comparison = [];
foreach ($fields as $field) {
$comparison[$field] = [];
/** @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));
// get field.
$comparison[$field][] = $transaction[$field] ?? $originalData[$field];
}
}
return $comparison;
}
/**
* @param string $type
* @param array $comparison
* @return bool
*/
private function compareAccountData(string $type, array $comparison): bool
{
switch ($type) {
default:
case 'withdrawal':
return $this->compareAccountDataWithdrawal($comparison);
case 'deposit':
return $this->compareAccountDataDeposit($comparison);
case 'transfer':
return $this->compareAccountDataTransfer($comparison);
}
}
/**
* @param array $comparison
* @return bool
*/
private function compareAccountDataTransfer(array $comparison): bool
{
if ($this->arrayEqual($comparison['source_id'])) {
// source ID's are equal, return void.
return true;
}
if ($this->arrayEqual($comparison['source_name'])) {
// source names are equal, return void.
return true;
}
if ($this->arrayEqual($comparison['destination_id'])) {
// destination ID's are equal, return void.
return true;
}
if ($this->arrayEqual($comparison['destination_name'])) {
// destination names are equal, return void.
return true;
}
return false;
}
/**
* @param array $comparison
* @return bool
*/
private function compareAccountDataWithdrawal(array $comparison): bool
{
if ($this->arrayEqual($comparison['source_id'])) {
// source ID's are equal, return void.
return true;
}
if ($this->arrayEqual($comparison['source_name'])) {
// source names are equal, return void.
return true;
}
return false;
}
/**
* @param array $comparison
* @return bool
*/
private function compareAccountDataDeposit(array $comparison): bool
{
if ($this->arrayEqual($comparison['destination_id'])) {
// destination ID's are equal, return void.
return true;
}
if ($this->arrayEqual($comparison['destination_name'])) {
// destination names are equal, return void.
return true;
}
return false;
}
/** /**
* @param Validator $validator * @param Validator $validator
* @param TransactionGroup $transactionGroup * @param TransactionGroup $transactionGroup
@@ -383,79 +492,29 @@ trait TransactionValidation
Log::debug('Now in validateEqualAccountsForUpdate()'); Log::debug('Now in validateEqualAccountsForUpdate()');
$transactions = $this->getTransactionsArray($validator); $transactions = $this->getTransactionsArray($validator);
// needs to be split if (2 !== count($transactions)) {
if (count($transactions) < 2) {
return; return;
} }
$type = $transactions[0]['type'] ?? strtolower($transactionGroup->transactionJournals()->first()->transactionType->type); $type = $this->getTransactionType($transactionGroup, $transactions);
// compare source ID's, destination ID's, source names and destination names. // compare source ID's, destination ID's, source names and destination names.
// I think I can get away with one combination being equal, as long as the rest // I think I can get away with one combination being equal, as long as the rest
// of the code picks up on this as well. // of the code picks up on this as well.
// either way all fields must be blank or all equal // either way all fields must be blank or all equal
// but if ID's are equal don't bother with the names. // but if ID's are equal don't bother with the names.
$comparison = $this->collectComparisonData($transactions);
$fields = ['source_id', 'destination_id', 'source_name', 'destination_name']; $result = $this->compareAccountData($type, $comparison);
$comparison = []; if (false === $result) {
foreach ($fields as $field) { if ('withdrawal' === $type) {
$comparison[$field] = []; $validator->errors()->add('transactions.0.source_id', (string) trans('validation.all_accounts_equal'));
/** @var array $transaction */ }
foreach ($transactions as $transaction) { if ('deposit' === $type) {
// source or destination may be omitted. If this is the case, use the original source / destination name + ID. $validator->errors()->add('transactions.0.destination_id', (string) trans('validation.all_accounts_equal'));
$originalData = $this->getOriginalData((int)($transaction['transaction_journal_id'] ?? 0)); }
if ('transfer' === $type) {
// get field. $validator->errors()->add('transactions.0.source_id', (string) trans('validation.all_accounts_equal'));
$comparison[$field][] = $transaction[$field] ?? $originalData[$field]; $validator->errors()->add('transactions.0.destination_id', (string) trans('validation.all_accounts_equal'));
} }
}
// TODO not the best way to loop this.
switch ($type) {
default:
case 'withdrawal':
if ($this->arrayEqual($comparison['source_id'])) {
// source ID's are equal, return void.
return;
}
if ($this->arrayEqual($comparison['source_name'])) {
// source names are equal, return void.
return;
}
// add error:
$validator->errors()->add('transactions.0.source_id', (string)trans('validation.all_accounts_equal'));
break;
case 'deposit':
if ($this->arrayEqual($comparison['destination_id'])) {
// destination ID's are equal, return void.
return;
}
if ($this->arrayEqual($comparison['destination_name'])) {
// destination names are equal, return void.
return;
}
// add error:
$validator->errors()->add('transactions.0.destination_id', (string)trans('validation.all_accounts_equal'));
break;
case 'transfer':
if ($this->arrayEqual($comparison['source_id'])) {
// source ID's are equal, return void.
return;
}
if ($this->arrayEqual($comparison['source_name'])) {
// source names are equal, return void.
return;
}
if ($this->arrayEqual($comparison['destination_id'])) {
// destination ID's are equal, return void.
return;
}
if ($this->arrayEqual($comparison['destination_name'])) {
// destination names are equal, return void.
return;
}
// add error:
$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;
} }
} }
} }