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 PSR12 code cleanup

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -41,7 +41,7 @@ class JournalAPIRepository implements JournalAPIRepositoryInterface
/**
* Returns transaction by ID. Used to validate attachments.
*
* @param int $transactionId
* @param int $transactionId
*
* @return Transaction|null
*/
@@ -56,7 +56,7 @@ class JournalAPIRepository implements JournalAPIRepositoryInterface
/**
* Return all attachments for journal.
*
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @return Collection
*/
@@ -91,7 +91,7 @@ class JournalAPIRepository implements JournalAPIRepositoryInterface
/**
* Get all piggy bank events for a journal.
*
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @return Collection
*/
@@ -108,7 +108,7 @@ class JournalAPIRepository implements JournalAPIRepositoryInterface
}
/**
* @param User $user
* @param User $user
*/
public function setUser(User $user): void
{

10
app/Repositories/Journal/JournalAPIRepositoryInterface.php
View File

@@ -36,7 +36,7 @@ interface JournalAPIRepositoryInterface
/**
* Returns transaction by ID. Used to validate attachments.
*
* @param int $transactionId
* @param int $transactionId
*
* @return Transaction|null
*/
@@ -45,7 +45,7 @@ interface JournalAPIRepositoryInterface
/**
* Return all attachments for journal.
*
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @return Collection
*/
@@ -54,7 +54,7 @@ interface JournalAPIRepositoryInterface
/**
* Return all journal links for journal.
*
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @return Collection
*/
@@ -63,14 +63,14 @@ interface JournalAPIRepositoryInterface
/**
* Get all piggy bank events for a journal.
*
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @return Collection
*/
public function getPiggyBankEvents(TransactionJournal $journal): Collection;
/**
* @param User $user
* @param User $user
*/
public function setUser(User $user);
}

37
app/Repositories/Journal/JournalCLIRepository.php
View File

@@ -30,7 +30,6 @@ use FireflyIII\Models\TransactionJournal;
use FireflyIII\Support\CacheProperties;
use FireflyIII\User;
use Illuminate\Support\Collection;
use JsonException;
use stdClass;
/**
@@ -44,22 +43,22 @@ class JournalCLIRepository implements JournalCLIRepositoryInterface
/**
* Get all transaction journals with a specific type, regardless of user.
*
* @param array $types
* @param array $types
*
* @return Collection
*/
public function getAllJournals(array $types): Collection
{
return TransactionJournal::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.*']);
->whereIn('transaction_types.type', $types)
->with(['user', 'transactionType', 'transactionCurrency', 'transactions', 'transactions.account'])
->get(['transaction_journals.*']);
}
/**
* Return the ID of the budget linked to the journal (if any) or the transactions (if any).
*
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @return int
*/
@@ -80,7 +79,7 @@ class JournalCLIRepository implements JournalCLIRepositoryInterface
/**
* Return the ID of the category linked to the journal (if any) or to the transactions (if any).
*
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @return int
*/
@@ -111,8 +110,8 @@ class JournalCLIRepository implements JournalCLIRepositoryInterface
/**
* Return Carbon value of a meta field (or NULL).
*
* @param TransactionJournal $journal
* @param string $field
* @param TransactionJournal $journal
* @param string $field
*
* @return null|Carbon
*/
@@ -154,8 +153,8 @@ class JournalCLIRepository implements JournalCLIRepositoryInterface
/**
* Return value of a meta field (or NULL) as a string.
*
* @param TransactionJournal $journal
* @param string $field
* @param TransactionJournal $journal
* @param string $field
*
* @return null|string
*/
@@ -185,7 +184,7 @@ class JournalCLIRepository implements JournalCLIRepositoryInterface
}
// return when something else:
$return = (string) $value;
$return = (string)$value;
try {
$cache->store($return);
} catch (Exception $e) {
@@ -198,7 +197,7 @@ class JournalCLIRepository implements JournalCLIRepositoryInterface
/**
* Return text of a note attached to journal, or NULL
*
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @return string|null
*/
@@ -221,25 +220,25 @@ class JournalCLIRepository implements JournalCLIRepositoryInterface
public function getSplitJournals(): Collection
{
$query = TransactionJournal::leftJoin('transactions', 'transaction_journals.id', '=', 'transactions.transaction_journal_id')
->groupBy('transaction_journals.id');
->groupBy('transaction_journals.id');
$result = $query->get(['transaction_journals.id as id', DB::raw('count(transactions.id) as transaction_count')]);
$journalIds = [];
/** @var stdClass $row */
foreach ($result as $row) {
if ((int) $row->transaction_count > 2) {
$journalIds[] = (int) $row->id;
if ((int)$row->transaction_count > 2) {
$journalIds[] = (int)$row->id;
}
}
$journalIds = array_unique($journalIds);
return TransactionJournal::with(['transactions'])
->whereIn('id', $journalIds)->get();
->whereIn('id', $journalIds)->get();
}
/**
* Return all tags as strings in an array.
*
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @return array
*/
@@ -249,7 +248,7 @@ class JournalCLIRepository implements JournalCLIRepositoryInterface
}
/**
* @param User $user
* @param User $user
*/
public function setUser(User $user): void
{

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

@@ -36,7 +36,7 @@ interface JournalCLIRepositoryInterface
/**
* Get all transaction journals with a specific type, regardless of user.
*
* @param array $types
* @param array $types
*
* @return Collection
*/
@@ -45,7 +45,7 @@ interface JournalCLIRepositoryInterface
/**
* Return the ID of the budget linked to the journal (if any) or the transactions (if any).
*
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @return int
*/
@@ -54,7 +54,7 @@ interface JournalCLIRepositoryInterface
/**
* Return the ID of the category linked to the journal (if any) or to the transactions (if any).
*
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @return int
*/
@@ -70,8 +70,8 @@ interface JournalCLIRepositoryInterface
/**
* Return Carbon value of a meta field (or NULL).
*
* @param TransactionJournal $journal
* @param string $field
* @param TransactionJournal $journal
* @param string $field
*
* @return null|Carbon
*/
@@ -80,8 +80,8 @@ interface JournalCLIRepositoryInterface
/**
* Return value of a meta field (or NULL).
*
* @param TransactionJournal $journal
* @param string $field
* @param TransactionJournal $journal
* @param string $field
*
* @return null|string
*/
@@ -90,7 +90,7 @@ interface JournalCLIRepositoryInterface
/**
* Return text of a note attached to journal, or NULL
*
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @return string|null
*/
@@ -107,14 +107,14 @@ interface JournalCLIRepositoryInterface
/**
* Return all tags as strings in an array.
*
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @return array
*/
public function getTags(TransactionJournal $journal): array;
/**
* @param User $user
* @param User $user
*/
public function setUser(User $user);
}

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

@@ -1,4 +1,5 @@
<?php
/**
* JournalRepository.php
* Copyright (c) 2019 james@firefly-iii.org
@@ -37,7 +38,6 @@ use FireflyIII\Services\Internal\Update\JournalUpdateService;
use FireflyIII\Support\CacheProperties;
use FireflyIII\User;
use Illuminate\Support\Collection;
use JsonException;
/**
* Class JournalRepository.
@@ -48,7 +48,7 @@ class JournalRepository implements JournalRepositoryInterface
private $user;
/**
* @param TransactionGroup $transactionGroup
* @param TransactionGroup $transactionGroup
*
*/
public function destroyGroup(TransactionGroup $transactionGroup): void
@@ -59,7 +59,7 @@ class JournalRepository implements JournalRepositoryInterface
}
/**
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
*/
public function destroyJournal(TransactionJournal $journal): void
@@ -69,18 +69,6 @@ class JournalRepository implements JournalRepositoryInterface
$service->destroy($journal);
}
/**
* Find a specific journal.
*
* @param int $journalId
*
* @return TransactionJournal|null
*/
public function find(int $journalId): ?TransactionJournal
{
return $this->user->transactionJournals()->find($journalId);
}
/**
* @inheritDoc
*/
@@ -127,7 +115,7 @@ class JournalRepository implements JournalRepositoryInterface
/**
* Return total amount of journal. Is always positive.
*
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @return string
*/
@@ -142,7 +130,7 @@ class JournalRepository implements JournalRepositoryInterface
// saves on queries:
$amount = $journal->transactions()->where('amount', '>', 0)->get()->sum('amount');
$amount = (string) $amount;
$amount = (string)$amount;
$cache->store($amount);
return $amount;
@@ -164,7 +152,7 @@ class JournalRepository implements JournalRepositoryInterface
}
/**
* @param TransactionJournalLink $link
* @param TransactionJournalLink $link
*
* @return string
*/
@@ -182,8 +170,8 @@ class JournalRepository implements JournalRepositoryInterface
/**
* Return Carbon value of a meta field (or NULL).
*
* @param int $journalId
* @param string $field
* @param int $journalId
* @param string $field
*
* @return null|Carbon
*/
@@ -223,7 +211,7 @@ class JournalRepository implements JournalRepositoryInterface
}
/**
* @param int $journalId
* @param int $journalId
*/
public function reconcileById(int $journalId): void
{
@@ -232,11 +220,23 @@ class JournalRepository implements JournalRepositoryInterface
$journal?->transactions()->update(['reconciled' => true]);
}
/**
* Find a specific journal.
*
* @param int $journalId
*
* @return TransactionJournal|null
*/
public function find(int $journalId): ?TransactionJournal
{
return $this->user->transactionJournals()->find($journalId);
}
/**
* Search in journal descriptions.
*
* @param string $search
* @param int $limit
* @param string $search
* @param int $limit
*
* @return Collection
*/
@@ -252,7 +252,7 @@ class JournalRepository implements JournalRepositoryInterface
}
/**
* @param User $user
* @param User $user
*/
public function setUser(User $user): void
{
@@ -262,8 +262,8 @@ class JournalRepository implements JournalRepositoryInterface
/**
* Update budget for a journal.
*
* @param TransactionJournal $journal
* @param int $budgetId
* @param TransactionJournal $journal
* @param int $budgetId
*
* @return TransactionJournal
*/
@@ -287,8 +287,8 @@ class JournalRepository implements JournalRepositoryInterface
/**
* Update category for a journal.
*
* @param TransactionJournal $journal
* @param string $category
* @param TransactionJournal $journal
* @param string $category
*
* @return TransactionJournal
*/
@@ -311,8 +311,8 @@ class JournalRepository implements JournalRepositoryInterface
/**
* Update tag(s) for a journal.
*
* @param TransactionJournal $journal
* @param array $tags
* @param TransactionJournal $journal
* @param array $tags
*
* @return TransactionJournal
*/

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

@@ -1,4 +1,5 @@
<?php
/**
* JournalRepositoryInterface.php
* Copyright (c) 2019 james@firefly-iii.org
@@ -39,28 +40,28 @@ interface JournalRepositoryInterface
/**
* Deletes a transaction group.
*
* @param TransactionGroup $transactionGroup
* @param TransactionGroup $transactionGroup
*/
public function destroyGroup(TransactionGroup $transactionGroup): void;
/**
* Deletes a journal.
*
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*/
public function destroyJournal(TransactionJournal $journal): void;
/**
* Find a specific journal.
*
* @param int $journalId
* @param int $journalId
*
* @return TransactionJournal|null
*/
public function find(int $journalId): ?TransactionJournal;
/**
* @param array $types
* @param array $types
*
* @return Collection
*/
@@ -76,7 +77,7 @@ interface JournalRepositoryInterface
/**
* Returns the destination account of the journal.
*
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @return Account
* @throws FireflyException
@@ -86,7 +87,7 @@ interface JournalRepositoryInterface
/**
* Return total amount of journal. Is always positive.
*
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @return string
*/
@@ -98,7 +99,7 @@ interface JournalRepositoryInterface
public function getLast(): ?TransactionJournal;
/**
* @param TransactionJournalLink $link
* @param TransactionJournalLink $link
*
* @return string
*/
@@ -107,8 +108,8 @@ interface JournalRepositoryInterface
/**
* Return Carbon value of a meta field (or NULL).
*
* @param int $journalId
* @param string $field
* @param int $journalId
* @param string $field
*
* @return null|Carbon
*/
@@ -117,7 +118,7 @@ interface JournalRepositoryInterface
/**
* Returns the source account of the journal.
*
* @param TransactionJournal $journal
* @param TransactionJournal $journal
*
* @return Account
* @throws FireflyException
@@ -127,30 +128,30 @@ interface JournalRepositoryInterface
/**
* TODO Maybe to account repository? Do this wen reconcile is API only.
*
* @param int $journalId
* @param int $journalId
*/
public function reconcileById(int $journalId): void;
/**
* Search in journal descriptions.
*
* @param string $search
* @param int $limit
* @param string $search
* @param int $limit
*
* @return Collection
*/
public function searchJournalDescriptions(string $search, int $limit): Collection;
/**
* @param User $user
* @param User $user
*/
public function setUser(User $user);
/**
* Update budget for a journal.
*
* @param TransactionJournal $journal
* @param int $budgetId
* @param TransactionJournal $journal
* @param int $budgetId
*
* @return TransactionJournal
*/
@@ -159,8 +160,8 @@ interface JournalRepositoryInterface
/**
* Update category for a journal.
*
* @param TransactionJournal $journal
* @param string $category
* @param TransactionJournal $journal
* @param string $category
*
* @return TransactionJournal
*/
@@ -169,8 +170,8 @@ interface JournalRepositoryInterface
/**
* Update tag(s) for a journal.
*
* @param TransactionJournal $journal
* @param array $tags
* @param TransactionJournal $journal
* @param array $tags
*
* @return TransactionJournal
*/