kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-11-18 15:39:50 +00:00
Code Issues Projects Releases Wiki Activity

Add php doc [skip ci]

Browse Source
This commit is contained in:
James Cole
2018-07-21 08:55:32 +02:00
parent 02f5eddd14
commit 4a90ce35f2
11 changed files with 77 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
app/Http/Controllers/Report/AccountController.php
View File

@@ -35,13 +35,15 @@ class AccountController extends Controller
{
/**
* Show partial overview for account balances.
*
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
*
* @return mixed|string
*
* @throws \Throwable
*/
public function general(Collection $accounts, Carbon $start, Carbon $end)
{

4
app/Http/Controllers/Report/BalanceController.php
View File

@@ -35,12 +35,14 @@ class BalanceController extends Controller
{
/**
* Show overview of budget balances.
*
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
*
* @return mixed|string
* @throws \Throwable
*/
public function general(Collection $accounts, Carbon $start, Carbon $end)
{

10
app/Http/Controllers/Report/BudgetController.php
View File

@@ -36,12 +36,16 @@ class BudgetController extends Controller
{
/**
* Show partial overview of budgets.
*
* TODO replace all \Throwable by catch/error and return simple string.
*
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
*
* @return mixed|string
* @throws \Throwable
*/
public function general(Collection $accounts, Carbon $start, Carbon $end)
{
@@ -65,12 +69,14 @@ class BudgetController extends Controller
/**
* Show budget overview for a period.
*
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
*
* @return mixed|string
* @throws \Throwable
*/
public function period(Collection $accounts, Carbon $start, Carbon $end)
{

6
app/Http/Controllers/Report/CategoryController.php
View File

@@ -38,6 +38,8 @@ class CategoryController extends Controller
{
/**
* Show overview of expenses in category.
*
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
@@ -75,6 +77,8 @@ class CategoryController extends Controller
/**
* Show overview of income in category.
*
* @param Collection $accounts
*
* @param Carbon $start
@@ -112,6 +116,8 @@ class CategoryController extends Controller
/**
* Show overview of operations.
*
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end

18
app/Http/Controllers/Report/ExpenseController.php
View File

@@ -180,7 +180,7 @@ class ExpenseController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Overview of spending
* Overview of spending.
*
* @param Collection $accounts
* @param Collection $expense
@@ -231,6 +231,8 @@ class ExpenseController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* List of top expenses.
*
* @param Collection $accounts
* @param Collection $expense
* @param Carbon $start
@@ -278,6 +280,8 @@ class ExpenseController extends Controller
}
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* List of top income.
*
* @param Collection $accounts
* @param Collection $expense
* @param Carbon $start
@@ -325,6 +329,8 @@ class ExpenseController extends Controller
}
/**
* Combine accounts into a single list.
*
* @param Collection $accounts
*
* @return array
@@ -349,6 +355,8 @@ class ExpenseController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Group by category (earnings).
*
* @param Collection $assets
* @param Collection $opposing
* @param Carbon $start
@@ -414,6 +422,8 @@ class ExpenseController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Earned in period for accounts.
*
* @param Collection $assets
* @param Collection $opposing
* @param Carbon $start
@@ -457,6 +467,8 @@ class ExpenseController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Spent by budget.
*
* @param Collection $assets
* @param Collection $opposing
* @param Carbon $start
@@ -521,6 +533,8 @@ class ExpenseController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Spent by category.
*
* @param Collection $assets
* @param Collection $opposing
* @param Carbon $start
@@ -586,6 +600,8 @@ class ExpenseController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Spent in a period.
*
* @param Collection $assets
* @param Collection $opposing
* @param Carbon $start

14
app/Http/Controllers/Report/OperationsController.php
View File

@@ -34,7 +34,7 @@ use Illuminate\Support\Collection;
class OperationsController extends Controller
{
/** @var AccountTaskerInterface */
/** @var AccountTaskerInterface Some specific account things. */
private $tasker;
/**
@@ -56,12 +56,14 @@ class OperationsController extends Controller
/**
* View of income and expense.
*
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
*
* @return mixed|string
* @throws \Throwable
*/
public function expenses(Collection $accounts, Carbon $start, Carbon $end)
{
@@ -83,12 +85,14 @@ class OperationsController extends Controller
}
/**
* View of income.
*
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
*
* @return string
* @throws \Throwable
*/
public function income(Collection $accounts, Carbon $start, Carbon $end): string
{
@@ -111,12 +115,14 @@ class OperationsController extends Controller
}
/**
* Overview of income and expense.
*
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
*
* @return mixed|string
* @throws \Throwable
*/
public function operations(Collection $accounts, Carbon $start, Carbon $end)
{