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

Various code reshuffelling.

Browse Source
This commit is contained in:
James Cole
2021-03-12 06:20:01 +01:00
parent 97561ab9c9
commit 748d61fb8f
51 changed files with 1874 additions and 1873 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
app/Repositories/Journal/JournalAPIRepository.php
View File

@@ -48,9 +48,9 @@ class JournalAPIRepository implements JournalAPIRepositoryInterface
public function findTransaction(int $transactionId): ?Transaction
{
return Transaction::leftJoin('transaction_journals', 'transaction_journals.id', '=', 'transactions.transaction_journal_id')
->where('transaction_journals.user_id', $this->user->id)
->where('transactions.id', $transactionId)
->first(['transactions.*']);
->where('transaction_journals.user_id', $this->user->id)
->where('transactions.id', $transactionId)
->first(['transactions.*']);
}
/**
@@ -78,6 +78,16 @@ class JournalAPIRepository implements JournalAPIRepositoryInterface
);
}
/**
* @inheritDoc
*/
public function getJournalLinks(TransactionJournal $journal): Collection
{
$collection = $journal->destJournalLinks()->get();
return $journal->sourceJournalLinks()->get()->merge($collection);
}
/**
* Get all piggy bank events for a journal.
*
@@ -105,14 +115,4 @@ class JournalAPIRepository implements JournalAPIRepositoryInterface
{
$this->user = $user;
}
/**
* @inheritDoc
*/
public function getJournalLinks(TransactionJournal $journal): Collection
{
$collection = $journal->destJournalLinks()->get();
return $journal->sourceJournalLinks()->get()->merge($collection);
}
}

116
app/Repositories/Journal/JournalCLIRepositoryInterface.php
View File

@@ -33,64 +33,6 @@ use Illuminate\Support\Collection;
*/
interface JournalCLIRepositoryInterface
{
/**
* @param User $user
*/
public function setUser(User $user);
/**
* Return all tags as strings in an array.
*
* @param TransactionJournal $journal
*
* @return array
*/
public function getTags(TransactionJournal $journal): array;
/**
* Returns all journals with more than 2 transactions. Should only return empty collections
* in Firefly III > v4.8,0.
*
* @return Collection
*/
public function getSplitJournals(): Collection;
/**
* Return text of a note attached to journal, or NULL
*
* @param TransactionJournal $journal
*
* @return string|null
*/
public function getNoteText(TransactionJournal $journal): ?string;
/**
* Return value of a meta field (or NULL).
*
* @param TransactionJournal $journal
* @param string $field
*
* @return null|string
*/
public function getMetaField(TransactionJournal $journal, string $field): ?string;
/**
* Return Carbon value of a meta field (or NULL).
*
* @param TransactionJournal $journal
* @param string $field
*
* @return null|Carbon
*/
public function getMetaDate(TransactionJournal $journal, string $field): ?Carbon;
/**
* Return all journals without a group, used in an upgrade routine.
*
* @return array
*/
public function getJournalsWithoutGroup(): array;
/**
* Get all transaction journals with a specific type, regardless of user.
*
@@ -118,4 +60,62 @@ interface JournalCLIRepositoryInterface
*/
public function getJournalCategoryId(TransactionJournal $journal): int;
/**
* Return all journals without a group, used in an upgrade routine.
*
* @return array
*/
public function getJournalsWithoutGroup(): array;
/**
* Return Carbon value of a meta field (or NULL).
*
* @param TransactionJournal $journal
* @param string $field
*
* @return null|Carbon
*/
public function getMetaDate(TransactionJournal $journal, string $field): ?Carbon;
/**
* Return value of a meta field (or NULL).
*
* @param TransactionJournal $journal
* @param string $field
*
* @return null|string
*/
public function getMetaField(TransactionJournal $journal, string $field): ?string;
/**
* Return text of a note attached to journal, or NULL
*
* @param TransactionJournal $journal
*
* @return string|null
*/
public function getNoteText(TransactionJournal $journal): ?string;
/**
* Returns all journals with more than 2 transactions. Should only return empty collections
* in Firefly III > v4.8,0.
*
* @return Collection
*/
public function getSplitJournals(): Collection;
/**
* Return all tags as strings in an array.
*
* @param TransactionJournal $journal
*
* @return array
*/
public function getTags(TransactionJournal $journal): array;
/**
* @param User $user
*/
public function setUser(User $user);
}

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

@@ -37,7 +37,6 @@ use FireflyIII\Services\Internal\Update\JournalUpdateService;
use FireflyIII\Support\CacheProperties;
use FireflyIII\User;
use Illuminate\Support\Collection;
use Log;
/**
* Class JournalRepository.
@@ -49,24 +48,6 @@ class JournalRepository implements JournalRepositoryInterface
/** @var User */
private $user;
/**
* Search in journal descriptions.
*
* @param string $search
* @param int $limit
* @return Collection
*/
public function searchJournalDescriptions(string $search, int $limit): Collection
{
$query = $this->user->transactionJournals()
->orderBy('date', 'DESC');
if ('' !== $query) {
$query->where('description', 'LIKE', sprintf('%%%s%%', $search));
}
return $query->take($limit)->get();
}
/**
* @param TransactionGroup $transactionGroup
*
@@ -89,6 +70,18 @@ class JournalRepository implements JournalRepositoryInterface
$service->destroy($journal);
}
/**
* @inheritDoc
*/
public function findByType(array $types): Collection
{
return $this->user
->transactionJournals()
->leftJoin('transaction_types', 'transaction_types.id', '=', 'transaction_journals.transaction_type_id')
->whereIn('transaction_types.type', $types)
->get(['transaction_journals.*']);
}
/**
* Find a specific journal.
*
@@ -118,11 +111,25 @@ class JournalRepository implements JournalRepositoryInterface
return $result;
}
/**
* @inheritDoc
*/
public function getDestinationAccount(TransactionJournal $journal): Account
{
/** @var Transaction $transaction */
$transaction = $journal->transactions()->with('account')->where('amount', '>', 0)->first();
if (null === $transaction) {
throw new FireflyException(sprintf('Your administration is broken. Transaction journal #%d has no destination transaction.', $journal->id));
}
return $transaction->account;
}
/**
* Return a list of all destination accounts related to journal.
*
* @param TransactionJournal $journal
* @param bool $useCache
* @param bool $useCache
*
* @return Collection
*/
@@ -150,7 +157,7 @@ class JournalRepository implements JournalRepositoryInterface
* Return a list of all source accounts related to journal.
*
* @param TransactionJournal $journal
* @param bool $useCache
* @param bool $useCache
*
* @return Collection
*/
@@ -198,6 +205,21 @@ class JournalRepository implements JournalRepositoryInterface
return $amount;
}
/**
* @return TransactionJournal|null
*/
public function getLast(): ?TransactionJournal
{
/** @var TransactionJournal $entry */
$entry = $this->user->transactionJournals()->orderBy('date', 'DESC')->first(['transaction_journals.*']);
$result = null;
if (null !== $entry) {
$result = $entry;
}
return $result;
}
/**
* @param TransactionJournalLink $link
*
@@ -214,107 +236,6 @@ class JournalRepository implements JournalRepositoryInterface
return '';
}
/**
* @param int $transactionId
*/
public function reconcileById(int $journalId): void
{
/** @var TransactionJournal $journal */
$journal = $this->user->transactionJournals()->find($journalId);
if (null !== $journal) {
$journal->transactions()->update(['reconciled' => true]);
}
}
/**
* @param User $user
*/
public function setUser(User $user): void
{
$this->user = $user;
}
/**
* Update budget for a journal.
*
* @param TransactionJournal $journal
* @param int $budgetId
*
* @return TransactionJournal
*/
public function updateBudget(TransactionJournal $journal, int $budgetId): TransactionJournal
{
/** @var JournalUpdateService $service */
$service = app(JournalUpdateService::class);
$service->setTransactionJournal($journal);
$service->setData(
[
'budget_id' => $budgetId,
]
);
$service->update();
$journal->refresh();
return $journal;
}
/**
* Update category for a journal.
*
* @param TransactionJournal $journal
* @param string $category
*
* @return TransactionJournal
*/
public function updateCategory(TransactionJournal $journal, string $category): TransactionJournal
{
/** @var JournalUpdateService $service */
$service = app(JournalUpdateService::class);
$service->setTransactionJournal($journal);
$service->setData(
[
'category_name' => $category,
]
);
$service->update();
$journal->refresh();
return $journal;
}
/**
* Update tag(s) for a journal.
*
* @param TransactionJournal $journal
* @param array $tags
*
* @return TransactionJournal
*/
public function updateTags(TransactionJournal $journal, array $tags): TransactionJournal
{
/** @var JournalUpdateService $service */
$service = app(JournalUpdateService::class);
$service->setTransactionJournal($journal);
$service->setData(
[
'tags' => $tags,
]
);
$service->update();
$journal->refresh();
return $journal;
}
/**
* Return Carbon value of a meta field (or NULL).
*
@@ -359,43 +280,114 @@ class JournalRepository implements JournalRepositoryInterface
}
/**
* @inheritDoc
* @param int $transactionId
*/
public function getDestinationAccount(TransactionJournal $journal): Account
public function reconcileById(int $journalId): void
{
/** @var Transaction $transaction */
$transaction = $journal->transactions()->with('account')->where('amount', '>', 0)->first();
if (null === $transaction) {
throw new FireflyException(sprintf('Your administration is broken. Transaction journal #%d has no destination transaction.', $journal->id));
/** @var TransactionJournal $journal */
$journal = $this->user->transactionJournals()->find($journalId);
if (null !== $journal) {
$journal->transactions()->update(['reconciled' => true]);
}
return $transaction->account;
}
/**
* @return TransactionJournal|null
* Search in journal descriptions.
*
* @param string $search
* @param int $limit
*
* @return Collection
*/
public function getLast(): ?TransactionJournal
public function searchJournalDescriptions(string $search, int $limit): Collection
{
/** @var TransactionJournal $entry */
$entry = $this->user->transactionJournals()->orderBy('date', 'DESC')->first(['transaction_journals.*']);
$result = null;
if (null !== $entry) {
$result = $entry;
$query = $this->user->transactionJournals()
->orderBy('date', 'DESC');
if ('' !== $query) {
$query->where('description', 'LIKE', sprintf('%%%s%%', $search));
}
return $result;
return $query->take($limit)->get();
}
/**
* @inheritDoc
* @param User $user
*/
public function findByType(array $types): Collection
public function setUser(User $user): void
{
return $this->user
->transactionJournals()
->leftJoin('transaction_types', 'transaction_types.id', '=', 'transaction_journals.transaction_type_id')
->whereIn('transaction_types.type', $types)
->get(['transaction_journals.*']);
$this->user = $user;
}
/**
* Update budget for a journal.
*
* @param TransactionJournal $journal
* @param int $budgetId
*
* @return TransactionJournal
*/
public function updateBudget(TransactionJournal $journal, int $budgetId): TransactionJournal
{
/** @var JournalUpdateService $service */
$service = app(JournalUpdateService::class);
$service->setTransactionJournal($journal);
$service->setData(
[
'budget_id' => $budgetId,
]
);
$service->update();
$journal->refresh();
return $journal;
}
/**
* Update category for a journal.
*
* @param TransactionJournal $journal
* @param string $category
*
* @return TransactionJournal
*/
public function updateCategory(TransactionJournal $journal, string $category): TransactionJournal
{
/** @var JournalUpdateService $service */
$service = app(JournalUpdateService::class);
$service->setTransactionJournal($journal);
$service->setData(
[
'category_name' => $category,
]
);
$service->update();
$journal->refresh();
return $journal;
}
/**
* Update tag(s) for a journal.
*
* @param TransactionJournal $journal
* @param array $tags
*
* @return TransactionJournal
*/
public function updateTags(TransactionJournal $journal, array $tags): TransactionJournal
{
/** @var JournalUpdateService $service */
$service = app(JournalUpdateService::class);
$service->setTransactionJournal($journal);
$service->setData(
[
'tags' => $tags,
]
);
$service->update();
$journal->refresh();
return $journal;
}
}

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

@@ -36,28 +36,6 @@ use Illuminate\Support\Collection;
*/
interface JournalRepositoryInterface
{
/**
* @return TransactionJournal|null
*/
public function getLast(): ?TransactionJournal;
/**
* @param array $types
*
* @return Collection
*/
public function findByType(array $types): Collection;
/**
* Search in journal descriptions.
*
* @param string $search
* @param int $limit
*
* @return Collection
*/
public function searchJournalDescriptions(string $search, int $limit): Collection;
/**
* Deletes a transaction group.
*
@@ -72,6 +50,13 @@ interface JournalRepositoryInterface
*/
public function destroyJournal(TransactionJournal $journal): void;
/**
* @param array $types
*
* @return Collection
*/
public function findByType(array $types): Collection;
/**
* TODO Refactor to "find".
* Find a specific journal.
@@ -89,13 +74,24 @@ interface JournalRepositoryInterface
*/
public function firstNull(): ?TransactionJournal;
/**
* Returns the destination account of the journal.
*
* @param TransactionJournal $journal
*
* @return Account
* @throws FireflyException
*/
public function getDestinationAccount(TransactionJournal $journal): Account;
/**
* TODO this method is no longer well-fitted in 4.8,0. Should be refactored and/or removed.
* Return a list of all destination accounts related to journal.
*
* @param TransactionJournal $journal
* @deprecated
*
* @return Collection
* @deprecated
*/
public function getJournalDestinationAccounts(TransactionJournal $journal): Collection;
@@ -104,11 +100,45 @@ interface JournalRepositoryInterface
* Return a list of all source accounts related to journal.
*
* @param TransactionJournal $journal
* @deprecated
*
* @return Collection
* @deprecated
*/
public function getJournalSourceAccounts(TransactionJournal $journal): Collection;
/**
* Return total amount of journal. Is always positive.
*
* @param TransactionJournal $journal
*
* @return string
*/
public function getJournalTotal(TransactionJournal $journal): string;
/**
* @return TransactionJournal|null
*/
public function getLast(): ?TransactionJournal;
/**
* TODO used only in transformer, so only for API use.
*
* @param TransactionJournalLink $link
*
* @return string
*/
public function getLinkNoteText(TransactionJournalLink $link): string;
/**
* Return Carbon value of a meta field (or NULL).
*
* @param int $journalId
* @param string $field
*
* @return null|Carbon
*/
public function getMetaDateById(int $journalId, string $field): ?Carbon;
/**
* Returns the source account of the journal.
*
@@ -119,47 +149,6 @@ interface JournalRepositoryInterface
*/
public function getSourceAccount(TransactionJournal $journal): Account;
/**
* Returns the destination account of the journal.
*
* @param TransactionJournal $journal
* @return Account
* @throws FireflyException
*/
public function getDestinationAccount(TransactionJournal $journal): Account;
/**
* Return total amount of journal. Is always positive.
*
* @param TransactionJournal $journal
*
* @return string
*/
public function getJournalTotal(TransactionJournal $journal): string;
/**
* TODO used only in transformer, so only for API use.
* @param TransactionJournalLink $link
*
* @return string
*/
public function getLinkNoteText(TransactionJournalLink $link): string;
/**
* Return Carbon value of a meta field (or NULL).
*
* @param int $journalId
* @param string $field
*
* @return null|Carbon
*/
public function getMetaDateById(int $journalId, string $field): ?Carbon;
/**
* TODO maybe move to account repository?
*
@@ -167,6 +156,16 @@ interface JournalRepositoryInterface
*/
public function reconcileById(int $journalId): void;
/**
* Search in journal descriptions.
*
* @param string $search
* @param int $limit
*
* @return Collection
*/
public function searchJournalDescriptions(string $search, int $limit): Collection;
/**
* @param User $user
*/
@@ -176,7 +175,7 @@ interface JournalRepositoryInterface
* Update budget for a journal.
*
* @param TransactionJournal $journal
* @param int $budgetId
* @param int $budgetId
*
* @return TransactionJournal
*/
@@ -186,7 +185,7 @@ interface JournalRepositoryInterface
* Update category for a journal.
*
* @param TransactionJournal $journal
* @param string $category
* @param string $category
*
* @return TransactionJournal
*/
@@ -196,7 +195,7 @@ interface JournalRepositoryInterface
* Update tag(s) for a journal.
*
* @param TransactionJournal $journal
* @param array $tags
* @param array $tags
*
* @return TransactionJournal
*/