Various API updates.

This commit is contained in:
James Cole
2019-06-04 20:42:11 +02:00
parent 6a6d67f2b4
commit 9b7835c9ed
11 changed files with 527 additions and 265 deletions

View File

@@ -55,8 +55,8 @@ interface BudgetRepositoryInterface
* This method collects various info on budgets, used on the budget page and on the index.
*
* @param Collection $budgets
* @param Carbon $start
* @param Carbon $end
* @param Carbon $start
* @param Carbon $end
*
* @return array
*/
@@ -82,12 +82,12 @@ interface BudgetRepositoryInterface
public function destroyBudgetLimit(BudgetLimit $budgetLimit): void;
/**
* @param int|null $budgetId
* @param int|null $budgetId
* @param string|null $budgetName
*
* @return Budget|null
*/
public function findBudget( ?int $budgetId, ?string $budgetName): ?Budget;
public function findBudget(?int $budgetId, ?string $budgetName): ?Budget;
/**
* Find budget by name.
@@ -130,8 +130,17 @@ interface BudgetRepositoryInterface
/**
* @param TransactionCurrency $currency
* @param Carbon $start
* @param Carbon $end
* @param Carbon $start
* @param Carbon $end
*
* @return Collection
*/
public function getAllBudgetLimitsByCurrency(TransactionCurrency $currency, Carbon $start = null, Carbon $end = null): Collection;
/**
* @param TransactionCurrency $currency
* @param Carbon $start
* @param Carbon $end
*
* @return string
*/
@@ -148,9 +157,20 @@ interface BudgetRepositoryInterface
/**
* Returns all available budget objects.
*
* @param Carbon|null $start
* @param Carbon|null $end
* @return Collection
*
*/
public function getAvailableBudgetsByDate(?Carbon $start, ?Carbon $end): Collection;
/**
* Returns all available budget objects.
*
* @param TransactionCurrency $currency
* @return Collection
*/
public function getAvailableBudgets(): Collection;
public function getAvailableBudgetsByCurrency(TransactionCurrency $currency): Collection;
/**
* Calculate the average amount in the budgets available in this period.
@@ -175,8 +195,8 @@ interface BudgetRepositoryInterface
/**
* @param Collection $budgets
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
* @param Carbon $start
* @param Carbon $end
*
* @return array
*/
@@ -205,8 +225,8 @@ interface BudgetRepositoryInterface
/**
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
* @param Carbon $start
* @param Carbon $end
*
* @return array
*/
@@ -221,9 +241,9 @@ interface BudgetRepositoryInterface
/**
* @param TransactionCurrency $currency
* @param Carbon $start
* @param Carbon $end
* @param string $amount
* @param Carbon $start
* @param Carbon $end
* @param string $amount
*
* @return AvailableBudget
*/
@@ -231,7 +251,7 @@ interface BudgetRepositoryInterface
/**
* @param Budget $budget
* @param int $order
* @param int $order
*/
public function setBudgetOrder(Budget $budget, int $order): void;
@@ -245,8 +265,8 @@ interface BudgetRepositoryInterface
/**
* @param Collection $budgets
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
* @param Carbon $start
* @param Carbon $end
*
* @return string
*/
@@ -259,8 +279,8 @@ interface BudgetRepositoryInterface
*
* @param Collection $budgets
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
* @param Carbon $start
* @param Carbon $end
*
* @return array
*/
@@ -268,8 +288,8 @@ interface BudgetRepositoryInterface
/**
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
* @param Carbon $start
* @param Carbon $end
*
* @return string
*/
@@ -277,8 +297,8 @@ interface BudgetRepositoryInterface
/**
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
* @param Carbon $start
* @param Carbon $end
*
* @return array
*/
@@ -301,7 +321,7 @@ interface BudgetRepositoryInterface
/**
* @param Budget $budget
* @param array $data
* @param array $data
*
* @return Budget
*/
@@ -309,7 +329,7 @@ interface BudgetRepositoryInterface
/**
* @param AvailableBudget $availableBudget
* @param array $data
* @param array $data
*
* @return AvailableBudget
*/
@@ -317,7 +337,7 @@ interface BudgetRepositoryInterface
/**
* @param BudgetLimit $budgetLimit
* @param array $data
* @param array $data
*
* @return BudgetLimit
*/