Code cleanup.

app/TransactionRules/Actions/ConvertToTransfer.php

@@ -23,7 +23,6 @@ declare(strict_types=1);
 
 namespace FireflyIII\TransactionRules\Actions;
 
-use DB;
 use FireflyIII\Events\Model\Rule\RuleActionFailedOnArray;
 use FireflyIII\Events\Model\Rule\RuleActionFailedOnObject;
 use FireflyIII\Events\TriggeredAuditLog;
@@ -36,7 +35,6 @@ use FireflyIII\Models\TransactionType;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
 
 /**
- *
  * Class ConvertToTransfer
  */
 class ConvertToTransfer implements ActionInterface
@@ -45,31 +43,28 @@ class ConvertToTransfer implements ActionInterface
 
     /**
      * TriggerInterface constructor.
-     *
-     * @param RuleAction $action
      */
     public function __construct(RuleAction $action)
     {
         $this->action = $action;
     }
 
-    /**
-     * @inheritDoc
-     */
     public function actOnArray(array $journal): bool
     {
         // make object from array (so the data is fresh).
-        /** @var TransactionJournal|null $object */
+        /** @var null|TransactionJournal $object */
         $object = TransactionJournal::where('user_id', $journal['user_id'])->find($journal['transaction_journal_id']);
         if (null === $object) {
             app('log')->error(sprintf('Cannot find journal #%d, cannot convert to transfer.', $journal['transaction_journal_id']));
             event(new RuleActionFailedOnArray($this->action, $journal, trans('rules.journal_not_found')));
+
             return false;
         }
         $groupCount = TransactionJournal::where('transaction_group_id', $journal['transaction_group_id'])->count();
         if ($groupCount > 1) {
             app('log')->error(sprintf('Group #%d has more than one transaction in it, cannot convert to transfer.', $journal['transaction_group_id']));
             event(new RuleActionFailedOnArray($this->action, $journal, trans('rules.split_group')));
+
             return false;
         }
 
@@ -86,6 +81,7 @@ class ConvertToTransfer implements ActionInterface
         }
         if (TransactionType::DEPOSIT !== $type && TransactionType::WITHDRAWAL !== $type) {
             event(new RuleActionFailedOnArray($this->action, $journal, trans('rules.unsupported_transaction_type_transfer', ['type' => $type])));
+
             return false;
         }
 
@@ -121,64 +117,64 @@ class ConvertToTransfer implements ActionInterface
 
         if (TransactionType::WITHDRAWAL === $type) {
             app('log')->debug('Going to transform a withdrawal to a transfer.');
+
             try {
                 $res = $this->convertWithdrawalArray($object, $opposing);
             } catch (FireflyException $e) {
                 app('log')->debug('Could not convert withdrawal to transfer.');
                 app('log')->error($e->getMessage());
                 event(new RuleActionFailedOnArray($this->action, $journal, trans('rules.complex_error')));
+
                 return false;
             }
             if (false !== $res) {
                 event(new TriggeredAuditLog($this->action->rule, $object, 'update_transaction_type', TransactionType::WITHDRAWAL, TransactionType::TRANSFER));
             }
+
             return $res;
         }
         // can only be a deposit at this point.
         app('log')->debug('Going to transform a deposit to a transfer.');
+
         try {
             $res = $this->convertDepositArray($object, $opposing);
         } catch (FireflyException $e) {
             app('log')->debug('Could not convert deposit to transfer.');
             app('log')->error($e->getMessage());
             event(new RuleActionFailedOnArray($this->action, $journal, trans('rules.complex_error')));
+
             return false;
         }
         if (false !== $res) {
             event(new TriggeredAuditLog($this->action->rule, $object, 'update_transaction_type', TransactionType::DEPOSIT, TransactionType::TRANSFER));
         }
+
         return $res;
     }
 
-    /**
-     * @param int $journalId
-     *
-     * @return string
-     */
     private function getSourceType(int $journalId): string
     {
-        /** @var TransactionJournal|null $journal */
+        /** @var null|TransactionJournal $journal */
         $journal = TransactionJournal::find($journalId);
         if (null === $journal) {
             app('log')->error(sprintf('Journal #%d does not exist. Cannot convert to transfer.', $journalId));
+
             return '';
         }
+
         return (string)$journal->transactions()->where('amount', '<', 0)->first()?->account?->accountType?->type;
     }
 
-    /**
-     * @param int $journalId
-     *
-     * @return string
-     */
     private function getDestinationType(int $journalId): string
     {
-        /** @var TransactionJournal|null $journal */
+        /** @var null|TransactionJournal $journal */
         $journal = TransactionJournal::find($journalId);
         if (null === $journal) {
             app('log')->error(sprintf('Journal #%d does not exist. Cannot convert to transfer.', $journalId));
+
             return '';
         }
+
         return (string)$journal->transactions()->where('amount', '>', 0)->first()?->account?->accountType?->type;
     }
 
@@ -187,10 +183,6 @@ class ConvertToTransfer implements ActionInterface
      * We replace the Expense with another asset.
      * So this replaces the destination
      *
-     * @param TransactionJournal $journal
-     * @param Account            $opposing
-     *
-     * @return bool
      * @throws FireflyException
      */
     private function convertWithdrawalArray(TransactionJournal $journal, Account $opposing): bool
@@ -209,17 +201,19 @@ class ConvertToTransfer implements ActionInterface
         }
 
         // update destination transaction:
-        DB::table('transactions')
-          ->where('transaction_journal_id', '=', $journal->id)
-          ->where('amount', '>', 0)
-          ->update(['account_id' => $opposing->id]);
+        \DB::table('transactions')
+            ->where('transaction_journal_id', '=', $journal->id)
+            ->where('amount', '>', 0)
+            ->update(['account_id' => $opposing->id])
+        ;
 
         // change transaction type of journal:
         $newType = TransactionType::whereType(TransactionType::TRANSFER)->first();
 
-        DB::table('transaction_journals')
-          ->where('id', '=', $journal->id)
-          ->update(['transaction_type_id' => $newType->id, 'bill_id' => null]);
+        \DB::table('transaction_journals')
+            ->where('id', '=', $journal->id)
+            ->update(['transaction_type_id' => $newType->id, 'bill_id' => null])
+        ;
 
         app('log')->debug('Converted withdrawal to transfer.');
 
@@ -227,18 +221,16 @@ class ConvertToTransfer implements ActionInterface
     }
 
     /**
-     * @param TransactionJournal $journal
-     *
-     * @return Account
      * @throws FireflyException
      */
     private function getSourceAccount(TransactionJournal $journal): Account
     {
-        /** @var Transaction|null $sourceTransaction */
+        /** @var null|Transaction $sourceTransaction */
         $sourceTransaction = $journal->transactions()->where('amount', '<', 0)->first();
         if (null === $sourceTransaction) {
             throw new FireflyException(sprintf('Cannot find source transaction for journal #%d', $journal->id));
         }
+
         return $sourceTransaction->account;
     }
 
@@ -246,10 +238,6 @@ class ConvertToTransfer implements ActionInterface
      * A deposit is from Revenue to Asset.
      * We replace the Revenue with another asset.
      *
-     * @param TransactionJournal $journal
-     * @param Account            $opposing
-     *
-     * @return bool
      * @throws FireflyException
      */
     private function convertDepositArray(TransactionJournal $journal, Account $opposing): bool
@@ -268,17 +256,19 @@ class ConvertToTransfer implements ActionInterface
         }
 
         // update source transaction:
-        DB::table('transactions')
-          ->where('transaction_journal_id', '=', $journal->id)
-          ->where('amount', '<', 0)
-          ->update(['account_id' => $opposing->id]);
+        \DB::table('transactions')
+            ->where('transaction_journal_id', '=', $journal->id)
+            ->where('amount', '<', 0)
+            ->update(['account_id' => $opposing->id])
+        ;
 
         // change transaction type of journal:
         $newType = TransactionType::whereType(TransactionType::TRANSFER)->first();
 
-        DB::table('transaction_journals')
-          ->where('id', '=', $journal->id)
-          ->update(['transaction_type_id' => $newType->id, 'bill_id' => null]);
+        \DB::table('transaction_journals')
+            ->where('id', '=', $journal->id)
+            ->update(['transaction_type_id' => $newType->id, 'bill_id' => null])
+        ;
 
         app('log')->debug('Converted deposit to transfer.');
 
@@ -286,18 +276,16 @@ class ConvertToTransfer implements ActionInterface
     }
 
     /**
-     * @param TransactionJournal $journal
-     *
-     * @return Account
      * @throws FireflyException
      */
     private function getDestinationAccount(TransactionJournal $journal): Account
     {
-        /** @var Transaction|null $destAccount */
+        /** @var null|Transaction $destAccount */
         $destAccount = $journal->transactions()->where('amount', '>', 0)->first();
         if (null === $destAccount) {
             throw new FireflyException(sprintf('Cannot find destination transaction for journal #%d', $journal->id));
         }
+
         return $destAccount->account;
     }
 }