kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-10-12 15:35:15 +00:00
Code Issues Projects Releases Wiki Activity

Expand documentation for Helper directory.

Browse Source
This commit is contained in:
James Cole
2018-07-07 23:14:16 +02:00
parent 8e08ff2d39
commit 10492e3b2f
30 changed files with 328 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
app/Helpers/Report/PopupReportInterface.php
View File

@@ -33,6 +33,8 @@ use Illuminate\Support\Collection;
interface PopupReportInterface
{
/**
* Get balances for budget.
*
* @param Budget $budget
* @param Account $account
* @param array $attributes
@@ -42,6 +44,8 @@ interface PopupReportInterface
public function balanceForBudget(Budget $budget, Account $account, array $attributes): Collection;
/**
* Get balances for transactions without a budget.
*
* @param Account $account
* @param array $attributes
*
@@ -50,6 +54,7 @@ interface PopupReportInterface
public function balanceForNoBudget(Account $account, array $attributes): Collection;
/**
* Group by budget.
* @param Budget $budget
* @param array $attributes
*
@@ -58,6 +63,8 @@ interface PopupReportInterface
public function byBudget(Budget $budget, array $attributes): Collection;
/**
* Group by category.
*
* @param Category $category
* @param array $attributes
*
@@ -66,6 +73,8 @@ interface PopupReportInterface
public function byCategory(Category $category, array $attributes): Collection;
/**
* Do something with expense. Sorry, I am not very inspirational here.
*
* @param Account $account
* @param array $attributes
*
@@ -74,6 +83,8 @@ interface PopupReportInterface
public function byExpenses(Account $account, array $attributes): Collection;
/**
* Do something with income. Sorry, I am not very inspirational here.
*
* @param Account $account
* @param array $attributes
*