Various PSR12 code cleanup

This commit is contained in:
James Cole
2022-12-29 19:42:26 +01:00
parent dbf3e76ecc
commit 6cfdc58cb1
415 changed files with 7462 additions and 6874 deletions

View File

@@ -47,6 +47,7 @@ use FireflyIII\Support\NullArrayObject;
use FireflyIII\User;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Support\Collection;
use JsonException;
use Log;
/**
@@ -68,7 +69,19 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
}
/**
* @param TransactionGroup $group
* Find a transaction group by its ID.
*
* @param int $groupId
*
* @return TransactionGroup|null
*/
public function find(int $groupId): ?TransactionGroup
{
return $this->user->transactionGroups()->find($groupId);
}
/**
* @param TransactionGroup $group
*/
public function destroy(TransactionGroup $group): void
{
@@ -92,7 +105,7 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
}
/**
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @return array
*/
@@ -119,7 +132,7 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
}
/**
* @param Transaction $transaction
* @param Transaction $transaction
*
* @return array
*/
@@ -141,22 +154,10 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
return $array;
}
/**
* Find a transaction group by its ID.
*
* @param int $groupId
*
* @return TransactionGroup|null
*/
public function find(int $groupId): ?TransactionGroup
{
return $this->user->transactionGroups()->find($groupId);
}
/**
* Return all attachments for all journals in the group.
*
* @param TransactionGroup $group
* @param TransactionGroup $group
*
* @return array
*/
@@ -173,7 +174,7 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
$result = [];
/** @var Attachment $attachment */
foreach ($set as $attachment) {
$journalId = (int) $attachment->attachable_id;
$journalId = (int)$attachment->attachable_id;
$result[$journalId] = $result[$journalId] ?? [];
$current = $attachment->toArray();
$current['file_exists'] = true;
@@ -185,10 +186,38 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
return $result;
}
/**
* @param User $user
*/
public function setUser(User $user): void
{
$this->user = $user;
}
/**
* Get the note text for a journal (by ID).
*
* @param int $journalId
*
* @return string|null
*/
public function getNoteText(int $journalId): ?string
{
/** @var Note|null $note */
$note = Note::where('noteable_id', $journalId)
->where('noteable_type', TransactionJournal::class)
->first();
if (null === $note) {
return null;
}
return $note->text;
}
/**
* Return all journal links for all journals in the group.
*
* @param TransactionGroup $group
* @param TransactionGroup $group
*
* @return array
*/
@@ -202,9 +231,9 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
$q->orWhereIn('destination_id', $journals);
}
)
->with(['source', 'destination', 'source.transactions'])
->leftJoin('link_types', 'link_types.id', '=', 'journal_links.link_type_id')
->get(['journal_links.*', 'link_types.inward', 'link_types.outward', 'link_types.editable']);
->with(['source', 'destination', 'source.transactions'])
->leftJoin('link_types', 'link_types.id', '=', 'journal_links.link_type_id')
->get(['journal_links.*', 'link_types.inward', 'link_types.outward', 'link_types.editable']);
/** @var TransactionJournalLink $entry */
foreach ($set as $entry) {
$journalId = in_array($entry->source_id, $journals, true) ? $entry->source_id : $entry->destination_id;
@@ -242,7 +271,7 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
}
/**
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @return string
*/
@@ -265,7 +294,7 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
}
/**
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @return string
*/
@@ -307,8 +336,8 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
/**
* Return object with all found meta field things as Carbon objects.
*
* @param int $journalId
* @param array $fields
* @param int $journalId
* @param array $fields
*
* @return NullArrayObject
* @throws Exception
@@ -316,10 +345,10 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
public function getMetaDateFields(int $journalId, array $fields): NullArrayObject
{
$query = DB::table('journal_meta')
->where('transaction_journal_id', $journalId)
->whereIn('name', $fields)
->whereNull('deleted_at')
->get(['name', 'data']);
->where('transaction_journal_id', $journalId)
->whereIn('name', $fields)
->whereNull('deleted_at')
->get(['name', 'data']);
$return = [];
foreach ($query as $row) {
@@ -332,18 +361,18 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
/**
* Return object with all found meta field things.
*
* @param int $journalId
* @param array $fields
* @param int $journalId
* @param array $fields
*
* @return NullArrayObject
*/
public function getMetaFields(int $journalId, array $fields): NullArrayObject
{
$query = DB::table('journal_meta')
->where('transaction_journal_id', $journalId)
->whereIn('name', $fields)
->whereNull('deleted_at')
->get(['name', 'data']);
->where('transaction_journal_id', $journalId)
->whereIn('name', $fields)
->whereNull('deleted_at')
->get(['name', 'data']);
$return = [];
foreach ($query as $row) {
@@ -353,34 +382,14 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
return new NullArrayObject($return);
}
/**
* Get the note text for a journal (by ID).
*
* @param int $journalId
*
* @return string|null
*/
public function getNoteText(int $journalId): ?string
{
/** @var Note|null $note */
$note = Note::where('noteable_id', $journalId)
->where('noteable_type', TransactionJournal::class)
->first();
if (null === $note) {
return null;
}
return $note->text;
}
/**
* Return all piggy bank events for all journals in the group.
*
* @param TransactionGroup $group
* @param TransactionGroup $group
*
* @return array
* @throws FireflyException
* @throws \JsonException
* @throws JsonException
*/
public function getPiggyEvents(TransactionGroup $group): array
{
@@ -388,8 +397,8 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
$journals = $group->transactionJournals->pluck('id')->toArray();
$currency = app('amount')->getDefaultCurrencyByUser($this->user);
$data = PiggyBankEvent::whereIn('transaction_journal_id', $journals)
->with('piggyBank', 'piggyBank.account')
->get(['piggy_bank_events.*']);
->with('piggyBank', 'piggyBank.account')
->get(['piggy_bank_events.*']);
/** @var PiggyBankEvent $row */
foreach ($data as $row) {
if (null === $row->piggyBank) {
@@ -397,8 +406,8 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
}
// get currency preference.
$currencyPreference = AccountMeta::where('account_id', $row->piggyBank->account_id)
->where('name', 'currency_id')
->first();
->where('name', 'currency_id')
->first();
if (null !== $currencyPreference) {
$currency = TransactionCurrency::where('id', $currencyPreference->data)->first();
}
@@ -406,7 +415,7 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
$currencyCode = app('preferences')->getForUser($this->user, 'currencyPreference', 'EUR')->data;
$currency = TransactionCurrency::where('code', $currencyCode)->first();
}
$journalId = (int) $row->transaction_journal_id;
$journalId = (int)$row->transaction_journal_id;
$return[$journalId] = $return[$journalId] ?? [];
$return[$journalId][] = [
@@ -433,31 +442,23 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
/**
* Get the tags for a journal (by ID).
*
* @param int $journalId
* @param int $journalId
*
* @return array
*/
public function getTags(int $journalId): array
{
$result = DB::table('tag_transaction_journal')
->leftJoin('tags', 'tag_transaction_journal.tag_id', '=', 'tags.id')
->where('tag_transaction_journal.transaction_journal_id', $journalId)
->orderBy('tags.tag', 'ASC')
->get(['tags.tag']);
->leftJoin('tags', 'tag_transaction_journal.tag_id', '=', 'tags.id')
->where('tag_transaction_journal.transaction_journal_id', $journalId)
->orderBy('tags.tag', 'ASC')
->get(['tags.tag']);
return $result->pluck('tag')->toArray();
}
/**
* @param User $user
*/
public function setUser(User $user): void
{
$this->user = $user;
}
/**
* @param array $data
* @param array $data
*
* @return TransactionGroup
* @throws DuplicateTransactionException
@@ -482,8 +483,8 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
}
/**
* @param TransactionGroup $transactionGroup
* @param array $data
* @param TransactionGroup $transactionGroup
* @param array $data
*
* @return TransactionGroup
*

View File

@@ -37,21 +37,21 @@ use Illuminate\Support\Collection;
interface TransactionGroupRepositoryInterface
{
/**
* @param int $journalId
* @param int $journalId
*
* @return int
*/
public function countAttachments(int $journalId): int;
/**
* @param TransactionGroup $group
* @param TransactionGroup $group
*/
public function destroy(TransactionGroup $group): void;
/**
* Return a group and expand all meta data etc.
*
* @param TransactionGroup $group
* @param TransactionGroup $group
*
* @return array
*/
@@ -60,7 +60,7 @@ interface TransactionGroupRepositoryInterface
/**
* Find a transaction group by its ID.
*
* @param int $groupId
* @param int $groupId
*
* @return TransactionGroup|null
*/
@@ -69,7 +69,7 @@ interface TransactionGroupRepositoryInterface
/**
* Return all attachments for all journals in the group.
*
* @param TransactionGroup $group
* @param TransactionGroup $group
*
* @return array
*/
@@ -78,7 +78,7 @@ interface TransactionGroupRepositoryInterface
/**
* Return all journal links for all journals in the group.
*
* @param TransactionGroup $group
* @param TransactionGroup $group
*
* @return array
*/
@@ -87,7 +87,7 @@ interface TransactionGroupRepositoryInterface
/**
* Get the location of a journal or NULL.
*
* @param int $journalId
* @param int $journalId
*
* @return Location|null
*/
@@ -96,8 +96,8 @@ interface TransactionGroupRepositoryInterface
/**
* Return object with all found meta field things as Carbon objects.
*
* @param int $journalId
* @param array $fields
* @param int $journalId
* @param array $fields
*
* @return NullArrayObject
*/
@@ -106,8 +106,8 @@ interface TransactionGroupRepositoryInterface
/**
* Return object with all found meta field things.
*
* @param int $journalId
* @param array $fields
* @param int $journalId
* @param array $fields
*
* @return NullArrayObject
*/
@@ -116,7 +116,7 @@ interface TransactionGroupRepositoryInterface
/**
* Get the note text for a journal (by ID).
*
* @param int $journalId
* @param int $journalId
*
* @return string|null
*/
@@ -125,7 +125,7 @@ interface TransactionGroupRepositoryInterface
/**
* Return all piggy bank events for all journals in the group.
*
* @param TransactionGroup $group
* @param TransactionGroup $group
*
* @return array
*/
@@ -134,7 +134,7 @@ interface TransactionGroupRepositoryInterface
/**
* Get the tags for a journal (by ID) as Tag objects.
*
* @param int $journalId
* @param int $journalId
*
* @return Collection
*/
@@ -143,7 +143,7 @@ interface TransactionGroupRepositoryInterface
/**
* Get the tags for a journal (by ID).
*
* @param int $journalId
* @param int $journalId
*
* @return array
*/
@@ -152,14 +152,14 @@ interface TransactionGroupRepositoryInterface
/**
* Set the user.
*
* @param User $user
* @param User $user
*/
public function setUser(User $user): void;
/**
* Create a new transaction group.
*
* @param array $data
* @param array $data
*
* @return TransactionGroup
* @throws DuplicateTransactionException
@@ -170,8 +170,8 @@ interface TransactionGroupRepositoryInterface
/**
* Update an existing transaction group.
*
* @param TransactionGroup $transactionGroup
* @param array $data
* @param TransactionGroup $transactionGroup
* @param array $data
*
* @return TransactionGroup
*/