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

Refactor validation method.

Browse Source
This commit is contained in:
James Cole
2020-03-21 05:56:27 +01:00
parent affc198b03
commit 11e3834235
4 changed files with 93 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

89
app/Validation/GroupValidation.php Normal file
View File

@@ -0,0 +1,89 @@
<?php
declare(strict_types=1);
/**
* GroupValidation.php
* Copyright (c) 2020 thegrumpydictator@gmail.com
*
* This file is part of Firefly III (https://github.com/firefly-iii).
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
namespace FireflyIII\Validation;
use FireflyIII\Models\TransactionGroup;
use Illuminate\Validation\Validator;
use Log;
/**
* Trait GroupValidation.
*
* This trait combines some of the validation methods used to validate if journal and group data is submitted correctly.
*/
trait GroupValidation
{
/**
* @param Validator $validator
*
* @return array
*/
abstract protected function getTransactionsArray(Validator $validator): array;
/**
* This method validates if the user has submitted transaction journal ID's for each array they submit, if they've submitted more than 1 transaction
* journal. This check is necessary because Firefly III isn't able to distinguish between journals without the ID.
*
* @param Validator $validator
* @param TransactionGroup $transactionGroup
*/
protected function validateJournalIds(Validator $validator, TransactionGroup $transactionGroup): void
{
Log::debug(sprintf('Now in GroupValidation::validateJournalIds(%d)', $transactionGroup->id));
$transactions = $this->getTransactionsArray($validator);
if (count($transactions) < 2) {
// no need for validation.
return;
}
// check each array:
/**
* @var int $index
* @var array $transaction
*/
foreach ($transactions as $index => $transaction) {
$this->validateJournalId($validator, $index, $transaction, $transactionGroup);
}
}
/**
* Do the validation required by validateJournalIds.
*
* @param Validator $validator
* @param int $index
* @param array $transaction
* @param TransactionGroup $transactionGroup
*
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
*/
private function validateJournalid(Validator $validator, int $index, array $transaction, TransactionGroup $transactionGroup): void
{
$journalId = $transaction['transaction_journal_id'] ?? null;
$journalId = null === $journalId ? null : (int) $journalId;
$count = $transactionGroup->transactionJournals()->where('id', $journalId)->count();
if (null === $journalId || (null !== $journalId && 0 !== $journalId && 0 === $count)) {
$validator->errors()->add(sprintf('transactions.%d.source_name', $index), (string) trans('validation.need_id_in_edit'));
}
}
}

24
app/Validation/TransactionValidation.php
View File

@@ -381,7 +381,7 @@ trait TransactionValidation
*
* @return array
*/
private function getTransactionsArray(Validator $validator): array
protected function getTransactionsArray(Validator $validator): array
{
$data = $validator->getData();
$transactions = $data['transactions'] ?? [];
@@ -524,26 +524,4 @@ trait TransactionValidation
break;
}
}
/**
* @param Validator $validator
* @param TransactionGroup $transactionGroup
*/
private function validateJournalIds(Validator $validator, TransactionGroup $transactionGroup): void
{
Log::debug('Now in validateJournalIds()');
$transactions = $this->getTransactionsArray($validator);
if (count($transactions) < 2) {
return;
}
foreach ($transactions as $index => $transaction) {
$journalId = $transaction['transaction_journal_id'] ?? null;
$journalId = null === $journalId ? null : (int)$journalId;
$count = $transactionGroup->transactionJournals()->where('id', $journalId)->count();
if (null === $journalId || (null !== $journalId && 0 !== $journalId && 0 === $count)) {
$validator->errors()->add(sprintf('transactions.%d.source_name', $index), (string)trans('validation.need_id_in_edit'));
}
}
}
}