Code cleanup.

app/Repositories/PiggyBank/ModifiesPiggyBanks.php

@@ -24,9 +24,7 @@ declare(strict_types=1);
 
 namespace FireflyIII\Repositories\PiggyBank;
 
-use Exception;
 use FireflyIII\Events\Model\PiggyBank\ChangedAmount;
-use FireflyIII\Events\Model\PiggyBank\ChangedPiggyBankAmount;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Note;
 use FireflyIII\Models\PiggyBank;
@@ -34,7 +32,6 @@ use FireflyIII\Models\PiggyBankRepetition;
 use FireflyIII\Models\TransactionJournal;
 use FireflyIII\Repositories\ObjectGroup\CreatesObjectGroups;
 use Illuminate\Database\QueryException;
-use JsonException;
 
 /**
  * Trait ModifiesPiggyBanks
@@ -43,13 +40,6 @@ trait ModifiesPiggyBanks
 {
     use CreatesObjectGroups;
 
-    /**
-     * @param PiggyBankRepetition $repetition
-     * @param string              $amount
-     * @param TransactionJournal  $journal
-     *
-     * @return void
-     */
     public function addAmountToRepetition(PiggyBankRepetition $repetition, string $amount, TransactionJournal $journal): void
     {
         app('log')->debug(sprintf('addAmountToRepetition: %s', $amount));
@@ -63,13 +53,6 @@ trait ModifiesPiggyBanks
         }
     }
 
-    /**
-     * @param PiggyBank               $piggyBank
-     * @param string                  $amount
-     * @param TransactionJournal|null $journal
-     *
-     * @return bool
-     */
     public function removeAmount(PiggyBank $piggyBank, string $amount, ?TransactionJournal $journal = null): bool
     {
         $repetition = $this->getRepetition($piggyBank);
@@ -85,13 +68,6 @@ trait ModifiesPiggyBanks
         return true;
     }
 
-    /**
-     * @param PiggyBank               $piggyBank
-     * @param string                  $amount
-     * @param TransactionJournal|null $journal
-     *
-     * @return bool
-     */
     public function addAmount(PiggyBank $piggyBank, string $amount, ?TransactionJournal $journal = null): bool
     {
         $repetition = $this->getRepetition($piggyBank);
@@ -109,11 +85,7 @@ trait ModifiesPiggyBanks
     }
 
     /**
-     * @param PiggyBank $piggyBank
-     * @param string    $amount
-     *
-     * @return bool
-     * @throws JsonException
+     * @throws \JsonException
      */
     public function canAddAmount(PiggyBank $piggyBank, string $amount): bool
     {
@@ -139,12 +111,6 @@ trait ModifiesPiggyBanks
         return $result;
     }
 
-    /**
-     * @param PiggyBank $piggyBank
-     * @param string    $amount
-     *
-     * @return bool
-     */
     public function canRemoveAmount(PiggyBank $piggyBank, string $amount): bool
     {
         $repetition = $this->getRepetition($piggyBank);
@@ -157,10 +123,7 @@ trait ModifiesPiggyBanks
     }
 
     /**
-     * @param PiggyBank $piggyBank
-     *
-     * @return bool
-     * @throws Exception
+     * @throws \Exception
      */
     public function destroy(PiggyBank $piggyBank): bool
     {
@@ -170,9 +133,6 @@ trait ModifiesPiggyBanks
         return true;
     }
 
-    /**
-     * @inheritDoc
-     */
     public function removeObjectGroup(PiggyBank $piggyBank): PiggyBank
     {
         $piggyBank->objectGroups()->sync([]);
@@ -180,12 +140,6 @@ trait ModifiesPiggyBanks
         return $piggyBank;
     }
 
-    /**
-     * @param PiggyBank $piggyBank
-     * @param string    $amount
-     *
-     * @return PiggyBank
-     */
     public function setCurrentAmount(PiggyBank $piggyBank, string $amount): PiggyBank
     {
         $repetition = $this->getRepetition($piggyBank);
@@ -212,9 +166,6 @@ trait ModifiesPiggyBanks
         return $piggyBank;
     }
 
-    /**
-     * @inheritDoc
-     */
     public function setObjectGroup(PiggyBank $piggyBank, string $objectGroupTitle): PiggyBank
     {
         $objectGroup = $this->findOrCreateObjectGroup($objectGroupTitle);
@@ -226,9 +177,6 @@ trait ModifiesPiggyBanks
     }
 
     /**
-     * @param array $data
-     *
-     * @return PiggyBank
      * @throws FireflyException
      */
     public function store(array $data): PiggyBank
@@ -252,6 +200,7 @@ trait ModifiesPiggyBanks
             $piggyBank = PiggyBank::create($piggyData);
         } catch (QueryException $e) {
             app('log')->error(sprintf('Could not store piggy bank: %s', $e->getMessage()), $piggyData);
+
             throw new FireflyException('400005: Could not store new piggy bank.', 0, $e);
         }
 
@@ -302,21 +251,19 @@ trait ModifiesPiggyBanks
                 $piggyBank->order = $current;
                 $piggyBank->save();
             }
-            $current++;
+            ++$current;
         }
     }
 
-    /**
-     * @inheritDoc
-     */
     public function setOrder(PiggyBank $piggyBank, int $newOrder): bool
     {
         $oldOrder = $piggyBank->order;
-        //app('log')->debug(sprintf('Will move piggy bank #%d ("%s") from %d to %d', $piggyBank->id, $piggyBank->name, $oldOrder, $newOrder));
+        // app('log')->debug(sprintf('Will move piggy bank #%d ("%s") from %d to %d', $piggyBank->id, $piggyBank->name, $oldOrder, $newOrder));
         if ($newOrder > $oldOrder) {
             $this->user->piggyBanks()->where('piggy_banks.order', '<=', $newOrder)->where('piggy_banks.order', '>', $oldOrder)
-                       ->where('piggy_banks.id', '!=', $piggyBank->id)
-                       ->decrement('piggy_banks.order');
+                ->where('piggy_banks.id', '!=', $piggyBank->id)
+                ->decrement('piggy_banks.order')
+            ;
             $piggyBank->order = $newOrder;
             app('log')->debug(sprintf('[1] Order of piggy #%d ("%s") from %d to %d', $piggyBank->id, $piggyBank->name, $oldOrder, $newOrder));
             $piggyBank->save();
@@ -325,8 +272,9 @@ trait ModifiesPiggyBanks
         }
 
         $this->user->piggyBanks()->where('piggy_banks.order', '>=', $newOrder)->where('piggy_banks.order', '<', $oldOrder)
-                   ->where('piggy_banks.id', '!=', $piggyBank->id)
-                   ->increment('piggy_banks.order');
+            ->where('piggy_banks.id', '!=', $piggyBank->id)
+            ->increment('piggy_banks.order')
+        ;
         $piggyBank->order = $newOrder;
         app('log')->debug(sprintf('[2] Order of piggy #%d ("%s") from %d to %d', $piggyBank->id, $piggyBank->name, $oldOrder, $newOrder));
         $piggyBank->save();
@@ -334,37 +282,6 @@ trait ModifiesPiggyBanks
         return true;
     }
 
-    /**
-     * @param PiggyBank $piggyBank
-     * @param string    $note
-     *
-     * @return bool
-     */
-    private function updateNote(PiggyBank $piggyBank, string $note): bool
-    {
-        if ('' === $note) {
-            $dbNote = $piggyBank->notes()->first();
-            $dbNote?->delete();
-
-            return true;
-        }
-        $dbNote = $piggyBank->notes()->first();
-        if (null === $dbNote) {
-            $dbNote = new Note();
-            $dbNote->noteable()->associate($piggyBank);
-        }
-        $dbNote->text = trim($note);
-        $dbNote->save();
-
-        return true;
-    }
-
-    /**
-     * @param PiggyBank $piggyBank
-     * @param array     $data
-     *
-     * @return PiggyBank
-     */
     public function update(PiggyBank $piggyBank, array $data): PiggyBank
     {
         $piggyBank = $this->updateProperties($piggyBank, $data);
@@ -425,12 +342,25 @@ trait ModifiesPiggyBanks
         return $piggyBank;
     }
 
-    /**
-     * @param PiggyBank $piggyBank
-     * @param array     $data
-     *
-     * @return PiggyBank
-     */
+    private function updateNote(PiggyBank $piggyBank, string $note): bool
+    {
+        if ('' === $note) {
+            $dbNote = $piggyBank->notes()->first();
+            $dbNote?->delete();
+
+            return true;
+        }
+        $dbNote = $piggyBank->notes()->first();
+        if (null === $dbNote) {
+            $dbNote = new Note();
+            $dbNote->noteable()->associate($piggyBank);
+        }
+        $dbNote->text = trim($note);
+        $dbNote->save();
+
+        return true;
+    }
+
     private function updateProperties(PiggyBank $piggyBank, array $data): PiggyBank
     {
         if (array_key_exists('name', $data) && '' !== $data['name']) {