From 4d0ff86bfaaeff87a718d639e63862087aea420e Mon Sep 17 00:00:00 2001
From: James Cole <james@firefly-iii.org>
Date: Sat, 31 Dec 2022 15:54:55 +0100
Subject: [PATCH] Various code cleanup

---
 .ci/phpstan.neon                                   | 4 +++-
 app/Models/InvitedUser.php                         | 2 +-
 app/Repositories/Journal/JournalAPIRepository.php  | 4 +++-
 app/Repositories/PiggyBank/PiggyBankRepository.php | 9 +++++----
 4 files changed, 12 insertions(+), 7 deletions(-)

diff --git a/.ci/phpstan.neon b/.ci/phpstan.neon
index 71862c7c85..f846b62d11 100644
--- a/.ci/phpstan.neon
+++ b/.ci/phpstan.neon
@@ -11,6 +11,7 @@ parameters:
     - '#has a nullable return type declaration#'
     - '#with a nullable type declaration#'
     - '#with null as default value#'
+    - '#is not covariant with PHPDoc type array#'
     -
         message: '#but containers should not be injected#'
         paths:
@@ -65,4 +66,5 @@ parameters:
     - ../bootstrap/app.php
 
   # The level 8 is the highest level. original was 5
-  level: 2
+  level: 4
+
diff --git a/app/Models/InvitedUser.php b/app/Models/InvitedUser.php
index 6525b735f4..366e93ea2f 100644
--- a/app/Models/InvitedUser.php
+++ b/app/Models/InvitedUser.php
@@ -29,7 +29,7 @@ use FireflyIII\User;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
-use Illuminate\Support\Carbon;
+use Carbon\Carbon;
 
 /**
  * Class InvitedUser
diff --git a/app/Repositories/Journal/JournalAPIRepository.php b/app/Repositories/Journal/JournalAPIRepository.php
index 16553eed5a..03547080cc 100644
--- a/app/Repositories/Journal/JournalAPIRepository.php
+++ b/app/Repositories/Journal/JournalAPIRepository.php
@@ -54,6 +54,8 @@ class JournalAPIRepository implements JournalAPIRepositoryInterface
     }
 
     /**
+     * TODO pretty sure method duplicated.
+     *
      * Return all attachments for journal.
      *
      * @param  TransactionJournal  $journal
@@ -71,7 +73,7 @@ class JournalAPIRepository implements JournalAPIRepositoryInterface
             static function (Attachment $attachment) use ($disk) {
                 $notes                   = $attachment->notes()->first();
                 $attachment->file_exists = $disk->exists($attachment->fileName());
-                $attachment->notes       = $notes ? $notes->text : '';
+                $attachment->notes       = $notes ? $notes->text : ''; // TODO should not set notes like this.
 
                 return $attachment;
             }
diff --git a/app/Repositories/PiggyBank/PiggyBankRepository.php b/app/Repositories/PiggyBank/PiggyBankRepository.php
index 0ae61a1de1..544ac251ac 100644
--- a/app/Repositories/PiggyBank/PiggyBankRepository.php
+++ b/app/Repositories/PiggyBank/PiggyBankRepository.php
@@ -95,7 +95,8 @@ class PiggyBankRepository implements PiggyBankRepositoryInterface
      */
     public function find(int $piggyBankId): ?PiggyBank
     {
-        return $this->user->piggyBanks()->find($piggyBankId);
+        // phpstan doesn't get the Model.
+        return $this->user->piggyBanks()->find($piggyBankId); // @phpstan-ignore-line
     }
 
     /**
@@ -124,7 +125,7 @@ class PiggyBankRepository implements PiggyBankRepositoryInterface
             static function (Attachment $attachment) use ($disk) {
                 $notes                   = $attachment->notes()->first();
                 $attachment->file_exists = $disk->exists($attachment->fileName());
-                $attachment->notes       = $notes ? $notes->text : '';
+                $attachment->notes       = $notes ? $notes->text : ''; // TODO setting the text to the 'notes' field doesn't work.
 
                 return $attachment;
             }
@@ -331,11 +332,11 @@ class PiggyBankRepository implements PiggyBankRepositoryInterface
      */
     public function getPiggyBanks(): Collection
     {
-        return $this->user
+        return $this->user  // @phpstan-ignore-line (phpstan does not recognize objectGroups)
             ->piggyBanks()
             ->with(
                 ['account',
-                 'objectGroups']) // @phpstan-ignore-line (phpstan does not recognize objectGroups)
+                 'objectGroups'])
             ->orderBy('order', 'ASC')->get();
     }