IntenseFinance/firefly-iii
3
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-01-13 09:32:48 -06:00
Code Issues Packages 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
No known key found for this signature in database
GPG Key ID: C16961E655E74B5E
3 changed files with 31 additions and 354 deletions
Show Stats 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(); 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 * @param TransactionGroup $transactionGroup
* *
@ -245,23 +178,6 @@ class JournalRepository implements JournalRepositoryInterface
return $result; 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. * Return all attachments for journal.
* *
@ -287,18 +203,6 @@ class JournalRepository implements JournalRepositoryInterface
throw new NotImplementedException; 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). * 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 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). * Return Carbon value of a meta field (or NULL).
* *
@ -538,24 +383,6 @@ class JournalRepository implements JournalRepositoryInterface
return ''; 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. * 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 $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 * @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 * @param User $user
*/ */
@ -853,21 +611,6 @@ class JournalRepository implements JournalRepositoryInterface
->get(['transaction_journals.*']); ->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). * Return Carbon value of a meta field (or NULL).
* *

127
app/Repositories/Journal/JournalRepositoryInterface.php
View File

@ -42,6 +42,8 @@ interface JournalRepositoryInterface
{ {
/** /**
* TODO maybe create JSON repository?
*
* Search in journal descriptions. * Search in journal descriptions.
* *
* @param string $search * @param string $search
@ -50,6 +52,8 @@ interface JournalRepositoryInterface
public function searchJournalDescriptions(string $search): Collection; public function searchJournalDescriptions(string $search): Collection;
/** /**
* TODO maybe create command line repository?
*
* Get all transaction journals with a specific type, regardless of user. * Get all transaction journals with a specific type, regardless of user.
* *
* @param array $types * @param array $types
@ -57,24 +61,6 @@ interface JournalRepositoryInterface
*/ */
public function getAllJournals(array $types): Collection; public function getAllJournals(array $types): Collection;
/**
* Get all transaction journals with a specific type, for the logged in user.
*
* @param array $types
* @return Collection
*/
public function getJournals(array $types): Collection;
/**
* @param TransactionJournal $journal
* @param TransactionType $type
* @param Account $source
* @param Account $destination
*
* @return MessageBag
*/
public function convert(TransactionJournal $journal, TransactionType $type, Account $source, Account $destination): MessageBag;
/** /**
* Deletes a transaction group. * Deletes a transaction group.
* *
@ -90,9 +76,9 @@ interface JournalRepositoryInterface
public function destroyJournal(TransactionJournal $journal): void; public function destroyJournal(TransactionJournal $journal): void;
/** @noinspection MoreThanThreeArgumentsInspection */
/** /**
* TODO move to import repository.
*
* Find a journal by its hash. * Find a journal by its hash.
* *
* @param string $hash * @param string $hash
@ -102,6 +88,7 @@ interface JournalRepositoryInterface
public function findByHash(string $hash): ?TransactionJournalMeta; public function findByHash(string $hash): ?TransactionJournalMeta;
/** /**
* TODO Refactor to "find".
* Find a specific journal. * Find a specific journal.
* *
* @param int $journalId * @param int $journalId
@ -111,6 +98,8 @@ interface JournalRepositoryInterface
public function findNull(int $journalId): ?TransactionJournal; public function findNull(int $journalId): ?TransactionJournal;
/** /**
* TODO maybe create API repository?
*
* @param int $transactionid * @param int $transactionid
* *
* @return Transaction|null * @return Transaction|null
@ -125,13 +114,8 @@ interface JournalRepositoryInterface
public function firstNull(): ?TransactionJournal; public function firstNull(): ?TransactionJournal;
/** /**
* @param TransactionJournal $journal * TODO maybe create API repository?
* *
* @return Transaction|null
*/
public function getAssetTransaction(TransactionJournal $journal): ?Transaction;
/**
* Return all attachments for journal. * Return all attachments for journal.
* *
* @param TransactionJournal $journal * @param TransactionJournal $journal
@ -141,15 +125,8 @@ interface JournalRepositoryInterface
public function getAttachments(TransactionJournal $journal): Collection; public function getAttachments(TransactionJournal $journal): Collection;
/** /**
* Returns the first positive transaction for the journal. Useful when editing journals. * TODO console repository?
* *
* @param TransactionJournal $journal
*
* @return Transaction
*/
public function getFirstPosTransaction(TransactionJournal $journal): Transaction;
/**
* Return the ID of the budget linked to the journal (if any) or the transactions (if any). * Return the ID of the budget linked to the journal (if any) or the transactions (if any).
* *
* @param TransactionJournal $journal * @param TransactionJournal $journal
@ -159,6 +136,8 @@ interface JournalRepositoryInterface
public function getJournalBudgetId(TransactionJournal $journal): int; public function getJournalBudgetId(TransactionJournal $journal): int;
/** /**
* TODO console repository?
*
* Return the ID of the category linked to the journal (if any) or to the transactions (if any). * Return the ID of the category linked to the journal (if any) or to the transactions (if any).
* *
* @param TransactionJournal $journal * @param TransactionJournal $journal
@ -168,39 +147,21 @@ interface JournalRepositoryInterface
public function getJournalCategoryId(TransactionJournal $journal): int; public function getJournalCategoryId(TransactionJournal $journal): int;
/** /**
* Return the name of the category linked to the journal (if any) or to the transactions (if any). * TODO this method is no longer well-fitted in 4.8.0. Should be refactored and/or removed.
*
* @param TransactionJournal $journal
*
* @return string
*/
public function getJournalCategoryName(TransactionJournal $journal): string;
/**
* 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
*/
public function getJournalDate(TransactionJournal $journal, ?string $field): string;
/**
* Return a list of all destination accounts related to journal. * Return a list of all destination accounts related to journal.
* *
* @param TransactionJournal $journal * @param TransactionJournal $journal
* * @deprecated
* @return Collection * @return Collection
*/ */
public function getJournalDestinationAccounts(TransactionJournal $journal): Collection; public function getJournalDestinationAccounts(TransactionJournal $journal): Collection;
/** /**
* TODO this method is no longer well-fitted in 4.8.0. Should be refactored and/or removed.
* Return a list of all source accounts related to journal. * Return a list of all source accounts related to journal.
* *
* @param TransactionJournal $journal * @param TransactionJournal $journal
* * @deprecated
* @return Collection * @return Collection
*/ */
public function getJournalSourceAccounts(TransactionJournal $journal): Collection; public function getJournalSourceAccounts(TransactionJournal $journal): Collection;
@ -215,6 +176,7 @@ interface JournalRepositoryInterface
public function getJournalTotal(TransactionJournal $journal): string; public function getJournalTotal(TransactionJournal $journal): string;
/** /**
* TODO only used on command line.
* Return all journals without a group, used in an upgrade routine. * Return all journals without a group, used in an upgrade routine.
* *
* @return array * @return array
@ -222,6 +184,7 @@ interface JournalRepositoryInterface
public function getJournalsWithoutGroup(): array; public function getJournalsWithoutGroup(): array;
/** /**
* TODO used only in transformer, so only for API use.
* @param TransactionJournalLink $link * @param TransactionJournalLink $link
* *
* @return string * @return string
@ -229,6 +192,7 @@ interface JournalRepositoryInterface
public function getLinkNoteText(TransactionJournalLink $link): string; public function getLinkNoteText(TransactionJournalLink $link): string;
/** /**
* TODO used only on console
* Return Carbon value of a meta field (or NULL). * Return Carbon value of a meta field (or NULL).
* *
* @param TransactionJournal $journal * @param TransactionJournal $journal
@ -249,16 +213,8 @@ interface JournalRepositoryInterface
public function getMetaDateById(int $journalId, string $field): ?Carbon; public function getMetaDateById(int $journalId, string $field): ?Carbon;
/** /**
* Return string value of a meta date (or NULL). * TODO used only on the console.
* *
* @param TransactionJournal $journal
* @param string $field
*
* @return null|string
*/
public function getMetaDateString(TransactionJournal $journal, string $field): ?string;
/**
* Return value of a meta field (or NULL). * Return value of a meta field (or NULL).
* *
* @param TransactionJournal $journal * @param TransactionJournal $journal
@ -269,6 +225,8 @@ interface JournalRepositoryInterface
public function getMetaField(TransactionJournal $journal, string $field): ?string; public function getMetaField(TransactionJournal $journal, string $field): ?string;
/** /**
* TODO used only on the console.
*
* Return text of a note attached to journal, or NULL * Return text of a note attached to journal, or NULL
* *
* @param TransactionJournal $journal * @param TransactionJournal $journal
@ -278,6 +236,8 @@ interface JournalRepositoryInterface
public function getNoteText(TransactionJournal $journal): ?string; public function getNoteText(TransactionJournal $journal): ?string;
/** /**
* TODO used only in the API
*
* @param TransactionJournal $journal * @param TransactionJournal $journal
* *
* @return Collection * @return Collection
@ -285,6 +245,8 @@ interface JournalRepositoryInterface
public function getPiggyBankEvents(TransactionJournal $journal): Collection; public function getPiggyBankEvents(TransactionJournal $journal): Collection;
/** /**
* TODO used only on the console.
*
* Returns all journals with more than 2 transactions. Should only return empty collections * Returns all journals with more than 2 transactions. Should only return empty collections
* in Firefly III > v4.8.0. * in Firefly III > v4.8.0.
* *
@ -293,6 +255,8 @@ interface JournalRepositoryInterface
public function getSplitJournals(): Collection; public function getSplitJournals(): Collection;
/** /**
* TODO used only on the console.
*
* Return all tags as strings in an array. * Return all tags as strings in an array.
* *
* @param TransactionJournal $journal * @param TransactionJournal $journal
@ -302,43 +266,12 @@ interface JournalRepositoryInterface
public function getTags(TransactionJournal $journal): array; public function getTags(TransactionJournal $journal): array;
/** /**
* Return the transaction type of the journal. * TODO maybe move to account repository?
* *
* @param TransactionJournal $journal
*
* @return string
*/
public function getTransactionType(TransactionJournal $journal): string;
/**
* Will tell you if journal is reconciled or not.
*
* @param TransactionJournal $journal
*
* @return bool
*/
public function isJournalReconciled(TransactionJournal $journal): bool;
/**
* @param Transaction $transaction
*
* @return bool
*/
public function reconcile(Transaction $transaction): bool;
/**
* @param int $journalId * @param int $journalId
*/ */
public function reconcileById(int $journalId): void; public function reconcileById(int $journalId): void;
/**
* @param TransactionJournal $journal
* @param int $order
*
* @return bool
*/
public function setOrder(TransactionJournal $journal, int $order): bool;
/** /**
* @param User $user * @param User $user
*/ */

1
app/TransactionRules/Triggers/ToAccountContains.php
View File

@ -65,6 +65,7 @@ final class ToAccountContains extends AbstractTrigger implements TriggerInterfac
/** /**
* Returns true when to-account contains X * Returns true when to-account contains X
* TODO
* *
* @param TransactionJournal $journal * @param TransactionJournal $journal
* *