kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-12-16 03:19:56 +00:00
Code Issues Projects Releases Wiki Activity

Update PHP doc everywhere.

Browse Source
This commit is contained in:
James Cole
2018-07-21 08:06:24 +02:00
parent 5ca4f1b181
commit 02f5eddd14
47 changed files with 363 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
app/Http/Controllers/Chart/AccountController.php
View File

@@ -52,11 +52,11 @@ class AccountController extends Controller
{
use DateCalculation;
/** @var GeneratorInterface */
/** @var GeneratorInterface Chart generation methods. */
protected $generator;
/**
*
* AccountController constructor.
*/
public function __construct()
{
@@ -109,6 +109,8 @@ class AccountController extends Controller
/**
* Expenses per budget, as shown on account overview.
*
* @param Account $account
* @param Carbon $start
* @param Carbon $end
@@ -152,6 +154,8 @@ class AccountController extends Controller
}
/**
* Expenses per budget for all time, as shown on account overview.
*
* @param AccountRepositoryInterface $repository
* @param Account $account
*
@@ -167,6 +171,8 @@ class AccountController extends Controller
/**
* Expenses per category for one single account.
*
* @param Account $account
* @param Carbon $start
* @param Carbon $end
@@ -210,6 +216,8 @@ class AccountController extends Controller
}
/**
* Expenses grouped by category for account.
*
* @param AccountRepositoryInterface $repository
* @param Account $account
*
@@ -253,6 +261,8 @@ class AccountController extends Controller
/**
* Shows all income per account for each category.
*
* @param Account $account
* @param Carbon $start
* @param Carbon $end
@@ -296,6 +306,8 @@ class AccountController extends Controller
}
/**
* Shows the income grouped by category for an account, in all time.
*
* @param AccountRepositoryInterface $repository
* @param Account $account
*
@@ -311,6 +323,8 @@ class AccountController extends Controller
/**
* Shows overview of account during a single period.
*
* @param Account $account
* @param Carbon $start
*
@@ -427,6 +441,8 @@ class AccountController extends Controller
/**
* Shows an overview of the account balances for a set of accounts.
*
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
@@ -484,6 +500,8 @@ class AccountController extends Controller
}
/**
* Get the budget names from a set of budget ID's.
*
* @param array $budgetIds
*
* @return array
@@ -506,7 +524,7 @@ class AccountController extends Controller
}
/**
* Small helper function for some of the charts.
* Get the category names from a set of category ID's. Small helper function for some of the charts.
*
* @param array $categoryIds
*

6
app/Http/Controllers/Chart/BillController.php
View File

@@ -38,11 +38,11 @@ use Illuminate\Support\Collection;
*/
class BillController extends Controller
{
/** @var GeneratorInterface */
/** @var GeneratorInterface Chart generation methods. */
protected $generator;
/**
* checked.
* BillController constructor.
*/
public function __construct()
{
@@ -85,6 +85,8 @@ class BillController extends Controller
/**
* Shows history for a single bill.
*
* @param JournalCollectorInterface $collector
* @param Bill $bill
*

25
app/Http/Controllers/Chart/BudgetController.php
View File

@@ -50,10 +50,10 @@ use Illuminate\Support\Collection;
class BudgetController extends Controller
{
use DateCalculation;
/** @var GeneratorInterface */
/** @var GeneratorInterface Chart generation methods. */
protected $generator;
/** @var BudgetRepositoryInterface */
/** @var BudgetRepositoryInterface The budget repository */
protected $repository;
/**
@@ -75,6 +75,8 @@ class BudgetController extends Controller
/**
* Shows overview of a single budget.
*
* @param Budget $budget
*
* @return JsonResponse
@@ -123,7 +125,6 @@ class BudgetController extends Controller
/**
* Shows the amount left in a specific budget limit.
*
*
* @param Budget $budget
* @param BudgetLimit $budgetLimit
*
@@ -169,6 +170,8 @@ class BudgetController extends Controller
/**
* Shows how much is spent per asset account.
*
* @param Budget $budget
* @param BudgetLimit|null $budgetLimit
*
@@ -217,6 +220,8 @@ class BudgetController extends Controller
/**
* Shows how much is spent per category.
*
* @param Budget $budget
* @param BudgetLimit|null $budgetLimit
*
@@ -266,6 +271,8 @@ class BudgetController extends Controller
/**
* Shows how much is spent per expense account.
*
* @param Budget $budget
* @param BudgetLimit|null $budgetLimit
*
@@ -370,6 +377,7 @@ class BudgetController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Shows a budget overview chart (spent and budgeted).
*
* @param Budget $budget
* @param Carbon $start
@@ -415,6 +423,8 @@ class BudgetController extends Controller
/**
* Shows a chart for transactions without a budget.
*
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
@@ -451,6 +461,8 @@ class BudgetController extends Controller
}
/**
* Get the account names belonging to a bunch of account ID's.
*
* @param array $accountIds
*
* @return array
@@ -473,6 +485,8 @@ class BudgetController extends Controller
}
/**
* Get the amount of money budgeted in a period.
*
* @param Budget $budget
* @param Carbon $start
* @param Carbon $end
@@ -501,7 +515,9 @@ class BudgetController extends Controller
}
/**
* Small helper function for some of the charts.
* Small helper function for some of the charts. Extracts category names from a bunch of ID's.
*
* TODO this method is duplicated and should be in a trait.
*
* @param array $categoryIds
*
@@ -526,6 +542,7 @@ class BudgetController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Get the expenses for a budget in a date range.
*
* @param Collection $limits
* @param Budget $budget

16
app/Http/Controllers/Chart/BudgetReportController.php
View File

@@ -48,13 +48,13 @@ use Illuminate\Support\Collection;
*/
class BudgetReportController extends Controller
{
/** @var BudgetRepositoryInterface */
/** @var BudgetRepositoryInterface The budget repository */
private $budgetRepository;
/** @var GeneratorInterface */
/** @var GeneratorInterface Chart generation methods. */
private $generator;
/**
*
* BudgetReportController constructor.
*/
public function __construct()
{
@@ -71,6 +71,8 @@ class BudgetReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Chart that groups expenses by the account.
*
* @param Collection $accounts
* @param Collection $budgets
* @param Carbon $start
@@ -98,6 +100,8 @@ class BudgetReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Chart that groups the expenses by budget.
*
* @param Collection $accounts
* @param Collection $budgets
* @param Carbon $start
@@ -125,6 +129,8 @@ class BudgetReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Main overview of a budget in the budget report.
*
* @param Collection $accounts
* @param Collection $budgets
* @param Carbon $start
@@ -242,6 +248,8 @@ class BudgetReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Helper function that collects expenses for the given budgets.
*
* @param Collection $accounts
* @param Collection $budgets
* @param Carbon $start
@@ -264,6 +272,8 @@ class BudgetReportController extends Controller
}
/**
* Helper function that groups expenses.
*
* @param Collection $set
*
* @return array

14
app/Http/Controllers/Chart/CategoryController.php
View File

@@ -38,11 +38,11 @@ use Illuminate\Support\Collection;
*/
class CategoryController extends Controller
{
/** @var GeneratorInterface */
/** @var GeneratorInterface Chart generation methods. */
protected $generator;
/**
*
* CategoryController constructor.
*/
public function __construct()
{
@@ -112,6 +112,8 @@ class CategoryController extends Controller
/**
* Shows the category chart on the front page.
*
* @param CategoryRepositoryInterface $repository
* @param AccountRepositoryInterface $accountRepository
*
@@ -154,6 +156,8 @@ class CategoryController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Chart report.
*
* @param Category $category
* @param Collection $accounts
* @param Carbon $start
@@ -215,6 +219,8 @@ class CategoryController extends Controller
/**
* Chart for period for transactions without a category.
*
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
@@ -272,6 +278,8 @@ class CategoryController extends Controller
}
/**
* Chart for a specific period.
*
* @param Category $category
* @param $date
*
@@ -289,6 +297,8 @@ class CategoryController extends Controller
/**
* Chart for a specific period (start and end).
*
* @param Category $category
* @param Carbon $start
* @param Carbon $end

20
app/Http/Controllers/Chart/CategoryReportController.php
View File

@@ -45,11 +45,11 @@ use Illuminate\Support\Collection;
*/
class CategoryReportController extends Controller
{
/** @var GeneratorInterface */
/** @var GeneratorInterface Chart generation methods. */
private $generator;
/**
*
* CategoryReportController constructor.
*/
public function __construct()
{
@@ -65,6 +65,8 @@ class CategoryReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Chart for expenses grouped by expense account.
*
* @param Collection $accounts
* @param Collection $categories
* @param Carbon $start
@@ -89,6 +91,8 @@ class CategoryReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Chart for income grouped by revenue account.
*
* @param Collection $accounts
* @param Collection $categories
* @param Carbon $start
@@ -116,6 +120,8 @@ class CategoryReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Chart for expenses grouped by expense account.
*
* @param Collection $accounts
* @param Collection $categories
* @param Carbon $start
@@ -143,6 +149,8 @@ class CategoryReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Piechart for income grouped by account.
*
* @param Collection $accounts
* @param Collection $categories
* @param Carbon $start
@@ -170,6 +178,8 @@ class CategoryReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Main report category chart.
*
* @param Collection $accounts
* @param Collection $categories
* @param Carbon $start
@@ -281,6 +291,8 @@ class CategoryReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Get all expenses in a period for categories.
*
* @param Collection $accounts
* @param Collection $categories
* @param Carbon $start
@@ -306,6 +318,8 @@ class CategoryReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Get all income for a period and a bunch of categories.
*
* @param Collection $accounts
* @param Collection $categories
* @param Carbon $start
@@ -327,6 +341,8 @@ class CategoryReportController extends Controller
}
/**
* Group transactions by category.
*
* @param Collection $set
*
* @return array

12
app/Http/Controllers/Chart/ExpenseReportController.php
View File

@@ -45,7 +45,7 @@ class ExpenseReportController extends Controller
{
/** @var AccountRepositoryInterface The account repository */
protected $accountRepository;
/** @var GeneratorInterface */
/** @var GeneratorInterface Chart generation methods. */
protected $generator;
/**
@@ -66,6 +66,8 @@ class ExpenseReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Main chart that shows income and expense for a combination of expense/revenue accounts.
*
* @param Collection $accounts
* @param Collection $expense
* @param Carbon $start
@@ -191,6 +193,8 @@ class ExpenseReportController extends Controller
}
/**
* Searches for the opposing account.
*
* @param Collection $accounts
*
* @return array
@@ -214,6 +218,8 @@ class ExpenseReportController extends Controller
}
/**
* Get all expenses for a set of accounts.
*
* @param Collection $accounts
* @param Collection $opposing
* @param Carbon $start
@@ -231,6 +237,8 @@ class ExpenseReportController extends Controller
}
/**
* Get the income for a set of accounts.
*
* @param Collection $accounts
* @param Collection $opposing
* @param Carbon $start
@@ -249,6 +257,8 @@ class ExpenseReportController extends Controller
}
/**
* Group set of transactions by name of opposing account.
*
* @param Collection $set
*
* @return array

4
app/Http/Controllers/Chart/PiggyBankController.php
View File

@@ -39,11 +39,11 @@ use Illuminate\Support\Collection;
class PiggyBankController extends Controller
{
use DateCalculation;
/** @var GeneratorInterface */
/** @var GeneratorInterface Chart generation methods. */
protected $generator;
/**
*
* PiggyBankController constructor.
*/
public function __construct()
{

6
app/Http/Controllers/Chart/ReportController.php
View File

@@ -36,11 +36,11 @@ use Log;
*/
class ReportController extends Controller
{
/** @var GeneratorInterface */
/** @var GeneratorInterface Chart generation methods. */
protected $generator;
/**
*
* ReportController constructor.
*/
public function __construct()
{
@@ -220,6 +220,8 @@ class ReportController extends Controller
}
/**
* Sum up an array.
*
* @param $array
*
* @return string

24
app/Http/Controllers/Chart/TagReportController.php
View File

@@ -44,11 +44,11 @@ use Illuminate\Support\Collection;
*/
class TagReportController extends Controller
{
/** @var GeneratorInterface */
/** @var GeneratorInterface Chart generation methods. */
protected $generator;
/**
*
* TagReportController constructor.
*/
public function __construct()
{
@@ -59,6 +59,8 @@ class TagReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Generate expenses for tags grouped on account.
*
* @param Collection $accounts
* @param Collection $tags
* @param Carbon $start
@@ -86,6 +88,8 @@ class TagReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Generate income for tag grouped by account.
*
* @param Collection $accounts
* @param Collection $tags
* @param Carbon $start
@@ -113,6 +117,8 @@ class TagReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Generate expense for tag grouped on budget.
*
* @param Collection $accounts
* @param Collection $tags
* @param Carbon $start
@@ -139,6 +145,8 @@ class TagReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Generate expense for tag grouped on category.
*
* @param Collection $accounts
* @param Collection $tags
* @param Carbon $start
@@ -165,6 +173,8 @@ class TagReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Generate main tag overview chart.
*
* @param Collection $accounts
* @param Collection $tags
* @param Carbon $start
@@ -276,6 +286,8 @@ class TagReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Show expense grouped by expense account.
*
* @param Collection $accounts
* @param Collection $tags
* @param Carbon $start
@@ -303,6 +315,8 @@ class TagReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Show income grouped by tag.
*
* @param Collection $accounts
* @param Collection $tags
* @param Carbon $start
@@ -330,6 +344,8 @@ class TagReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Get all expenses by tags.
*
* @param Collection $accounts
* @param Collection $tags
* @param Carbon $start
@@ -355,6 +371,8 @@ class TagReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Get all income by tag.
*
* @param Collection $accounts
* @param Collection $tags
* @param Carbon $start
@@ -378,6 +396,8 @@ class TagReportController extends Controller
}
/**
* Group transactions by tag.
*
* @param Collection $set
*
* @return array