Move get income / get expense methods to trait.

app/Support/Http/Controllers/AugumentData.php

@@ -24,9 +24,12 @@ declare(strict_types=1);
 namespace FireflyIII\Support\Http\Controllers;
 
 use Carbon\Carbon;
+use FireflyIII\Models\Account;
 use FireflyIII\Models\AccountType;
 use FireflyIII\Models\Budget;
 use FireflyIII\Models\BudgetLimit;
+use FireflyIII\Models\Tag;
+use FireflyIII\Models\Transaction;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
 use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
 use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
@@ -39,6 +42,61 @@ use Illuminate\Support\Collection;
  */
 trait AugumentData
 {
+    /**
+     * Searches for the opposing account.
+     *
+     * @param Collection $accounts
+     *
+     * @return array
+     */
+    protected function combineAccounts(Collection $accounts): array // filter + group data
+    {
+        /** @var AccountRepositoryInterface $repository */
+        $repository = app(AccountRepositoryInterface::class);
+        $combined   = [];
+        /** @var Account $expenseAccount */
+        foreach ($accounts as $expenseAccount) {
+            $collection = new Collection;
+            $collection->push($expenseAccount);
+
+            $revenue = $repository->findByName($expenseAccount->name, [AccountType::REVENUE]);
+            if (null !== $revenue) {
+                $collection->push($revenue);
+            }
+            $combined[$expenseAccount->name] = $collection;
+        }
+
+        return $combined;
+    }
+
+    /**
+     * Returns the budget limits belonging to the given budget and valid on the given day.
+     *
+     * @param Collection $budgetLimits
+     * @param Budget     $budget
+     * @param Carbon     $start
+     * @param Carbon     $end
+     *
+     * @return Collection
+     */
+    protected function filterBudgetLimits(Collection $budgetLimits, Budget $budget, Carbon $start, Carbon $end): Collection // filter data
+    {
+        $set = $budgetLimits->filter(
+            function (BudgetLimit $budgetLimit) use ($budget, $start, $end) {
+                if ($budgetLimit->budget_id === $budget->id
+                    && $budgetLimit->start_date->lte($start) // start of budget limit is on or before start
+                    && $budgetLimit->end_date->gte($end) // end of budget limit is on or after end
+                ) {
+                    return $budgetLimit;
+                }
+
+                return false;
+            }
+        );
+
+        return $set;
+    }
+
     /**
      * Get the account names belonging to a bunch of account ID's.
      *
@@ -111,33 +169,96 @@ trait AugumentData
         return $return;
     }
 
-
-    /** @noinspection MoreThanThreeArgumentsInspection */
     /**
-     * Returns the budget limits belonging to the given budget and valid on the given day.
+     * Helper function that groups expenses.
      *
-     * @param Collection $budgetLimits
-     * @param Budget     $budget
-     * @param Carbon     $start
-     * @param Carbon     $end
+     * @param Collection $set
      *
-     * @return Collection
+     * @return array
      */
-    protected function filterBudgetLimits(Collection $budgetLimits, Budget $budget, Carbon $start, Carbon $end): Collection // filter data
+    protected function groupByBudget(Collection $set): array // filter + group data
     {
-        $set = $budgetLimits->filter(
-            function (BudgetLimit $budgetLimit) use ($budget, $start, $end) {
-                if ($budgetLimit->budget_id === $budget->id
-                    && $budgetLimit->start_date->lte($start) // start of budget limit is on or before start
-                    && $budgetLimit->end_date->gte($end) // end of budget limit is on or after end
-                ) {
-                    return $budgetLimit;
-                }
+        // group by category ID:
+        $grouped = [];
+        /** @var Transaction $transaction */
+        foreach ($set as $transaction) {
+            $jrnlBudId          = (int)$transaction->transaction_journal_budget_id;
+            $transBudId         = (int)$transaction->transaction_budget_id;
+            $budgetId           = max($jrnlBudId, $transBudId);
+            $grouped[$budgetId] = $grouped[$budgetId] ?? '0';
+            $grouped[$budgetId] = bcadd($transaction->transaction_amount, $grouped[$budgetId]);
+        }
 
-                return false;
+        return $grouped;
+    }
+
+    /**
+     * Group transactions by category.
+     *
+     * @param Collection $set
+     *
+     * @return array
+     */
+    protected function groupByCategory(Collection $set): array // filter + group data
+    {
+        // group by category ID:
+        $grouped = [];
+        /** @var Transaction $transaction */
+        foreach ($set as $transaction) {
+            $jrnlCatId            = (int)$transaction->transaction_journal_category_id;
+            $transCatId           = (int)$transaction->transaction_category_id;
+            $categoryId           = max($jrnlCatId, $transCatId);
+            $grouped[$categoryId] = $grouped[$categoryId] ?? '0';
+            $grouped[$categoryId] = bcadd($transaction->transaction_amount, $grouped[$categoryId]);
+        }
+
+        return $grouped;
+    }
+
+    /**
+     * Group set of transactions by name of opposing account.
+     *
+     * @param Collection $set
+     *
+     * @return array
+     */
+    protected function groupByName(Collection $set): array // filter + group data
+    {
+        // group by opposing account name.
+        $grouped = [];
+        /** @var Transaction $transaction */
+        foreach ($set as $transaction) {
+            $name           = $transaction->opposing_account_name;
+            $grouped[$name] = $grouped[$name] ?? '0';
+            $grouped[$name] = bcadd($transaction->transaction_amount, $grouped[$name]);
+        }
+
+        return $grouped;
+    }
+
+    /**
+     * Group transactions by tag.
+     *
+     * @param Collection $set
+     *
+     * @return array
+     */
+    protected function groupByTag(Collection $set): array // filter + group data
+    {
+        // group by category ID:
+        $grouped = [];
+        /** @var Transaction $transaction */
+        foreach ($set as $transaction) {
+            $journal     = $transaction->transactionJournal;
+            $journalTags = $journal->tags;
+            /** @var Tag $journalTag */
+            foreach ($journalTags as $journalTag) {
+                $journalTagId           = $journalTag->id;
+                $grouped[$journalTagId] = $grouped[$journalTagId] ?? '0';
+                $grouped[$journalTagId] = bcadd($transaction->transaction_amount, $grouped[$journalTagId]);
             }
-        );
+        }
 
-        return $set;
+        return $grouped;
     }
 }