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

Cleanup journal repository

Browse Source
This commit is contained in:
James Cole
2019-08-10 08:42:46 +02:00
parent edb038c822
commit 94b8bb8f66
3 changed files with 31 additions and 354 deletions
Download Patch File Download Diff File Expand all files Collapse all files

257
app/Repositories/Journal/JournalRepository.php
View File

@@ -86,73 +86,6 @@ class JournalRepository implements JournalRepositoryInterface
return $query->get();
}
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* @param TransactionJournal $journal
* @param TransactionType $type
* @param Account $source
* @param Account $destination
*
* @return MessageBag
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
*/
public function convert(TransactionJournal $journal, TransactionType $type, Account $source, Account $destination): MessageBag
{
if ($source->id === $destination->id || null === $source->id || null === $destination->id) {
// default message bag that shows errors for everything.
$messages = new MessageBag;
$messages->add('source_account_revenue', (string)trans('firefly.invalid_convert_selection'));
$messages->add('destination_account_asset', (string)trans('firefly.invalid_convert_selection'));
$messages->add('destination_account_expense', (string)trans('firefly.invalid_convert_selection'));
$messages->add('source_account_asset', (string)trans('firefly.invalid_convert_selection'));
return $messages;
}
$srcTransaction = $journal->transactions()->where('amount', '<', 0)->first();
$dstTransaction = $journal->transactions()->where('amount', '>', 0)->first();
if (null === $srcTransaction || null === $dstTransaction) {
// default message bag that shows errors for everything.
$messages = new MessageBag;
$messages->add('source_account_revenue', (string)trans('firefly.source_or_dest_invalid'));
$messages->add('destination_account_asset', (string)trans('firefly.source_or_dest_invalid'));
$messages->add('destination_account_expense', (string)trans('firefly.source_or_dest_invalid'));
$messages->add('source_account_asset', (string)trans('firefly.source_or_dest_invalid'));
return $messages;
}
// update transactions, and update journal:
$srcTransaction->account_id = $source->id;
$dstTransaction->account_id = $destination->id;
$journal->transaction_type_id = $type->id;
$dstTransaction->save();
$srcTransaction->save();
$journal->save();
// if journal is a transfer now, remove budget:
if (TransactionType::TRANSFER === $type->type) {
$journal->budgets()->detach();
// also from transactions:
foreach ($journal->transactions as $transaction) {
$transaction->budgets()->detach();
}
}
// if journal is not a withdrawal, remove the bill ID.
if (TransactionType::WITHDRAWAL !== $type->type) {
$journal->bill_id = null;
$journal->save();
}
app('preferences')->mark();
return new MessageBag;
}
/**
* @param TransactionGroup $transactionGroup
*
@@ -245,23 +178,6 @@ class JournalRepository implements JournalRepositoryInterface
return $result;
}
/**
* @param TransactionJournal $journal
*
* @return Transaction|null
*/
public function getAssetTransaction(TransactionJournal $journal): ?Transaction
{
/** @var Transaction $transaction */
foreach ($journal->transactions as $transaction) {
if (AccountType::ASSET === $transaction->account->accountType->type) {
return $transaction;
}
}
return null;
}
/**
* Return all attachments for journal.
*
@@ -287,18 +203,6 @@ class JournalRepository implements JournalRepositoryInterface
throw new NotImplementedException;
}
/**
* Returns the first positive transaction for the journal. Useful when editing journals.
*
* @param TransactionJournal $journal
*
* @return Transaction
*/
public function getFirstPosTransaction(TransactionJournal $journal): Transaction
{
return $journal->transactions()->where('amount', '>', 0)->first();
}
/**
* Return the ID of the budget linked to the journal (if any) or the transactions (if any).
*
@@ -343,65 +247,6 @@ class JournalRepository implements JournalRepositoryInterface
return 0;
}
/**
* Return the name of the category linked to the journal (if any) or to the transactions (if any).
*
* @param TransactionJournal $journal
*
* @return string
*/
public function getJournalCategoryName(TransactionJournal $journal): string
{
$category = $journal->categories()->first();
if (null !== $category) {
return $category->name;
}
/** @noinspection NullPointerExceptionInspection */
$category = $journal->transactions()->first()->categories()->first();
if (null !== $category) {
return $category->name;
}
return '';
}
/**
* Return requested date as string. When it's a NULL return the date of journal,
* otherwise look for meta field and return that one.
*
* @param TransactionJournal $journal
* @param null|string $field
*
* @return string
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
*/
public function getJournalDate(TransactionJournal $journal, ?string $field): string
{
if (null === $field) {
return $journal->date->format('Y-m-d');
}
/** @noinspection NotOptimalIfConditionsInspection */
if (null !== $journal->$field && $journal->$field instanceof Carbon) {
// make field NULL
$carbon = clone $journal->$field;
$journal->$field = null;
$journal->save();
// create meta entry
$this->setMetaDate($journal, $field, $carbon);
// return that one instead.
return $carbon->format('Y-m-d');
}
$metaField = $this->getMetaDate($journal, $field);
if (null !== $metaField) {
return $metaField->format('Y-m-d');
}
return '';
}
/**
* Return Carbon value of a meta field (or NULL).
*
@@ -538,24 +383,6 @@ class JournalRepository implements JournalRepositoryInterface
return '';
}
/**
* Return string value of a meta date (or NULL).
*
* @param TransactionJournal $journal
* @param string $field
*
* @return null|string
*/
public function getMetaDateString(TransactionJournal $journal, string $field): ?string
{
$date = $this->getMetaDate($journal, $field);
if (null === $date) {
return null;
}
return $date->format('Y-m-d');
}
/**
* Return value of a meta field (or NULL) as a string.
*
@@ -676,36 +503,6 @@ class JournalRepository implements JournalRepositoryInterface
return $journal->tags()->get()->pluck('tag')->toArray();
}
/**
* Return the transaction type of the journal.
*
* @param TransactionJournal $journal
*
* @return string
*/
public function getTransactionType(TransactionJournal $journal): string
{
return $journal->transactionType->type;
}
/**
* Will tell you if journal is reconciled or not.
*
* @param TransactionJournal $journal
*
* @return bool
*/
public function isJournalReconciled(TransactionJournal $journal): bool
{
foreach ($journal->transactions as $transaction) {
if ($transaction->reconciled) {
return true;
}
}
return false;
}
/**
* @param int $transactionId
*/
@@ -718,45 +515,6 @@ class JournalRepository implements JournalRepositoryInterface
}
}
/**
* @param Transaction $transaction
*
* @return bool
*/
public function reconcile(Transaction $transaction): bool
{
Log::debug(sprintf('Going to reconcile transaction #%d', $transaction->id));
$opposing = $this->findOpposingTransaction($transaction);
if (null === $opposing) {
Log::debug('Opposing transaction is NULL. Cannot reconcile.');
return false;
}
Log::debug(sprintf('Opposing transaction ID is #%d', $opposing->id));
$transaction->reconciled = true;
$opposing->reconciled = true;
$transaction->save();
$opposing->save();
return true;
}
/**
* @param TransactionJournal $journal
* @param int $order
*
* @return bool
*/
public function setOrder(TransactionJournal $journal, int $order): bool
{
$journal->order = $order;
$journal->save();
return true;
}
/**
* @param User $user
*/
@@ -853,21 +611,6 @@ class JournalRepository implements JournalRepositoryInterface
->get(['transaction_journals.*']);
}
/**
* Get all transaction journals with a specific type, for the logged in user.
*
* @param array $types
* @return Collection
*/
public function getJournals(array $types): Collection
{
return $this->user->transactionJournals()
->leftJoin('transaction_types', 'transaction_types.id', '=', 'transaction_journals.transaction_type_id')
->whereIn('transaction_types.type', $types)
->with(['user', 'transactionType', 'transactionCurrency', 'transactions', 'transactions.account'])
->get(['transaction_journals.*']);
}
/**
* Return Carbon value of a meta field (or NULL).
*