IntenseFinance/firefly-iii
3
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2026-09-03 20:52:58 -05:00
Code Issues Packages Projects Releases Wiki Activity

Building report from issue #386

Browse Source
This commit is contained in:
James Cole
2016-12-03 21:03:20 +01:00
parent 8377a2a0de
commit b032825342
8 changed files with 148 additions and 105 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app/Repositories/Budget/BudgetRepository.php
+9 -7
View File
@@ -212,19 +212,18 @@ class BudgetRepository implements BudgetRepositoryInterface
}
/**
* This method is being used to generate the budget overview in the year/multi-year report. More specifically, this
* method runs the query and returns the result that is used for this report.
*
* The query is used in both the year/multi-year budget overview AND in the accompanying chart.
* This method is being used to generate the budget overview in the year/multi-year report. Its used
* in both the year/multi-year budget overview AND in the accompanying chart.
*
* @param Collection $budgets
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
* @param bool $noBudget
*
* @return array
*/
public function getBudgetPeriodReport(Collection $budgets, Collection $accounts, Carbon $start, Carbon $end): array
public function getBudgetPeriodReport(Collection $budgets, Collection $accounts, Carbon $start, Carbon $end, bool $noBudget): array
{
$carbonFormat = Navigation::preferredCarbonFormat($start, $end);
$data = [];
@@ -252,8 +251,11 @@ class BudgetRepository implements BudgetRepositoryInterface
$date = $transaction->date->format($carbonFormat);
$data[$budgetId]['entries'][$date] = bcadd($data[$budgetId]['entries'][$date] ?? '0', $transaction->transaction_amount);
}
// and now the same for stuff without a budget:
$data[0] = $this->getNoBudgetPeriodReport($start, $end);
if ($noBudget) {
// and now the same for stuff without a budget:
$data[0] = $this->getNoBudgetPeriodReport($start, $end);
}
return $data;
app/Repositories/Budget/BudgetRepositoryInterface.php
+5 -4
View File
@@ -96,10 +96,11 @@ interface BudgetRepositoryInterface
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
* @param bool $noBudget
*
* @return array
*/
public function getBudgetPeriodReport(Collection $budgets, Collection $accounts, Carbon $start, Carbon $end): array;
public function getBudgetPeriodReport(Collection $budgets, Collection $accounts, Carbon $start, Carbon $end, bool $noBudget): array;
/**
* @return Collection
@@ -119,7 +120,7 @@ interface BudgetRepositoryInterface
*
* @return string
*/
public function spentInPeriod(Collection $budgets, Collection $accounts, Carbon $start, Carbon $end) : string;
public function spentInPeriod(Collection $budgets, Collection $accounts, Carbon $start, Carbon $end): string;
/**
* @param Collection $accounts
@@ -143,7 +144,7 @@ interface BudgetRepositoryInterface
*
* @return Budget
*/
public function update(Budget $budget, array $data) : Budget;
public function update(Budget $budget, array $data): Budget;
/**
* @param Budget $budget
@@ -154,6 +155,6 @@ interface BudgetRepositoryInterface
*
* @return BudgetLimit
*/
public function updateLimitAmount(Budget $budget, Carbon $start, Carbon $end, string $range, int $amount) : BudgetLimit;
public function updateLimitAmount(Budget $budget, Carbon $start, Carbon $end, string $range, int $amount): BudgetLimit;
}
app/Repositories/Category/CategoryRepository.php
+79 -1
View File
@@ -15,12 +15,15 @@ namespace FireflyIII\Repositories\Category;
use Carbon\Carbon;
use DB;
use FireflyIII\Helpers\Collector\JournalCollectorInterface;
use FireflyIII\Models\Category;
use FireflyIII\Models\Transaction;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\Models\TransactionType;
use FireflyIII\User;
use Illuminate\Database\Query\JoinClause;
use Illuminate\Support\Collection;
use Navigation;
/**
* Class CategoryRepository
@@ -172,6 +175,32 @@ class CategoryRepository implements CategoryRepositoryInterface
return $set;
}
/**
* This method is being used to generate the category overview in the year/multi-year report. Its used
* in both the year/multi-year budget overview AND in the accompanying chart.
*
* @param Collection $categories
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
* @param @bool $noCategory
*
* @return array
*/
public function getCategoryPeriodReport(Collection $categories, Collection $accounts, Carbon $start, Carbon $end, bool $noCategory): array
{
$data = [
'income' => $this->getCategoryReportData($categories, $accounts, $start, $end, $noCategory, [TransactionType::DEPOSIT, TransactionType::TRANSFER]),
'expense' => $this->getCategoryReportData(
$categories, $accounts, $start, $end, $noCategory, [TransactionType::WITHDRAWAL, TransactionType::TRANSFER]
),
];
return $data;
}
/**
* @param Category $category
* @param Collection $accounts
@@ -233,6 +262,7 @@ class CategoryRepository implements CategoryRepositoryInterface
{
$sum = $this->sumInPeriod($categories, $accounts, TransactionType::WITHDRAWAL, $start, $end);
$sum = bcmul($sum, '-1');
return $sum;
}
@@ -284,6 +314,55 @@ class CategoryRepository implements CategoryRepositoryInterface
return $category;
}
/**
* @param Collection $categories
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
* @param bool $noCategory
* @param array $types
*
* @return array
*/
private function getCategoryReportData(Collection $categories, Collection $accounts, Carbon $start, Carbon $end, bool $noCategory, array $types): array
{
$carbonFormat = Navigation::preferredCarbonFormat($start, $end);
$data = [];
// prep data array:
/** @var Category $category */
foreach ($categories as $category) {
$data[$category->id] = [
'name' => $category->name,
'sum' => '0',
'entries' => [],
];
}
// get all transactions:
/** @var JournalCollectorInterface $collector */
$collector = app(JournalCollectorInterface::class);
$collector->setAccounts($accounts)->setRange($start, $end);
$collector->setCategories($categories)->setTypes($types)
->withOpposingAccount()
->enableInternalFilter();
$transactions = $collector->getJournals();
// loop transactions:
/** @var Transaction $transaction */
foreach ($transactions as $transaction) {
$categoryId = max(intval($transaction->transaction_journal_category_id), intval($transaction->transaction_category_id));
$date = $transaction->date->format($carbonFormat);
$data[$categoryId]['entries'][$date] = bcadd($data[$categoryId]['entries'][$date] ?? '0', $transaction->transaction_amount);
}
if ($noCategory) {
// and now the same for stuff without a budget:
//$data[0] = $this->getNoBudgetPeriodReport($start, $end);
}
return $data;
}
/**
* @param Collection $categories
* @param Collection $accounts
@@ -404,5 +483,4 @@ class CategoryRepository implements CategoryRepositoryInterface
return $sum;
}
}
app/Repositories/Category/CategoryRepositoryInterface.php
+18 -4
View File
@@ -49,7 +49,7 @@ interface CategoryRepositoryInterface
*
* @return string
*/
public function earnedInPeriodWithoutCategory(Collection $accounts, Carbon $start, Carbon $end) :string;
public function earnedInPeriodWithoutCategory(Collection $accounts, Carbon $start, Carbon $end): string;
/**
* Find a category
@@ -58,7 +58,7 @@ interface CategoryRepositoryInterface
*
* @return Category
*/
public function find(int $categoryId) : Category;
public function find(int $categoryId): Category;
/**
* Find a category
@@ -67,7 +67,7 @@ interface CategoryRepositoryInterface
*
* @return Category
*/
public function findByName(string $name) : Category;
public function findByName(string $name): Category;
/**
* @param Category $category
@@ -83,6 +83,20 @@ interface CategoryRepositoryInterface
*/
public function getCategories(): Collection;
/**
* This method is being used to generate the category overview in the year/multi-year report. Its used
* in both the year/multi-year budget overview AND in the accompanying chart.
*
* @param Collection $categories
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
* @param bool $noCategory
*
* @return array
*/
public function getCategoryPeriodReport(Collection $categories, Collection $accounts, Carbon $start, Carbon $end, bool $noCategory): array;
/**
* Return most recent transaction(journal) date.
*
@@ -110,7 +124,7 @@ interface CategoryRepositoryInterface
*
* @return string
*/
public function spentInPeriodWithoutCategory(Collection $accounts, Carbon $start, Carbon $end) : string;
public function spentInPeriodWithoutCategory(Collection $accounts, Carbon $start, Carbon $end): string;
/**
* @param array $data