Code cleanup.

2025-10-12 15:35:15 +00:00 · 2023-12-20 19:35:52 +01:00
parent c4f6366642
commit 64ec0cf62e
997 changed files with 12908 additions and 28136 deletions
--- a/app/Repositories/Recurring/RecurringRepository.php
+++ b/app/Repositories/Recurring/RecurringRepository.php
@@ -47,7 +47,6 @@ use Illuminate\Contracts\Auth\Authenticatable;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Pagination\LengthAwarePaginator;
 use Illuminate\Support\Collection;
-use JsonException;

 /**
 * Class RecurringRepository
@@ -61,17 +60,14 @@ class RecurringRepository implements RecurringRepositoryInterface

    private User $user;

-    /**
-     * @inheritDoc
-     */
    public function createdPreviously(Recurrence $recurrence, Carbon $date): bool
    {
        // if not, loop set and try to read the recurrence_date. If it matches start or end, return it as well.
        $set
            = TransactionJournalMeta::where(static function (Builder $q1) use ($recurrence) {
-            $q1->where('name', 'recurrence_id');
-            $q1->where('data', json_encode((string)$recurrence->id));
-        })->get(['journal_meta.transaction_journal_id']);
+                $q1->where('name', 'recurrence_id');
+                $q1->where('data', json_encode((string)$recurrence->id));
+            })->get(['journal_meta.transaction_journal_id']);

        // there are X journals made for this recurrence. Any of them meant for today?
        foreach ($set as $journalMeta) {
@@ -81,35 +77,35 @@ class RecurringRepository implements RecurringRepositoryInterface
                $q2->where('name', 'recurrence_date');
                $q2->where('data', json_encode($string));
            })
-                                           ->where('transaction_journal_id', $journalMeta->transaction_journal_id)
-                                           ->count();
+                ->where('transaction_journal_id', $journalMeta->transaction_journal_id)
+                ->count()
+            ;
            if ($count > 0) {
                app('log')->debug(sprintf('Looks like journal #%d was already created', $journalMeta->transaction_journal_id));
+
                return true;
            }
        }
+
        return false;
    }

    /**
     * Returns all of the user's recurring transactions.
-     *
-     * @return Collection
     */
    public function get(): Collection
    {
        return $this->user->recurrences()
-                          ->with(['TransactionCurrency', 'TransactionType', 'RecurrenceRepetitions', 'RecurrenceTransactions'])
-                          ->orderBy('active', 'DESC')
-                          ->orderBy('transaction_type_id', 'ASC')
-                          ->orderBy('title', 'ASC')
-                          ->get();
+            ->with(['TransactionCurrency', 'TransactionType', 'RecurrenceRepetitions', 'RecurrenceTransactions'])
+            ->orderBy('active', 'DESC')
+            ->orderBy('transaction_type_id', 'ASC')
+            ->orderBy('title', 'ASC')
+            ->get()
+        ;
    }

    /**
     * Destroy a recurring transaction.
-     *
-     * @param Recurrence $recurrence
     */
    public function destroy(Recurrence $recurrence): void
    {
@@ -118,9 +114,6 @@ class RecurringRepository implements RecurringRepositoryInterface
        $service->destroy($recurrence);
    }

-    /**
-     * @inheritDoc
-     */
    public function destroyAll(): void
    {
        $this->user->recurrences()->delete();
@@ -128,24 +121,21 @@ class RecurringRepository implements RecurringRepositoryInterface

    /**
     * Get ALL recurring transactions.
-     *
-     * @return Collection
     */
    public function getAll(): Collection
    {
        // grab ALL recurring transactions:
        return Recurrence::with(['TransactionCurrency', 'TransactionType', 'RecurrenceRepetitions', 'RecurrenceTransactions'])
-                         ->orderBy('active', 'DESC')
-                         ->orderBy('title', 'ASC')
-                         ->get();
+            ->orderBy('active', 'DESC')
+            ->orderBy('title', 'ASC')
+            ->get()
+        ;
    }

-    /**
-     * @inheritDoc
-     */
    public function getBillId(RecurrenceTransaction $recTransaction): ?int
    {
        $return = null;
+
        /** @var RecurrenceTransactionMeta $meta */
        foreach ($recTransaction->recurrenceTransactionMeta as $meta) {
            if ('bill_id' === $meta->name) {
@@ -158,14 +148,11 @@ class RecurringRepository implements RecurringRepositoryInterface

    /**
     * Get the budget ID from a recurring transaction transaction.
-     *
-     * @param RecurrenceTransaction $recTransaction
-     *
-     * @return null|int
     */
    public function getBudget(RecurrenceTransaction $recTransaction): ?int
    {
        $return = 0;
+
        /** @var RecurrenceTransactionMeta $meta */
        foreach ($recTransaction->recurrenceTransactionMeta as $meta) {
            if ('budget_id' === $meta->name) {
@@ -178,14 +165,11 @@ class RecurringRepository implements RecurringRepositoryInterface

    /**
     * Get the category from a recurring transaction transaction.
-     *
-     * @param RecurrenceTransaction $recTransaction
-     *
-     * @return null|int
     */
    public function getCategoryId(RecurrenceTransaction $recTransaction): ?int
    {
        $return = '';
+
        /** @var RecurrenceTransactionMeta $meta */
        foreach ($recTransaction->recurrenceTransactionMeta as $meta) {
            if ('category_id' === $meta->name) {
@@ -198,14 +182,11 @@ class RecurringRepository implements RecurringRepositoryInterface

    /**
     * Get the category from a recurring transaction transaction.
-     *
-     * @param RecurrenceTransaction $recTransaction
-     *
-     * @return null|string
     */
    public function getCategoryName(RecurrenceTransaction $recTransaction): ?string
    {
        $return = '';
+
        /** @var RecurrenceTransactionMeta $meta */
        foreach ($recTransaction->recurrenceTransactionMeta as $meta) {
            if ('category_name' === $meta->name) {
@@ -218,67 +199,53 @@ class RecurringRepository implements RecurringRepositoryInterface

    /**
     * Returns the journals created for this recurrence, possibly limited by time.
-     *
-     * @param Recurrence  $recurrence
-     * @param Carbon|null $start
-     * @param Carbon|null $end
-     *
-     * @return int
     */
    public function getJournalCount(Recurrence $recurrence, Carbon $start = null, Carbon $end = null): int
    {
        $query = TransactionJournal::leftJoin('journal_meta', 'journal_meta.transaction_journal_id', '=', 'transaction_journals.id')
-                                   ->where('transaction_journals.user_id', $recurrence->user_id)
-                                   ->whereNull('transaction_journals.deleted_at')
-                                   ->where('journal_meta.name', 'recurrence_id')
-                                   ->where('journal_meta.data', '"' . $recurrence->id . '"');
+            ->where('transaction_journals.user_id', $recurrence->user_id)
+            ->whereNull('transaction_journals.deleted_at')
+            ->where('journal_meta.name', 'recurrence_id')
+            ->where('journal_meta.data', '"'.$recurrence->id.'"')
+        ;
        if (null !== $start) {
            $query->where('transaction_journals.date', '>=', $start->format('Y-m-d 00:00:00'));
        }
        if (null !== $end) {
            $query->where('transaction_journals.date', '<=', $end->format('Y-m-d 00:00:00'));
        }
+
        return $query->count('transaction_journals.id');
    }

    /**
     * Get journal ID's for journals created by this recurring transaction.
-     *
-     * @param Recurrence $recurrence
-     *
-     * @return array
     */
    public function getJournalIds(Recurrence $recurrence): array
    {
        return TransactionJournalMeta::leftJoin('transaction_journals', 'transaction_journals.id', '=', 'journal_meta.transaction_journal_id')
-                                     ->where('transaction_journals.user_id', $this->user->id)
-                                     ->where('journal_meta.name', '=', 'recurrence_id')
-                                     ->where('journal_meta.data', '=', json_encode((string)$recurrence->id))
-                                     ->get(['journal_meta.transaction_journal_id'])->pluck('transaction_journal_id')->toArray();
+            ->where('transaction_journals.user_id', $this->user->id)
+            ->where('journal_meta.name', '=', 'recurrence_id')
+            ->where('journal_meta.data', '=', json_encode((string)$recurrence->id))
+            ->get(['journal_meta.transaction_journal_id'])->pluck('transaction_journal_id')->toArray()
+        ;
    }

    /**
     * Get the notes.
-     *
-     * @param Recurrence $recurrence
-     *
-     * @return string
     */
    public function getNoteText(Recurrence $recurrence): string
    {
-        /** @var Note|null $note */
+        /** @var null|Note $note */
        $note = $recurrence->notes()->first();
+
        return (string)$note?->text;
    }

-    /**
-     * @param RecurrenceTransaction $transaction
-     *
-     * @return int|null
-     */
    public function getPiggyBank(RecurrenceTransaction $transaction): ?int
    {
        $meta = $transaction->recurrenceTransactionMeta;
+
        /** @var RecurrenceTransactionMeta $metaEntry */
        foreach ($meta as $metaEntry) {
            if ('piggy_bank_id' === $metaEntry->name) {
@@ -292,14 +259,12 @@ class RecurringRepository implements RecurringRepositoryInterface
    /**
     * Get the tags from the recurring transaction.
     *
-     * @param RecurrenceTransaction $transaction
-     *
-     * @return array
-     * @throws JsonException
+     * @throws \JsonException
     */
    public function getTags(RecurrenceTransaction $transaction): array
    {
        $tags = [];
+
        /** @var RecurrenceMeta $meta */
        foreach ($transaction->recurrenceTransactionMeta as $meta) {
            if ('tags' === $meta->name && '' !== $meta->value) {
@@ -310,59 +275,48 @@ class RecurringRepository implements RecurringRepositoryInterface
        return $tags;
    }

-    /**
-     * @param Recurrence $recurrence
-     * @param int        $page
-     * @param int        $pageSize
-     *
-     * @return LengthAwarePaginator
-     */
    public function getTransactionPaginator(Recurrence $recurrence, int $page, int $pageSize): LengthAwarePaginator
    {
        $journalMeta = TransactionJournalMeta::leftJoin('transaction_journals', 'transaction_journals.id', '=', 'journal_meta.transaction_journal_id')
-                                             ->whereNull('transaction_journals.deleted_at')
-                                             ->where('transaction_journals.user_id', $this->user->id)
-                                             ->where('name', 'recurrence_id')
-                                             ->where('data', json_encode((string)$recurrence->id))
-                                             ->get()->pluck('transaction_journal_id')->toArray();
+            ->whereNull('transaction_journals.deleted_at')
+            ->where('transaction_journals.user_id', $this->user->id)
+            ->where('name', 'recurrence_id')
+            ->where('data', json_encode((string)$recurrence->id))
+            ->get()->pluck('transaction_journal_id')->toArray()
+        ;
        $search      = [];
        foreach ($journalMeta as $journalId) {
            $search[] = (int)$journalId;
        }
+
        /** @var GroupCollectorInterface $collector */
        $collector = app(GroupCollectorInterface::class);

        $collector->setUser($recurrence->user);
        $collector->withCategoryInformation()->withBudgetInformation()->setLimit($pageSize)->setPage($page)
-                  ->withAccountInformation();
+            ->withAccountInformation()
+        ;
        $collector->setJournalIds($search);

        return $collector->getPaginatedGroups();
    }

-    /**
-     * @param User|Authenticatable|null $user
-     */
-    public function setUser(User | Authenticatable | null $user): void
+    public function setUser(null|Authenticatable|User $user): void
    {
        if ($user instanceof User) {
            $this->user = $user;
        }
    }

-    /**
-     * @param Recurrence $recurrence
-     *
-     * @return Collection
-     */
    public function getTransactions(Recurrence $recurrence): Collection
    {
        $journalMeta = TransactionJournalMeta::leftJoin('transaction_journals', 'transaction_journals.id', '=', 'journal_meta.transaction_journal_id')
-                                             ->whereNull('transaction_journals.deleted_at')
-                                             ->where('transaction_journals.user_id', $this->user->id)
-                                             ->where('name', 'recurrence_id')
-                                             ->where('data', json_encode((string)$recurrence->id))
-                                             ->get()->pluck('transaction_journal_id')->toArray();
+            ->whereNull('transaction_journals.deleted_at')
+            ->where('transaction_journals.user_id', $this->user->id)
+            ->where('name', 'recurrence_id')
+            ->where('data', json_encode((string)$recurrence->id))
+            ->get()->pluck('transaction_journal_id')->toArray()
+        ;
        $search      = [];

        foreach ($journalMeta as $journalId) {
@@ -385,13 +339,6 @@ class RecurringRepository implements RecurringRepositoryInterface

    /**
     * Calculate the next X iterations starting on the date given in $date.
-     *
-     * @param RecurrenceRepetition $repetition
-     * @param Carbon               $date
-     * @param int                  $count
-     *
-     * @return array
-     *
     */
    public function getXOccurrences(RecurrenceRepetition $repetition, Carbon $date, int $count): array
    {
@@ -422,13 +369,6 @@ class RecurringRepository implements RecurringRepositoryInterface
     * Returns an array of Carbon objects.
     *
     * Only returns them of they are after $afterDate
-     *
-     * @param RecurrenceRepetition $repetition
-     * @param Carbon               $date
-     * @param Carbon               $afterDate
-     * @param int                  $count
-     *
-     * @return array
     */
    public function getXOccurrencesSince(RecurrenceRepetition $repetition, Carbon $date, Carbon $afterDate, int $count): array
    {
@@ -460,38 +400,15 @@ class RecurringRepository implements RecurringRepositoryInterface
        return $this->filterMaxDate($repeatUntil, $occurrences);
    }

-    /**
-     * @param Carbon|null $max
-     * @param array       $occurrences
-     *
-     * @return array
-     */
-    private function filterMaxDate(?Carbon $max, array $occurrences): array
-    {
-        if (null === $max) {
-            return $occurrences;
-        }
-        $filtered = [];
-        foreach ($occurrences as $date) {
-            if ($date->lte($max)) {
-                $filtered[] = $date;
-            }
-        }
-
-        return $filtered;
-    }
-
    /**
     * Parse the repetition in a string that is user readable.
     *
-     * @param RecurrenceRepetition $repetition
-     *
-     * @return string
     * @throws FireflyException
     */
    public function repetitionDescription(RecurrenceRepetition $repetition): string
    {
        app('log')->debug('Now in repetitionDescription()');
+
        /** @var Preference $pref */
        $pref     = app('preferences')->getForUser($this->user, 'language', config('firefly.default_language', 'en_US'));
        $language = $pref->data;
@@ -533,7 +450,6 @@ class RecurringRepository implements RecurringRepositoryInterface
            return (string)trans('firefly.recurring_ndom', ['weekday' => $dayOfWeek, 'dayOfMonth' => $parts[0]], $language);
        }
        if ('yearly' === $repetition->repetition_type) {
-            //
            $today   = today(config('app.timezone'))->endOfYear();
            $repDate = Carbon::createFromFormat('Y-m-d', $repetition->repetition_moment);
            if (false === $repDate) {
@@ -549,9 +465,6 @@ class RecurringRepository implements RecurringRepositoryInterface
        return '';
    }

-    /**
-     * @inheritDoc
-     */
    public function searchRecurrence(string $query, int $limit): Collection
    {
        $search = $this->user->recurrences();
@@ -559,29 +472,25 @@ class RecurringRepository implements RecurringRepositoryInterface
            $search->where('recurrences.title', 'LIKE', sprintf('%%%s%%', $query));
        }
        $search
-            ->orderBy('recurrences.title', 'ASC');
+            ->orderBy('recurrences.title', 'ASC')
+        ;

        return $search->take($limit)->get(['id', 'title', 'description']);
    }

    /**
-     * @param array $data
-     *
-     * @return Recurrence
     * @throws FireflyException
-     * @throws JsonException
+     * @throws \JsonException
     */
    public function store(array $data): Recurrence
    {
        /** @var RecurrenceFactory $factory */
        $factory = app(RecurrenceFactory::class);
        $factory->setUser($this->user);
+
        return $factory->create($data);
    }

-    /**
-     * @inheritDoc
-     */
    public function totalTransactions(Recurrence $recurrence, RecurrenceRepetition $repetition): int
    {
        // if repeat = null just return 0.
@@ -605,13 +514,6 @@ class RecurringRepository implements RecurringRepositoryInterface

    /**
     * Generate events in the date range.
-     *
-     * @param RecurrenceRepetition $repetition
-     * @param Carbon               $start
-     * @param Carbon               $end
-     *
-     * @return array
-     *
     */
    public function getOccurrencesInRange(RecurrenceRepetition $repetition, Carbon $start, Carbon $end): array
    {
@@ -645,10 +547,6 @@ class RecurringRepository implements RecurringRepositoryInterface
    /**
     * Update a recurring transaction.
     *
-     * @param Recurrence $recurrence
-     * @param array      $data
-     *
-     * @return Recurrence
     * @throws FireflyException
     */
    public function update(Recurrence $recurrence, array $data): Recurrence
@@ -658,4 +556,19 @@ class RecurringRepository implements RecurringRepositoryInterface

        return $service->update($recurrence, $data);
    }
+
+    private function filterMaxDate(?Carbon $max, array $occurrences): array
+    {
+        if (null === $max) {
+            return $occurrences;
+        }
+        $filtered = [];
+        foreach ($occurrences as $date) {
+            if ($date->lte($max)) {
+                $filtered[] = $date;
+            }
+        }
+
+        return $filtered;
+    }
 }
--- a/app/Repositories/Recurring/RecurringRepositoryInterface.php
+++ b/app/Repositories/Recurring/RecurringRepositoryInterface.php
@@ -35,22 +35,13 @@ use Illuminate\Support\Collection;

 /**
 * Interface RecurringRepositoryInterface
- *
 */
 interface RecurringRepositoryInterface
 {
-    /**
-     * @param Recurrence $recurrence
-     * @param Carbon     $date
-     *
-     * @return bool
-     */
    public function createdPreviously(Recurrence $recurrence, Carbon $date): bool;

    /**
     * Destroy a recurring transaction.
-     *
-     * @param Recurrence $recurrence
     */
    public function destroy(Recurrence $recurrence): void;

@@ -61,135 +52,69 @@ interface RecurringRepositoryInterface

    /**
     * Returns all of the user's recurring transactions.
-     *
-     * @return Collection
     */
    public function get(): Collection;

    /**
     * Get ALL recurring transactions.
-     *
-     * @return Collection
     */
    public function getAll(): Collection;

    /**
     * Get the category from a recurring transaction transaction.
-     *
-     * @param RecurrenceTransaction $recTransaction
-     *
-     * @return null|int
     */
    public function getBillId(RecurrenceTransaction $recTransaction): ?int;

    /**
     * Get the budget ID from a recurring transaction transaction.
-     *
-     * @param RecurrenceTransaction $recTransaction
-     *
-     * @return null|int
     */
    public function getBudget(RecurrenceTransaction $recTransaction): ?int;

    /**
     * Get the category from a recurring transaction transaction.
-     *
-     * @param RecurrenceTransaction $recTransaction
-     *
-     * @return null|int
     */
    public function getCategoryId(RecurrenceTransaction $recTransaction): ?int;

    /**
     * Get the category from a recurring transaction transaction.
-     *
-     * @param RecurrenceTransaction $recTransaction
-     *
-     * @return null|string
     */
    public function getCategoryName(RecurrenceTransaction $recTransaction): ?string;

    /**
     * Returns the count of journals created for this recurrence, possibly limited by time.
-     *
-     * @param Recurrence  $recurrence
-     * @param Carbon|null $start
-     * @param Carbon|null $end
-     *
-     * @return int
     */
    public function getJournalCount(Recurrence $recurrence, Carbon $start = null, Carbon $end = null): int;

    /**
     * Get journal ID's for journals created by this recurring transaction.
-     *
-     * @param Recurrence $recurrence
-     *
-     * @return array
     */
    public function getJournalIds(Recurrence $recurrence): array;

    /**
     * Get the notes.
-     *
-     * @param Recurrence $recurrence
-     *
-     * @return string
     */
    public function getNoteText(Recurrence $recurrence): string;

    /**
     * Generate events in the date range.
-     *
-     * @param RecurrenceRepetition $repetition
-     * @param Carbon               $start
-     * @param Carbon               $end
-     *
-     * @return array
     */
    public function getOccurrencesInRange(RecurrenceRepetition $repetition, Carbon $start, Carbon $end): array;

-    /**
-     * @param RecurrenceTransaction $transaction
-     *
-     * @return int|null
-     */
    public function getPiggyBank(RecurrenceTransaction $transaction): ?int;

    /**
     * Get the tags from the recurring transaction.
-     *
-     * @param RecurrenceTransaction $transaction
-     *
-     * @return array
     */
    public function getTags(RecurrenceTransaction $transaction): array;

-    /**
-     * @param Recurrence $recurrence
-     * @param int        $page
-     * @param int        $pageSize
-     *
-     * @return LengthAwarePaginator
-     */
    public function getTransactionPaginator(Recurrence $recurrence, int $page, int $pageSize): LengthAwarePaginator;

-    /**
-     * @param Recurrence $recurrence
-     *
-     * @return Collection
-     */
    public function getTransactions(Recurrence $recurrence): Collection;

    /**
     * Calculate the next X iterations starting on the date given in $date.
     * Returns an array of Carbon objects.
     *
-     * @param RecurrenceRepetition $repetition
-     * @param Carbon               $date
-     * @param int                  $count
-     *
-     * @return array
     * @throws FireflyException
     */
    public function getXOccurrences(RecurrenceRepetition $repetition, Carbon $date, int $count): array;
@@ -200,65 +125,33 @@ interface RecurringRepositoryInterface
     *
     * Only returns them of they are after $afterDate
     *
-     * @param RecurrenceRepetition $repetition
-     * @param Carbon               $date
-     * @param Carbon               $afterDate
-     * @param int                  $count
-     *
-     * @return array
     * @throws FireflyException
     */
    public function getXOccurrencesSince(RecurrenceRepetition $repetition, Carbon $date, Carbon $afterDate, int $count): array;

    /**
     * Parse the repetition in a string that is user readable.
-     *
-     * @param RecurrenceRepetition $repetition
-     *
-     * @return string
     */
    public function repetitionDescription(RecurrenceRepetition $repetition): string;

-    /**
-     * @param string $query
-     * @param int    $limit
-     *
-     * @return Collection
-     */
    public function searchRecurrence(string $query, int $limit): Collection;

-    /**
-     * @param User|Authenticatable|null $user
-     */
-    public function setUser(User | Authenticatable | null $user): void;
+    public function setUser(null|Authenticatable|User $user): void;

    /**
     * Store a new recurring transaction.
     *
-     * @param array $data
-     *
-     * @return Recurrence
     * @throws FireflyException
     */
    public function store(array $data): Recurrence;

    /**
     * Calculate how many transactions are to be expected from this recurrence.
-     *
-     * @param Recurrence           $recurrence
-     * @param RecurrenceRepetition $repetition
-     *
-     * @return int
     */
    public function totalTransactions(Recurrence $recurrence, RecurrenceRepetition $repetition): int;

    /**
     * Update a recurring transaction.
-     *
-     * @param Recurrence $recurrence
-     * @param array      $data
-     *
-     * @return Recurrence
     */
    public function update(Recurrence $recurrence, array $data): Recurrence;
 }