gh-mirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2026-01-10 12:24:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

PHP7 compatible function definitions.

Browse Source
This commit is contained in:
James Cole
2016-04-05 22:00:03 +02:00
parent b0b5d90976
commit 37fe2d22b0
56 changed files with 209 additions and 216 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
app/Repositories/Budget/BudgetRepository.php
View File

@@ -48,27 +48,28 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
*
* @return string
*/
public function balanceInPeriod(Budget $budget, Carbon $start, Carbon $end, Collection $accounts)
public function balanceInPeriod(Budget $budget, Carbon $start, Carbon $end, Collection $accounts): string
{
return $this->commonBalanceInPeriod($budget, $start, $end, $accounts);
}
/**
* @return void
* @return bool
*/
public function cleanupBudgets()
public function cleanupBudgets(): bool
{
// delete limits with amount 0:
BudgetLimit::where('amount', 0)->delete();
return true;
}
/**
* @param Budget $budget
*
* @return boolean
* @return bool
*/
public function destroy(Budget $budget)
public function destroy(Budget $budget): bool
{
$budget->delete();
@@ -114,7 +115,7 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
*
* @return Carbon
*/
public function firstActivity(Budget $budget)
public function firstActivity(Budget $budget): Carbon
{
$first = $budget->transactionjournals()->orderBy('date', 'ASC')->first();
if ($first) {
@@ -127,7 +128,7 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
/**
* @return Collection
*/
public function getActiveBudgets()
public function getActiveBudgets(): Collection
{
/** @var Collection $set */
$set = $this->user->budgets()->where('active', 1)->get();
@@ -147,7 +148,7 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
*
* @return Collection
*/
public function getAllBudgetLimitRepetitions(Carbon $start, Carbon $end)
public function getAllBudgetLimitRepetitions(Carbon $start, Carbon $end): Collection
{
/** @var Collection $repetitions */
return LimitRepetition::
@@ -167,7 +168,7 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
*
* @return Collection
*/
public function getAllWithoutBudget(Account $account, Collection $accounts, Carbon $start, Carbon $end)
public function getAllWithoutBudget(Account $account, Collection $accounts, Carbon $start, Carbon $end): Collection
{
$ids = $accounts->pluck('id')->toArray();
@@ -192,7 +193,7 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
*
* @return Collection
*/
public function getBudgetedPerYear(Collection $budgets, Carbon $start, Carbon $end)
public function getBudgetedPerYear(Collection $budgets, Carbon $start, Carbon $end): Collection
{
$budgetIds = $budgets->pluck('id')->toArray();
@@ -218,7 +219,7 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
/**
* @return Collection
*/
public function getBudgets()
public function getBudgets(): Collection
{
/** @var Collection $set */
$set = $this->user->budgets()->get();
@@ -242,7 +243,7 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
*
* @return array
*/
public function getBudgetsAndExpensesPerMonth(Collection $accounts, Carbon $start, Carbon $end)
public function getBudgetsAndExpensesPerMonth(Collection $accounts, Carbon $start, Carbon $end): array
{
$ids = $accounts->pluck('id')->toArray();
@@ -303,7 +304,7 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
*
* @return array
*/
public function getBudgetsAndExpensesPerYear(Collection $budgets, Collection $accounts, Carbon $start, Carbon $end)
public function getBudgetsAndExpensesPerYear(Collection $budgets, Collection $accounts, Carbon $start, Carbon $end): array
{
$ids = $accounts->pluck('id')->toArray();
$budgetIds = $budgets->pluck('id')->toArray();
@@ -362,7 +363,7 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
*
* @return Collection
*/
public function getBudgetsAndLimitsInRange(Carbon $start, Carbon $end)
public function getBudgetsAndLimitsInRange(Carbon $start, Carbon $end): Collection
{
/** @var Collection $set */
$set = $this->user
@@ -402,14 +403,17 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
* @param Carbon $start
* @param Carbon $end
*
* @return LimitRepetition|null
* @return LimitRepetition
*/
public function getCurrentRepetition(Budget $budget, Carbon $start, Carbon $end)
public function getCurrentRepetition(Budget $budget, Carbon $start, Carbon $end): LimitRepetition
{
$data = $budget->limitrepetitions()
->where('limit_repetitions.startdate', $start->format('Y-m-d 00:00:00'))
->where('limit_repetitions.enddate', $end->format('Y-m-d 00:00:00'))
->first(['limit_repetitions.*']);
if(is_null($data)) {
return new LimitRepetition;
}
return $data;
}
@@ -448,7 +452,7 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
*
* @return Collection
*/
public function getExpensesPerDay(Budget $budget, Carbon $start, Carbon $end)
public function getExpensesPerDay(Budget $budget, Carbon $start, Carbon $end): Collection
{
$set = $this->user->budgets()
->leftJoin('budget_transaction_journal', 'budget_transaction_journal.budget_id', '=', 'budgets.id')
@@ -471,7 +475,7 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
*
* @return Carbon
*/
public function getFirstBudgetLimitDate(Budget $budget)
public function getFirstBudgetLimitDate(Budget $budget): Carbon
{
$limit = $budget->budgetlimits()->orderBy('startdate', 'ASC')->first();
if ($limit) {
@@ -484,7 +488,7 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
/**
* @return Collection
*/
public function getInactiveBudgets()
public function getInactiveBudgets(): Collection
{
/** @var Collection $set */
$set = $this->user->budgets()->where('active', 0)->get();
@@ -507,7 +511,7 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
*
* @return LengthAwarePaginator
*/
public function getJournals(Budget $budget, LimitRepetition $repetition = null, int $take = 50)
public function getJournals(Budget $budget, LimitRepetition $repetition = null, int $take = 50): LengthAwarePaginator
{
$offset = intval(Input::get('page')) > 0 ? intval(Input::get('page')) * $take : 0;
$setQuery = $budget->transactionjournals()->expanded()
@@ -539,7 +543,7 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
*
* @return Collection
*/
public function getWithoutBudget(Carbon $start, Carbon $end)
public function getWithoutBudget(Carbon $start, Carbon $end): Collection
{
return $this->user
->transactionjournals()
@@ -559,7 +563,7 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
*
* @return Collection
*/
public function getWithoutBudgetForAccounts(Collection $accounts, Carbon $start, Carbon $end)
public function getWithoutBudgetForAccounts(Collection $accounts, Carbon $start, Carbon $end): Collection
{
$ids = $accounts->pluck('id')->toArray();
@@ -633,7 +637,7 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
*
* @return array
*/
public function spentAllPerDayForAccounts(Collection $accounts, Carbon $start, Carbon $end)
public function spentAllPerDayForAccounts(Collection $accounts, Carbon $start, Carbon $end): array
{
$ids = $accounts->pluck('id')->toArray();
/** @var Collection $query */
@@ -674,7 +678,7 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
*
* @return Collection
*/
public function spentPerBudgetPerAccount(Collection $budgets, Collection $accounts, Carbon $start, Carbon $end)
public function spentPerBudgetPerAccount(Collection $budgets, Collection $accounts, Carbon $start, Carbon $end): Collection
{
$accountIds = $accounts->pluck('id')->toArray();
$budgetIds = $budgets->pluck('id')->toArray();
@@ -752,7 +756,7 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
*
* @return Budget
*/
public function store(array $data)
public function store(array $data): Budget
{
$newBudget = new Budget(
[
@@ -771,7 +775,7 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
*
* @return Budget
*/
public function update(Budget $budget, array $data)
public function update(Budget $budget, array $data): Budget
{
// update the account:
$budget->name = $data['name'];
@@ -788,7 +792,7 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
*
* @return BudgetLimit
*/
public function updateLimitAmount(Budget $budget, Carbon $date, int $amount)
public function updateLimitAmount(Budget $budget, Carbon $date, int $amount): BudgetLimit
{
// there should be a budget limit for this startdate:
/** @var BudgetLimit $limit */

61
app/Repositories/Budget/BudgetRepositoryInterface.php
View File

@@ -6,6 +6,7 @@ namespace FireflyIII\Repositories\Budget;
use Carbon\Carbon;
use FireflyIII\Models\Account;
use FireflyIII\Models\Budget;
use FireflyIII\Models\BudgetLimit;
use FireflyIII\Models\LimitRepetition;
use Illuminate\Pagination\LengthAwarePaginator;
use Illuminate\Support\Collection;
@@ -32,16 +33,16 @@ interface BudgetRepositoryInterface
public function balanceInPeriod(Budget $budget, Carbon $start, Carbon $end, Collection $accounts);
/**
* @return void
* @return bool
*/
public function cleanupBudgets();
public function cleanupBudgets(): bool;
/**
* @param Budget $budget
*
* @return boolean
* @return bool
*/
public function destroy(Budget $budget);
public function destroy(Budget $budget): bool;
/**
* @param Budget $budget
@@ -67,12 +68,12 @@ interface BudgetRepositoryInterface
*
* @return Carbon
*/
public function firstActivity(Budget $budget);
public function firstActivity(Budget $budget): Carbon;
/**
* @return Collection
*/
public function getActiveBudgets();
public function getActiveBudgets(): Collection;
/**
* @param Carbon $start
@@ -80,17 +81,17 @@ interface BudgetRepositoryInterface
*
* @return Collection
*/
public function getAllBudgetLimitRepetitions(Carbon $start, Carbon $end);
public function getAllBudgetLimitRepetitions(Carbon $start, Carbon $end): Collection;
/**
* @param Account $account
* @param Account $account
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
* @param Carbon $start
* @param Carbon $end
*
* @return Collection
*/
public function getAllWithoutBudget(Account $account, Collection $accounts, Carbon $start, Carbon $end);
public function getAllWithoutBudget(Account $account, Collection $accounts, Carbon $start, Carbon $end): Collection;
/**
* Get the budgeted amounts for each budgets in each year.
@@ -101,12 +102,12 @@ interface BudgetRepositoryInterface
*
* @return Collection
*/
public function getBudgetedPerYear(Collection $budgets, Carbon $start, Carbon $end);
public function getBudgetedPerYear(Collection $budgets, Carbon $start, Carbon $end): Collection;
/**
* @return Collection
*/
public function getBudgets();
public function getBudgets(): Collection;
/**
* Returns an array with every budget in it and the expenses for each budget
@@ -118,7 +119,7 @@ interface BudgetRepositoryInterface
*
* @return array
*/
public function getBudgetsAndExpensesPerMonth(Collection $accounts, Carbon $start, Carbon $end);
public function getBudgetsAndExpensesPerMonth(Collection $accounts, Carbon $start, Carbon $end): array;
/**
* Returns an array with every budget in it and the expenses for each budget
@@ -131,7 +132,7 @@ interface BudgetRepositoryInterface
*
* @return array
*/
public function getBudgetsAndExpensesPerYear(Collection $budgets, Collection $accounts, Carbon $start, Carbon $end);
public function getBudgetsAndExpensesPerYear(Collection $budgets, Collection $accounts, Carbon $start, Carbon $end): array;
/**
* Returns a list of budgets, budget limits and limit repetitions
@@ -142,16 +143,16 @@ interface BudgetRepositoryInterface
*
* @return Collection
*/
public function getBudgetsAndLimitsInRange(Carbon $start, Carbon $end);
public function getBudgetsAndLimitsInRange(Carbon $start, Carbon $end): Collection;
/**
* @param Budget $budget
* @param Carbon $start
* @param Carbon $end
*
* @return LimitRepetition|null
* @return LimitRepetition
*/
public function getCurrentRepetition(Budget $budget, Carbon $start, Carbon $end);
public function getCurrentRepetition(Budget $budget, Carbon $start, Carbon $end): LimitRepetition;
/**
* Returns all expenses for the given budget and the given accounts, in the given period.
@@ -175,19 +176,19 @@ interface BudgetRepositoryInterface
*
* @return Collection
*/
public function getExpensesPerDay(Budget $budget, Carbon $start, Carbon $end);
public function getExpensesPerDay(Budget $budget, Carbon $start, Carbon $end):Collection;
/**
* @param Budget $budget
*
* @return Carbon
*/
public function getFirstBudgetLimitDate(Budget $budget);
public function getFirstBudgetLimitDate(Budget $budget):Carbon;
/**
* @return Collection
*/
public function getInactiveBudgets();
public function getInactiveBudgets(): Collection;
/**
* Returns all the transaction journals for a limit, possibly limited by a limit repetition.
@@ -198,7 +199,7 @@ interface BudgetRepositoryInterface
*
* @return LengthAwarePaginator
*/
public function getJournals(Budget $budget, LimitRepetition $repetition = null, int $take = 50);
public function getJournals(Budget $budget, LimitRepetition $repetition = null, int $take = 50): LengthAwarePaginator;
/**
* @param Carbon $start
@@ -206,7 +207,7 @@ interface BudgetRepositoryInterface
*
* @return Collection
*/
public function getWithoutBudget(Carbon $start, Carbon $end);
public function getWithoutBudget(Carbon $start, Carbon $end): Collection;
/**
* @param Collection $accounts
@@ -215,7 +216,7 @@ interface BudgetRepositoryInterface
*
* @return Collection
*/
public function getWithoutBudgetForAccounts(Collection $accounts, Carbon $start, Carbon $end);
public function getWithoutBudgetForAccounts(Collection $accounts, Carbon $start, Carbon $end): Collection;
/**
* @param Collection $accounts
@@ -244,7 +245,7 @@ interface BudgetRepositoryInterface
*
* @return array
*/
public function spentAllPerDayForAccounts(Collection $accounts, Carbon $start, Carbon $end);
public function spentAllPerDayForAccounts(Collection $accounts, Carbon $start, Carbon $end): array;
/**
* Returns a list of expenses (in the field "spent", grouped per budget per account.
@@ -256,7 +257,7 @@ interface BudgetRepositoryInterface
*
* @return Collection
*/
public function spentPerBudgetPerAccount(Collection $budgets, Collection $accounts, Carbon $start, Carbon $end);
public function spentPerBudgetPerAccount(Collection $budgets, Collection $accounts, Carbon $start, Carbon $end): Collection;
/**
* Returns an array with the following key:value pairs:
@@ -279,7 +280,7 @@ interface BudgetRepositoryInterface
*
* @return Budget
*/
public function store(array $data);
public function store(array $data): Budget;
/**
* @param Budget $budget
@@ -287,15 +288,15 @@ interface BudgetRepositoryInterface
*
* @return Budget
*/
public function update(Budget $budget, array $data);
public function update(Budget $budget, array $data) : Budget;
/**
* @param Budget $budget
* @param Carbon $date
* @param int $amount
*
* @return mixed
* @return BudgetLimit
*/
public function updateLimitAmount(Budget $budget, Carbon $date, int $amount);
public function updateLimitAmount(Budget $budget, Carbon $date, int $amount) : BudgetLimit;
}