kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-10-22 12:11:19 +00:00
Code Issues Projects Releases Wiki Activity

Refactor account search.

Browse Source
This commit is contained in:
James Cole
2021-12-18 12:35:17 +01:00
parent 0229fc243a
commit 36ecf25804
16 changed files with 206 additions and 128 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
app/Factory/TransactionJournalFactory.php
View File

@@ -365,19 +365,29 @@ class TransactionJournalFactory
$this->accountValidator->setTransactionType($transactionType); $this->accountValidator->setTransactionType($transactionType);
// validate source account. // validate source account.
$sourceId = $data['source_id'] ? (int)$data['source_id'] : null; $array = [
$sourceName = $data['source_name'] ? (string)$data['source_name'] : null; 'id' => $data['source_id'] ? (int)$data['source_id'] : null,
$validSource = $this->accountValidator->validateSource($sourceId, $sourceName, null); 'name' => $data['source_name'] ? (string)$data['source_name'] : null,
'iban' => $data['source_iban'] ? (string)$data['source_iban'] : null,
'number' => $data['source_number'] ? (string)$data['source_number'] : null,
];
$validSource = $this->accountValidator->validateSource($array);
// do something with result: // do something with result:
if (false === $validSource) { if (false === $validSource) {
throw new FireflyException(sprintf('Source: %s', $this->accountValidator->sourceError)); throw new FireflyException(sprintf('Source: %s', $this->accountValidator->sourceError));
} }
Log::debug('Source seems valid.'); Log::debug('Source seems valid.');
// validate destination account // validate destination account
$destinationId = $data['destination_id'] ? (int)$data['destination_id'] : null; $array = [
$destinationName = $data['destination_name'] ? (string)$data['destination_name'] : null; 'id' => $data['destination_id'] ? (int)$data['destination_id'] : null,
$validDestination = $this->accountValidator->validateDestination($destinationId, $destinationName, null); 'name' => $data['destination_name'] ? (string)$data['destination_name'] : null,
'iban' => $data['destination_iban'] ? (string)$data['destination_iban'] : null,
'number' => $data['destination_number'] ? (string)$data['destination_number'] : null,
];
$validDestination = $this->accountValidator->validateDestination($array);
// do something with result: // do something with result:
if (false === $validDestination) { if (false === $validDestination) {
throw new FireflyException(sprintf('Destination: %s', $this->accountValidator->destError)); throw new FireflyException(sprintf('Destination: %s', $this->accountValidator->destError));

4
app/Http/Controllers/Transaction/ConvertController.php
View File

@@ -336,8 +336,8 @@ class ConvertController extends Controller
$sourceName = '' === $sourceName ? null : (string)$sourceName; $sourceName = '' === $sourceName ? null : (string)$sourceName;
$destinationId = '' === $destinationId || null === $destinationId ? null : (int)$destinationId; $destinationId = '' === $destinationId || null === $destinationId ? null : (int)$destinationId;
$destinationName = '' === $destinationName ? null : (string)$destinationName; $destinationName = '' === $destinationName ? null : (string)$destinationName;
$validSource = $validator->validateSource($sourceId, $sourceName, null); $validSource = $validator->validateSource(['id' => $sourceId, 'name' => $sourceName,]);
$validDestination = $validator->validateDestination($destinationId, $destinationName, null); $validDestination = $validator->validateDestination(['id' => $destinationId, 'name' => $destinationName,]);
if (false === $validSource) { if (false === $validSource) {
throw new FireflyException(sprintf(trans('firefly.convert_invalid_source'), $journal->id)); throw new FireflyException(sprintf(trans('firefly.convert_invalid_source'), $journal->id));

6
app/Http/Requests/RecurrenceFormRequest.php
View File

@@ -295,7 +295,7 @@ class RecurrenceFormRequest extends FormRequest
*/ */
public function validateAccountInformation(Validator $validator): void public function validateAccountInformation(Validator $validator): void
{ {
Log::debug('Now in validateAccountInformation()'); Log::debug('Now in validateAccountInformation (RecurrenceFormRequest)()');
/** @var AccountValidator $accountValidator */ /** @var AccountValidator $accountValidator */
$accountValidator = app(AccountValidator::class); $accountValidator = app(AccountValidator::class);
$data = $validator->getData(); $data = $validator->getData();
@@ -326,7 +326,7 @@ class RecurrenceFormRequest extends FormRequest
break; break;
} }
// validate source account. // validate source account.
$validSource = $accountValidator->validateSource($sourceId, null, null); $validSource = $accountValidator->validateSource(['id' => $sourceId,]);
// do something with result: // do something with result:
if (false === $validSource) { if (false === $validSource) {
@@ -338,7 +338,7 @@ class RecurrenceFormRequest extends FormRequest
} }
// validate destination account // validate destination account
$validDestination = $accountValidator->validateDestination($destinationId, null, null); $validDestination = $accountValidator->validateDestination(['id' => $destinationId,]);
// do something with result: // do something with result:
if (false === $validDestination) { if (false === $validDestination) {
$message = (string)trans('validation.generic_invalid_destination'); $message = (string)trans('validation.generic_invalid_destination');

4
app/Rules/IsTransferAccount.php
View File

@@ -60,14 +60,14 @@ class IsTransferAccount implements Rule
$validator->setTransactionType(TransactionType::TRANSFER); $validator->setTransactionType(TransactionType::TRANSFER);
$validator->setUser(auth()->user()); $validator->setUser(auth()->user());
$validAccount = $validator->validateSource(null, (string)$value, null); $validAccount = $validator->validateSource(['name' => (string)$value,]);
if (true === $validAccount) { if (true === $validAccount) {
Log::debug('Found account based on name. Return true.'); Log::debug('Found account based on name. Return true.');
// found by name, use repos to return. // found by name, use repos to return.
return true; return true;
} }
$validAccount = $validator->validateSource((int)$value, null, null); $validAccount = $validator->validateSource(['id' => (int)$value,]);
Log::debug(sprintf('Search by id (%d), result is %s.', (int)$value, var_export($validAccount, true))); Log::debug(sprintf('Search by id (%d), result is %s.', (int)$value, var_export($validAccount, true)));
return false !== $validAccount; return false !== $validAccount;

2
app/Services/Internal/Support/JournalServiceTrait.php
View File

@@ -77,9 +77,9 @@ trait JournalServiceTrait
Log::debug(sprintf($message, $transactionType, $direction, implode(', ', $expectedTypes[$transactionType] ?? ['UNKNOWN']), $direction)); Log::debug(sprintf($message, $transactionType, $direction, implode(', ', $expectedTypes[$transactionType] ?? ['UNKNOWN']), $direction));
$result = $this->findAccountById($data, $expectedTypes[$transactionType]); $result = $this->findAccountById($data, $expectedTypes[$transactionType]);
$result = $this->findAccountByName($result, $data, $expectedTypes[$transactionType]);
$result = $this->findAccountByIban($result, $data, $expectedTypes[$transactionType]); $result = $this->findAccountByIban($result, $data, $expectedTypes[$transactionType]);
$result = $this->findAccountByNumber($result, $data, $expectedTypes[$transactionType]); $result = $this->findAccountByNumber($result, $data, $expectedTypes[$transactionType]);
$result = $this->findAccountByName($result, $data, $expectedTypes[$transactionType]);
$result = $this->createAccount($result, $data, $expectedTypes[$transactionType][0]); $result = $this->createAccount($result, $data, $expectedTypes[$transactionType][0]);
return $this->getCashAccount($result, $data, $expectedTypes[$transactionType]); return $this->getCashAccount($result, $data, $expectedTypes[$transactionType]);

5
app/Services/Internal/Support/RecurringTransactionTrait.php
View File

@@ -136,11 +136,12 @@ trait RecurringTransactionTrait
$validator = app(AccountValidator::class); $validator = app(AccountValidator::class);
$validator->setUser($recurrence->user); $validator->setUser($recurrence->user);
$validator->setTransactionType($recurrence->transactionType->type); $validator->setTransactionType($recurrence->transactionType->type);
if (!$validator->validateSource($source->id, null, null)) {
if (!$validator->validateSource(['id' => $source->id])) {
throw new FireflyException(sprintf('Source invalid: %s', $validator->sourceError)); throw new FireflyException(sprintf('Source invalid: %s', $validator->sourceError));
} }
if (!$validator->validateDestination($destination->id, null, null)) { if (!$validator->validateDestination(['id' => $destination->id])) {
throw new FireflyException(sprintf('Destination invalid: %s', $validator->destError)); throw new FireflyException(sprintf('Destination invalid: %s', $validator->destError));
} }
if (array_key_exists('foreign_amount', $array) && '' === (string)$array['foreign_amount']) { if (array_key_exists('foreign_amount', $array) && '' === (string)$array['foreign_amount']) {

4
app/Services/Internal/Update/JournalUpdateService.php
View File

@@ -215,7 +215,7 @@ class JournalUpdateService
$validator->setTransactionType($expectedType); $validator->setTransactionType($expectedType);
$validator->setUser($this->transactionJournal->user); $validator->setUser($this->transactionJournal->user);
$result = $validator->validateSource($sourceId, $sourceName, null); $result = $validator->validateSource(['id' =>$sourceId]);
Log::debug(sprintf('hasValidSourceAccount(%d, "%s") will return %s', $sourceId, $sourceName, var_export($result, true))); Log::debug(sprintf('hasValidSourceAccount(%d, "%s") will return %s', $sourceId, $sourceName, var_export($result, true)));
// See reference nr. 95 // See reference nr. 95
@@ -309,7 +309,7 @@ class JournalUpdateService
$validator->setTransactionType($expectedType); $validator->setTransactionType($expectedType);
$validator->setUser($this->transactionJournal->user); $validator->setUser($this->transactionJournal->user);
$validator->source = $this->getValidSourceAccount(); $validator->source = $this->getValidSourceAccount();
$result = $validator->validateDestination($destId, $destName, null); $result = $validator->validateDestination(['id' => $destId]);
Log::debug(sprintf('hasValidDestinationAccount(%d, "%s") will return %s', $destId, $destName, var_export($result, true))); Log::debug(sprintf('hasValidDestinationAccount(%d, "%s") will return %s', $destId, $destName, var_export($result, true)));
// See reference nr. 96 // See reference nr. 96

56
app/Validation/Account/DepositValidation.php
View File

@@ -41,23 +41,24 @@ trait DepositValidation
/** /**
* @param array $validTypes * @param array $validTypes
* @param int $accountId * @param array $data
* @param string $accountName
* *
* @return Account|null * @return Account|null
*/ */
abstract protected function findExistingAccount(array $validTypes, int $accountId, string $accountName): ?Account; abstract protected function findExistingAccount(array $validTypes, array $data): ?Account;
/** /**
* @param int|null $accountId * @param array $array
* @param mixed $accountName
* *
* @return bool * @return bool
*/ */
protected function validateDepositDestination(?int $accountId, $accountName): bool protected function validateDepositDestination(array $array): bool
{ {
$result = null; $result = null;
Log::debug(sprintf('Now in validateDepositDestination(%d, "%s")', $accountId, $accountName)); $accountId = array_key_exists('id', $array) ? $array['id'] : null;
$accountName = array_key_exists('name', $array) ? $array['name'] : null;
Log::debug('Now in validateDepositDestination', $array);
// source can be any of the following types. // source can be any of the following types.
$validTypes = $this->combinations[$this->transactionType][$this->source->accountType->type] ?? []; $validTypes = $this->combinations[$this->transactionType][$this->source->accountType->type] ?? [];
@@ -76,7 +77,7 @@ trait DepositValidation
if (null === $result) { if (null === $result) {
// otherwise try to find the account: // otherwise try to find the account:
$search = $this->findExistingAccount($validTypes, (int)$accountId, (string)$accountName); $search = $this->findExistingAccount($validTypes, $array);
if (null === $search) { if (null === $search) {
Log::debug('findExistingAccount() returned NULL, so the result is false.'); Log::debug('findExistingAccount() returned NULL, so the result is false.');
$this->destError = (string)trans('validation.deposit_dest_bad_data', ['id' => $accountId, 'name' => $accountName]); $this->destError = (string)trans('validation.deposit_dest_bad_data', ['id' => $accountId, 'name' => $accountName]);
@@ -89,20 +90,23 @@ trait DepositValidation
} }
} }
$result = $result ?? false; $result = $result ?? false;
Log::debug(sprintf('validateDepositDestination(%d, "%s") will return %s', $accountId, $accountName, var_export($result, true))); Log::debug(sprintf('validateDepositDestination will return %s', var_export($result, true)));
return $result; return $result;
} }
/** /**
* @param int|null $accountId * @param array $array
* @param string|null $accountName
* *
* @return bool * @return bool
*/ */
protected function validateDepositSource(?int $accountId, ?string $accountName): bool protected function validateDepositSource(array $array): bool
{ {
Log::debug(sprintf('Now in validateDepositSource(%d, "%s")', $accountId, $accountName)); $accountId = array_key_exists('id', $array) ? $array['id'] : null;
$accountName = array_key_exists('name', $array) ? $array['name'] : null;
$accountIban = array_key_exists('iban', $array) ? $array['iban'] : null;
$accountNumber = array_key_exists('number', $array) ? $array['number'] : null;
Log::debug('Now in validateDepositSource', $array);
$result = null; $result = null;
// source can be any of the following types. // source can be any of the following types.
$validTypes = array_keys($this->combinations[$this->transactionType]); $validTypes = array_keys($this->combinations[$this->transactionType]);
@@ -114,12 +118,32 @@ trait DepositValidation
$result = false; $result = false;
} }
// if the user submits an ID only but that ID is not of the correct type, // if the user submits an ID, but that ID is not of the correct type,
// return false. // return false.
if (null !== $accountId && null === $accountName) { if (null !== $accountId) {
$search = $this->accountRepository->find($accountId); $search = $this->accountRepository->find($accountId);
if (null !== $search && !in_array($search->accountType->type, $validTypes, true)) { if (null !== $search && !in_array($search->accountType->type, $validTypes, true)) {
Log::debug(sprintf('User submitted only an ID (#%d), which is a "%s", so this is not a valid source.', $accountId, $search->accountType->type)); Log::debug(sprintf('User submitted an ID (#%d), which is a "%s", so this is not a valid source.', $accountId, $search->accountType->type));
$result = false;
}
}
// if user submits an IBAN:
if (null !== $accountIban) {
$search = $this->accountRepository->findByIbanNull($accountIban, $validTypes);
if (null !== $search && !in_array($search->accountType->type, $validTypes, true)) {
Log::debug(sprintf('User submitted IBAN ("%s"), which is a "%s", so this is not a valid source.', $accountIban, $search->accountType->type));
$result = false;
}
}
// if user submits a number:
if (null !== $accountNumber) {
$search = $this->accountRepository->findByAccountNumber($accountNumber, $validTypes);
if (null !== $search && !in_array($search->accountType->type, $validTypes, true)) {
Log::debug(
sprintf('User submitted number ("%s"), which is a "%s", so this is not a valid source.', $accountNumber, $search->accountType->type)
);
$result = false; $result = false;
} }
} }

14
app/Validation/Account/LiabilityValidation.php
View File

@@ -36,14 +36,15 @@ trait LiabilityValidation
{ {
/** /**
* @param int|null $accountId * @param array $array
* *
* @return bool * @return bool
*/ */
protected function validateLCDestination(?int $accountId): bool protected function validateLCDestination(array $array): bool
{ {
Log::debug(sprintf('Now in validateLCDestination(%d)', $accountId)); Log::debug('Now in validateLCDestination', $array);
$result = null; $result = null;
$accountId = array_key_exists('id', $array) ? $array['id'] : null;
$validTypes = config('firefly.valid_liabilities'); $validTypes = config('firefly.valid_liabilities');
if (null === $accountId) { if (null === $accountId) {
@@ -74,14 +75,15 @@ trait LiabilityValidation
/** /**
* Source of an liability credit must be a liability. * Source of an liability credit must be a liability.
* *
* @param string|null $accountName * @param array $array
* *
* @return bool * @return bool
*/ */
protected function validateLCSource(?string $accountName): bool protected function validateLCSource(array $array): bool
{ {
$accountName = array_key_exists('name', $array) ? $array['name'] : null;
$result = true; $result = true;
Log::debug(sprintf('Now in validateLCDestination("%s")', $accountName)); Log::debug('Now in validateLCDestination', $array);
if ('' === $accountName || null === $accountName) { if ('' === $accountName || null === $accountName) {
$result = false; $result = false;
} }

21
app/Validation/Account/OBValidation.php
View File

@@ -41,15 +41,16 @@ trait OBValidation
abstract protected function canCreateTypes(array $accountTypes): bool; abstract protected function canCreateTypes(array $accountTypes): bool;
/** /**
* @param int|null $accountId * @param array $array
* @param mixed $accountName
* *
* @return bool * @return bool
*/ */
protected function validateOBDestination(?int $accountId, $accountName): bool protected function validateOBDestination(array $array): bool
{ {
$result = null; $result = null;
Log::debug(sprintf('Now in validateOBDestination(%d, "%s")', $accountId, $accountName)); $accountId = array_key_exists('id', $array) ? $array['id'] : null;
$accountName = array_key_exists('name', $array) ? $array['name'] : null;
Log::debug('Now in validateOBDestination', $array);
// source can be any of the following types. // source can be any of the following types.
$validTypes = $this->combinations[$this->transactionType][$this->source->accountType->type] ?? []; $validTypes = $this->combinations[$this->transactionType][$this->source->accountType->type] ?? [];
@@ -68,7 +69,7 @@ trait OBValidation
if (null === $result) { if (null === $result) {
// otherwise try to find the account: // otherwise try to find the account:
$search = $this->findExistingAccount($validTypes, (int)$accountId, (string)$accountName); $search = $this->findExistingAccount($validTypes, $array);
if (null === $search) { if (null === $search) {
Log::debug('findExistingAccount() returned NULL, so the result is false.', $validTypes); Log::debug('findExistingAccount() returned NULL, so the result is false.', $validTypes);
$this->destError = (string)trans('validation.ob_dest_bad_data', ['id' => $accountId, 'name' => $accountName]); $this->destError = (string)trans('validation.ob_dest_bad_data', ['id' => $accountId, 'name' => $accountName]);
@@ -90,15 +91,15 @@ trait OBValidation
* Source of an opening balance can either be an asset account * Source of an opening balance can either be an asset account
* or an "initial balance account". The latter can be created. * or an "initial balance account". The latter can be created.
* *
* @param int|null $accountId * @param array $array
* @param string|null $accountName
* *
* @return bool * @return bool
*/ */
protected function validateOBSource(?int $accountId, ?string $accountName): bool protected function validateOBSource(array $array): bool
{ {
Log::debug(sprintf('Now in validateOBSource(%d, "%s")', $accountId, $accountName)); $accountId = array_key_exists('id', $array) ? $array['id'] : null;
Log::debug(sprintf('The account name is null: %s', var_export(null === $accountName, true))); $accountName = array_key_exists('name', $array) ? $array['name'] : null;
Log::debug('Now in validateOBSource', $array);
$result = null; $result = null;
// source can be any of the following types. // source can be any of the following types.
$validTypes = array_keys($this->combinations[$this->transactionType]); $validTypes = array_keys($this->combinations[$this->transactionType]);

18
app/Validation/Account/ReconciliationValidation.php
View File

@@ -24,6 +24,7 @@ declare(strict_types=1);
namespace FireflyIII\Validation\Account; namespace FireflyIII\Validation\Account;
use FireflyIII\Models\Account;
use FireflyIII\Models\AccountType; use FireflyIII\Models\AccountType;
use Log; use Log;
@@ -32,15 +33,17 @@ use Log;
*/ */
trait ReconciliationValidation trait ReconciliationValidation
{ {
public ?Account $destination;
public ?Account $source;
/** /**
* @param int|null $accountId * @param array $array
* *
* @return bool * @return bool
*/ */
protected function validateReconciliationDestination(?int $accountId): bool protected function validateReconciliationDestination(array $array): bool
{ {
Log::debug('Now in validateReconciliationDestination'); $accountId = array_key_exists('id', $array) ? $array['id'] : null;
Log::debug('Now in validateReconciliationDestination', $array);
if (null === $accountId) { if (null === $accountId) {
Log::debug('Return FALSE'); Log::debug('Return FALSE');
@@ -80,13 +83,14 @@ trait ReconciliationValidation
} }
/** /**
* @param int|null $accountId * @param array $array
* *
* @return bool * @return bool
*/ */
protected function validateReconciliationSource(?int $accountId): bool protected function validateReconciliationSource(array $array): bool
{ {
Log::debug('In validateReconciliationSource'); $accountId = array_key_exists('id', $array) ? $array['id'] : null;
Log::debug('In validateReconciliationSource', $array);
if (null === $accountId) { if (null === $accountId) {
Log::debug('Return FALSE'); Log::debug('Return FALSE');

27
app/Validation/Account/TransferValidation.php
View File

@@ -40,22 +40,22 @@ trait TransferValidation
/** /**
* @param array $validTypes * @param array $validTypes
* @param int $accountId * @param array $data
* @param string $accountName
* *
* @return Account|null * @return Account|null
*/ */
abstract protected function findExistingAccount(array $validTypes, int $accountId, string $accountName): ?Account; abstract protected function findExistingAccount(array $validTypes, array $data): ?Account;
/** /**
* @param int|null $accountId * @param array $array
* @param mixed $accountName
* *
* @return bool * @return bool
*/ */
protected function validateTransferDestination(?int $accountId, $accountName): bool protected function validateTransferDestination(array $array): bool
{ {
Log::debug(sprintf('Now in validateTransferDestination(%d, "%s")', $accountId, $accountName)); $accountId = array_key_exists('id', $array) ? $array['id'] : null;
$accountName = array_key_exists('name', $array) ? $array['name'] : null;
Log::debug('Now in validateTransferDestination', $array);
// source can be any of the following types. // source can be any of the following types.
$validTypes = $this->combinations[$this->transactionType][$this->source->accountType->type] ?? []; $validTypes = $this->combinations[$this->transactionType][$this->source->accountType->type] ?? [];
if (null === $accountId && null === $accountName && false === $this->canCreateTypes($validTypes)) { if (null === $accountId && null === $accountName && false === $this->canCreateTypes($validTypes)) {
@@ -68,7 +68,7 @@ trait TransferValidation
} }
// or try to find the account: // or try to find the account:
$search = $this->findExistingAccount($validTypes, (int)$accountId, (string)$accountName); $search = $this->findExistingAccount($validTypes,$array);
if (null === $search) { if (null === $search) {
$this->destError = (string)trans('validation.transfer_dest_bad_data', ['id' => $accountId, 'name' => $accountName]); $this->destError = (string)trans('validation.transfer_dest_bad_data', ['id' => $accountId, 'name' => $accountName]);
@@ -88,14 +88,15 @@ trait TransferValidation
} }
/** /**
* @param int|null $accountId * @param array $array
* @param string|null $accountName
* *
* @return bool * @return bool
*/ */
protected function validateTransferSource(?int $accountId, ?string $accountName): bool protected function validateTransferSource(array $array): bool
{ {
Log::debug(sprintf('Now in validateTransferSource(%d, "%s")', $accountId, $accountName)); $accountId = array_key_exists('id', $array) ? $array['id'] : null;
$accountName = array_key_exists('name', $array) ? $array['name'] : null;
Log::debug('Now in validateTransferSource', $array);
// source can be any of the following types. // source can be any of the following types.
$validTypes = array_keys($this->combinations[$this->transactionType]); $validTypes = array_keys($this->combinations[$this->transactionType]);
if (null === $accountId && null === $accountName && false === $this->canCreateTypes($validTypes)) { if (null === $accountId && null === $accountName && false === $this->canCreateTypes($validTypes)) {
@@ -108,7 +109,7 @@ trait TransferValidation
} }
// otherwise try to find the account: // otherwise try to find the account:
$search = $this->findExistingAccount($validTypes, (int)$accountId, (string)$accountName); $search = $this->findExistingAccount($validTypes, $array);
if (null === $search) { if (null === $search) {
$this->sourceError = (string)trans('validation.transfer_source_bad_data', ['id' => $accountId, 'name' => $accountName]); $this->sourceError = (string)trans('validation.transfer_source_bad_data', ['id' => $accountId, 'name' => $accountName]);
Log::warning('Not a valid source, cant find it.', $validTypes); Log::warning('Not a valid source, cant find it.', $validTypes);

37
app/Validation/Account/WithdrawalValidation.php
View File

@@ -41,22 +41,22 @@ trait WithdrawalValidation
/** /**
* @param array $validTypes * @param array $validTypes
* @param int $accountId * @param array $data
* @param string $accountName
* *
* @return Account|null * @return Account|null
*/ */
abstract protected function findExistingAccount(array $validTypes, int $accountId, string $accountName): ?Account; abstract protected function findExistingAccount(array $validTypes, array $data): ?Account;
/** /**
* @param int|null $accountId * @param array $array
* @param string|null $accountName
* *
* @return bool * @return bool
*/ */
protected function validateGenericSource(?int $accountId, ?string $accountName): bool protected function validateGenericSource(array $array): bool
{ {
Log::debug(sprintf('Now in validateGenericSource(%d, "%s")', $accountId, $accountName)); $accountId = array_key_exists('id', $array) ? $array['id'] : null;
$accountName = array_key_exists('name', $array) ? $array['name'] : null;
Log::debug('Now in validateGenericSource', $array);
// source can be any of the following types. // source can be any of the following types.
$validTypes = [AccountType::ASSET, AccountType::REVENUE, AccountType::LOAN, AccountType::DEBT, AccountType::MORTGAGE]; $validTypes = [AccountType::ASSET, AccountType::REVENUE, AccountType::LOAN, AccountType::DEBT, AccountType::MORTGAGE];
if (null === $accountId && null === $accountName && false === $this->canCreateTypes($validTypes)) { if (null === $accountId && null === $accountName && false === $this->canCreateTypes($validTypes)) {
@@ -69,7 +69,7 @@ trait WithdrawalValidation
} }
// otherwise try to find the account: // otherwise try to find the account:
$search = $this->findExistingAccount($validTypes, (int)$accountId, (string)$accountName); $search = $this->findExistingAccount($validTypes, $array);
if (null === $search) { if (null === $search) {
$this->sourceError = (string)trans('validation.withdrawal_source_bad_data', ['id' => $accountId, 'name' => $accountName]); $this->sourceError = (string)trans('validation.withdrawal_source_bad_data', ['id' => $accountId, 'name' => $accountName]);
Log::warning('Not a valid source. Cant find it.', $validTypes); Log::warning('Not a valid source. Cant find it.', $validTypes);
@@ -83,14 +83,15 @@ trait WithdrawalValidation
} }
/** /**
* @param int|null $accountId * @param array $array
* @param string|null $accountName
* *
* @return bool * @return bool
*/ */
protected function validateWithdrawalDestination(?int $accountId, ?string $accountName): bool protected function validateWithdrawalDestination(array $array): bool
{ {
Log::debug(sprintf('Now in validateWithdrawalDestination(%d, "%s")', $accountId, $accountName)); $accountId = array_key_exists('id', $array) ? $array['id'] : null;
$accountName = array_key_exists('name', $array) ? $array['name'] : null;
Log::debug('Now in validateWithdrawalDestination()', $array);
// source can be any of the following types. // source can be any of the following types.
$validTypes = $this->combinations[$this->transactionType][$this->source->accountType->type] ?? []; $validTypes = $this->combinations[$this->transactionType][$this->source->accountType->type] ?? [];
if (null === $accountId && null === $accountName && false === $this->canCreateTypes($validTypes)) { if (null === $accountId && null === $accountName && false === $this->canCreateTypes($validTypes)) {
@@ -120,14 +121,16 @@ trait WithdrawalValidation
} }
/** /**
* @param int|null $accountId * @param array $array
* @param string|null $accountName
* *
* @return bool * @return bool
*/ */
protected function validateWithdrawalSource(?int $accountId, ?string $accountName): bool protected function validateWithdrawalSource(array $array): bool
{ {
Log::debug(sprintf('Now in validateWithdrawalSource(%d, "%s")', $accountId, $accountName)); $accountId = array_key_exists('id', $array) ? $array['id'] : null;
$accountName = array_key_exists('name', $array) ? $array['name'] : null;
Log::debug('Now in validateWithdrawalSource', $array);
// source can be any of the following types. // source can be any of the following types.
$validTypes = array_keys($this->combinations[$this->transactionType]); $validTypes = array_keys($this->combinations[$this->transactionType]);
if (null === $accountId && null === $accountName && false === $this->canCreateTypes($validTypes)) { if (null === $accountId && null === $accountName && false === $this->canCreateTypes($validTypes)) {
@@ -140,7 +143,7 @@ trait WithdrawalValidation
} }
// otherwise try to find the account: // otherwise try to find the account:
$search = $this->findExistingAccount($validTypes, (int)$accountId, (string)$accountName); $search = $this->findExistingAccount($validTypes, $array);
if (null === $search) { if (null === $search) {
$this->sourceError = (string)trans('validation.withdrawal_source_bad_data', ['id' => $accountId, 'name' => $accountName]); $this->sourceError = (string)trans('validation.withdrawal_source_bad_data', ['id' => $accountId, 'name' => $accountName]);
Log::warning('Not a valid source. Cant find it.', $validTypes); Log::warning('Not a valid source. Cant find it.', $validTypes);

71
app/Validation/AccountValidator.php
View File

@@ -95,15 +95,13 @@ class AccountValidator
} }
/** /**
* @param int|null $accountId * @param array $array
* @param string|null $accountName
* @param string|null $accountIban
* *
* @return bool * @return bool
*/ */
public function validateDestination(?int $accountId, ?string $accountName, ?string $accountIban): bool public function validateDestination(array $array): bool
{ {
Log::debug(sprintf('Now in AccountValidator::validateDestination(%d, "%s", "%s")', $accountId, $accountName, $accountIban)); Log::debug('Now in AccountValidator::validateDestination()', $array);
if (null === $this->source) { if (null === $this->source) {
Log::error('Source is NULL, always FALSE.'); Log::error('Source is NULL, always FALSE.');
$this->destError = 'No source account validation has taken place yet. Please do this first or overrule the object.'; $this->destError = 'No source account validation has taken place yet. Please do this first or overrule the object.';
@@ -119,22 +117,22 @@ class AccountValidator
break; break;
case TransactionType::WITHDRAWAL: case TransactionType::WITHDRAWAL:
$result = $this->validateWithdrawalDestination($accountId, $accountName); $result = $this->validateWithdrawalDestination($array);
break; break;
case TransactionType::DEPOSIT: case TransactionType::DEPOSIT:
$result = $this->validateDepositDestination($accountId, $accountName); $result = $this->validateDepositDestination($array);
break; break;
case TransactionType::TRANSFER: case TransactionType::TRANSFER:
$result = $this->validateTransferDestination($accountId, $accountName); $result = $this->validateTransferDestination($array);
break; break;
case TransactionType::OPENING_BALANCE: case TransactionType::OPENING_BALANCE:
$result = $this->validateOBDestination($accountId, $accountName); $result = $this->validateOBDestination($array);
break; break;
case TransactionType::LIABILITY_CREDIT: case TransactionType::LIABILITY_CREDIT:
$result = $this->validateLCDestination($accountId); $result = $this->validateLCDestination($array);
break; break;
case TransactionType::RECONCILIATION: case TransactionType::RECONCILIATION:
$result = $this->validateReconciliationDestination($accountId); $result = $this->validateReconciliationDestination($array);
break; break;
} }
@@ -142,39 +140,37 @@ class AccountValidator
} }
/** /**
* @param int|null $accountId * @param array $array
* @param string|null $accountName
* @param string|null $accountIban
* *
* @return bool * @return bool
*/ */
public function validateSource(?int $accountId, ?string $accountName, ?string $accountIban): bool public function validateSource(array $array): bool
{ {
Log::debug(sprintf('Now in AccountValidator::validateSource(%d, "%s", "%s")', $accountId, $accountName, $accountIban)); Log::debug('Now in AccountValidator::validateSource()', $array);
switch ($this->transactionType) { switch ($this->transactionType) {
default: default:
Log::error(sprintf('AccountValidator::validateSource cannot handle "%s", so it will do a generic check.', $this->transactionType)); Log::error(sprintf('AccountValidator::validateSource cannot handle "%s", so it will do a generic check.', $this->transactionType));
$result = $this->validateGenericSource($accountId, $accountName); $result = $this->validateGenericSource($array);
break; break;
case TransactionType::WITHDRAWAL: case TransactionType::WITHDRAWAL:
$result = $this->validateWithdrawalSource($accountId, $accountName); $result = $this->validateWithdrawalSource($array);
break; break;
case TransactionType::DEPOSIT: case TransactionType::DEPOSIT:
$result = $this->validateDepositSource($accountId, $accountName); $result = $this->validateDepositSource($array);
break; break;
case TransactionType::TRANSFER: case TransactionType::TRANSFER:
$result = $this->validateTransferSource($accountId, $accountName); $result = $this->validateTransferSource($array);
break; break;
case TransactionType::OPENING_BALANCE: case TransactionType::OPENING_BALANCE:
$result = $this->validateOBSource($accountId, $accountName); $result = $this->validateOBSource($array);
break; break;
case TransactionType::LIABILITY_CREDIT: case TransactionType::LIABILITY_CREDIT:
$result = $this->validateLCSource($accountName); $result = $this->validateLCSource($array);
break; break;
case TransactionType::RECONCILIATION: case TransactionType::RECONCILIATION:
Log::debug('Calling validateReconciliationSource'); Log::debug('Calling validateReconciliationSource');
$result = $this->validateReconciliationSource($accountId); $result = $this->validateReconciliationSource($array);
break; break;
} }
@@ -204,21 +200,42 @@ class AccountValidator
/** /**
* @param array $validTypes * @param array $validTypes
* @param int $accountId * @param array $data
* @param string $accountName
* *
* @return Account|null * @return Account|null
*/ */
protected function findExistingAccount(array $validTypes, int $accountId, string $accountName): ?Account protected function findExistingAccount(array $validTypes, array $data): ?Account
{ {
Log::debug('Now in findExistingAccount', $data);
$accountId = array_key_exists('id', $data) ? $data['id'] : null;
$accountIban = array_key_exists('iban', $data) ? $data['iban'] : null;
$accountNumber = array_key_exists('number', $data) ? $data['number'] : null;
$accountName = array_key_exists('name', $data) ? $data['name'] : null;
// find by ID // find by ID
if ($accountId > 0) { if (null !== $accountId && $accountId > 0) {
$first = $this->accountRepository->find($accountId); $first = $this->accountRepository->find($accountId);
if ((null !== $first) && in_array($first->accountType->type, $validTypes, true)) { if ((null !== $first) && in_array($first->accountType->type, $validTypes, true)) {
return $first; return $first;
} }
} }
// find by iban
if (null !== $accountIban && '' !== $accountIban) {
$first = $this->accountRepository->findByIbanNull($accountIban, $validTypes);
if ((null !== $first) && in_array($first->accountType->type, $validTypes, true)) {
return $first;
}
}
// find by number
if (null !== $accountNumber && '' !== $accountNumber) {
$first = $this->accountRepository->findByAccountNumber($accountNumber, $validTypes);
if ((null !== $first) && in_array($first->accountType->type, $validTypes, true)) {
return $first;
}
}
// find by name: // find by name:
if ('' !== $accountName) { if ('' !== $accountName) {
return $this->accountRepository->findByName($accountName, $validTypes); return $this->accountRepository->findByName($accountName, $validTypes);

2
app/Validation/RecurrenceValidation.php
View File

@@ -105,7 +105,7 @@ trait RecurrenceValidation
// validate destination account // validate destination account
$destinationId = array_key_exists('destination_id', $transaction) ? (int)$transaction['destination_id'] : null; $destinationId = array_key_exists('destination_id', $transaction) ? (int)$transaction['destination_id'] : null;
$destinationName = $transaction['destination_name'] ?? null; $destinationName = $transaction['destination_name'] ?? null;
$validDestination = $accountValidator->validateDestination($destinationId, $destinationName, null); $validDestination = $accountValidator->validateDestination(['id' => $destinationId, 'name' => $destinationName,]);
// do something with result: // do something with result:
if (false === $validDestination) { if (false === $validDestination) {
$validator->errors()->add(sprintf('transactions.%d.destination_id', $index), $accountValidator->destError); $validator->errors()->add(sprintf('transactions.%d.destination_id', $index), $accountValidator->destError);

23
app/Validation/TransactionValidation.php
View File

@@ -42,7 +42,7 @@ trait TransactionValidation
*/ */
public function validateAccountInformation(Validator $validator): void public function validateAccountInformation(Validator $validator): void
{ {
Log::debug('Now in validateAccountInformation()'); Log::debug('Now in validateAccountInformation (TransactionValidation) ()');
$transactions = $this->getTransactionsArray($validator); $transactions = $this->getTransactionsArray($validator);
$data = $validator->getData(); $data = $validator->getData();
@@ -103,7 +103,14 @@ trait TransactionValidation
$sourceId = array_key_exists('source_id', $transaction) ? (int)$transaction['source_id'] : 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; $sourceName = array_key_exists('source_name', $transaction) ? (string)$transaction['source_name'] : null;
$sourceIban = array_key_exists('source_iban', $transaction) ? (string)$transaction['source_iban'] : null; $sourceIban = array_key_exists('source_iban', $transaction) ? (string)$transaction['source_iban'] : null;
$validSource = $accountValidator->validateSource($sourceId, $sourceName, $sourceIban); $sourceNumber = array_key_exists('source_number', $transaction) ? (string)$transaction['source_number'] : null;
$array = [
'id' => $sourceId,
'name' => $sourceName,
'iban' => $sourceIban,
'number' => $sourceNumber,
];
$validSource = $accountValidator->validateSource($array);
// do something with result: // do something with result:
if (false === $validSource) { if (false === $validSource) {
@@ -116,7 +123,14 @@ trait TransactionValidation
$destinationId = array_key_exists('destination_id', $transaction) ? (int)$transaction['destination_id'] : 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; $destinationName = array_key_exists('destination_name', $transaction) ? (string)$transaction['destination_name'] : null;
$destinationIban = array_key_exists('destination_iban', $transaction) ? (string)$transaction['destination_iban'] : null; $destinationIban = array_key_exists('destination_iban', $transaction) ? (string)$transaction['destination_iban'] : null;
$validDestination = $accountValidator->validateDestination($destinationId, $destinationName, $destinationIban); $destinationNumber = array_key_exists('destination_number', $transaction) ? (string)$transaction['destination_number'] : null;
$array = [
'id' => $destinationId,
'name' => $destinationName,
'iban' => $destinationIban,
'number' => $destinationNumber,
];
$validDestination = $accountValidator->validateDestination($array);
// do something with result: // do something with result:
if (false === $validDestination) { if (false === $validDestination) {
$validator->errors()->add(sprintf('transactions.%d.destination_id', $index), $accountValidator->destError); $validator->errors()->add(sprintf('transactions.%d.destination_id', $index), $accountValidator->destError);
@@ -204,7 +218,8 @@ trait TransactionValidation
} }
$destinationId = (int)($transaction['destination_id'] ?? 0); $destinationId = (int)($transaction['destination_id'] ?? 0);
$destinationName = $transaction['destination_name'] ?? null; $destinationName = $transaction['destination_name'] ?? null;
$validDestination = $accountValidator->validateDestination($destinationId, $destinationName, null); $array = ['id' => $destinationId, 'name' => $destinationName,];
$validDestination = $accountValidator->validateDestination($array);
// do something with result: // do something with result:
if (false === $validDestination) { if (false === $validDestination) {
Log::warning('Looks like the destination account is not valid so complain to the user about it.'); Log::warning('Looks like the destination account is not valid so complain to the user about it.');