Specify return types.

This commit is contained in:
James Cole
2018-07-08 12:28:42 +02:00
parent b315882f58
commit d05a1e0260
70 changed files with 254 additions and 229 deletions

View File

@@ -30,6 +30,7 @@ use FireflyIII\Models\Bill;
use FireflyIII\Models\Transaction;
use FireflyIII\Repositories\Bill\BillRepositoryInterface;
use FireflyIII\Support\CacheProperties;
use Illuminate\Http\JsonResponse;
use Illuminate\Support\Collection;
/**
@@ -55,9 +56,9 @@ class BillController extends Controller
*
* @param BillRepositoryInterface $repository
*
* @return \Symfony\Component\HttpFoundation\Response
* @return JsonResponse
*/
public function frontpage(BillRepositoryInterface $repository)
public function frontpage(BillRepositoryInterface $repository): JsonResponse
{
$start = session('start', Carbon::now()->startOfMonth());
$end = session('end', Carbon::now()->endOfMonth());
@@ -87,9 +88,9 @@ class BillController extends Controller
* @param JournalCollectorInterface $collector
* @param Bill $bill
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function single(JournalCollectorInterface $collector, Bill $bill)
public function single(JournalCollectorInterface $collector, Bill $bill): JsonResponse
{
$cache = new CacheProperties;
$cache->addProperty('chart.bill.single');

View File

@@ -36,6 +36,7 @@ use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
use FireflyIII\Support\CacheProperties;
use Illuminate\Http\JsonResponse;
use Illuminate\Support\Collection;
use Steam;
@@ -72,9 +73,9 @@ class BudgetController extends Controller
/**
* @param Budget $budget
*
* @return \Symfony\Component\HttpFoundation\Response
* @return JsonResponse
*/
public function budget(Budget $budget)
public function budget(Budget $budget): JsonResponse
{
$start = $this->repository->firstUseDate($budget);
$end = session('end', new Carbon);
@@ -132,11 +133,11 @@ class BudgetController extends Controller
* @param Budget $budget
* @param BudgetLimit $budgetLimit
*
* @return \Symfony\Component\HttpFoundation\Response
* @return JsonResponse
*
* @throws FireflyException
*/
public function budgetLimit(Budget $budget, BudgetLimit $budgetLimit)
public function budgetLimit(Budget $budget, BudgetLimit $budgetLimit): JsonResponse
{
if ($budgetLimit->budget->id !== $budget->id) {
throw new FireflyException('This budget limit is not part of this budget.');
@@ -177,9 +178,9 @@ class BudgetController extends Controller
* @param Budget $budget
* @param BudgetLimit|null $budgetLimit
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function expenseAsset(Budget $budget, ?BudgetLimit $budgetLimit)
public function expenseAsset(Budget $budget, ?BudgetLimit $budgetLimit): JsonResponse
{
$cache = new CacheProperties;
$cache->addProperty($budget->id);
@@ -222,9 +223,9 @@ class BudgetController extends Controller
* @param Budget $budget
* @param BudgetLimit|null $budgetLimit
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function expenseCategory(Budget $budget, ?BudgetLimit $budgetLimit)
public function expenseCategory(Budget $budget, ?BudgetLimit $budgetLimit): JsonResponse
{
$cache = new CacheProperties;
$cache->addProperty($budget->id);
@@ -269,9 +270,9 @@ class BudgetController extends Controller
* @param Budget $budget
* @param BudgetLimit|null $budgetLimit
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function expenseExpense(Budget $budget, ?BudgetLimit $budgetLimit)
public function expenseExpense(Budget $budget, ?BudgetLimit $budgetLimit): JsonResponse
{
$cache = new CacheProperties;
$cache->addProperty($budget->id);
@@ -316,7 +317,7 @@ class BudgetController extends Controller
*
* @return \Symfony\Component\HttpFoundation\Response
*/
public function frontpage()
public function frontpage(): \Symfony\Component\HttpFoundation\Response
{
$start = session('start', Carbon::now()->startOfMonth());
$end = session('end', Carbon::now()->endOfMonth());
@@ -370,9 +371,9 @@ class BudgetController extends Controller
* @param Carbon $end
* @param Collection $accounts
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function period(Budget $budget, Collection $accounts, Carbon $start, Carbon $end)
public function period(Budget $budget, Collection $accounts, Carbon $start, Carbon $end): JsonResponse
{
// chart properties for cache:
$cache = new CacheProperties();
@@ -413,9 +414,9 @@ class BudgetController extends Controller
* @param Carbon $start
* @param Carbon $end
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function periodNoBudget(Collection $accounts, Carbon $start, Carbon $end)
public function periodNoBudget(Collection $accounts, Carbon $start, Carbon $end): JsonResponse
{
// chart properties for cache:
$cache = new CacheProperties();

View File

@@ -36,6 +36,7 @@ use FireflyIII\Models\Transaction;
use FireflyIII\Models\TransactionType;
use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
use FireflyIII\Support\CacheProperties;
use Illuminate\Http\JsonResponse;
use Illuminate\Support\Collection;
/**
@@ -74,9 +75,9 @@ class BudgetReportController extends Controller
* @param Carbon $end
* @param string $others
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function accountExpense(Collection $accounts, Collection $budgets, Carbon $start, Carbon $end, string $others)
public function accountExpense(Collection $accounts, Collection $budgets, Carbon $start, Carbon $end, string $others): JsonResponse
{
/** @var MetaPieChartInterface $helper */
$helper = app(MetaPieChartInterface::class);
@@ -99,9 +100,9 @@ class BudgetReportController extends Controller
* @param Carbon $end
* @param string $others
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function budgetExpense(Collection $accounts, Collection $budgets, Carbon $start, Carbon $end, string $others)
public function budgetExpense(Collection $accounts, Collection $budgets, Carbon $start, Carbon $end, string $others): JsonResponse
{
/** @var MetaPieChartInterface $helper */
$helper = app(MetaPieChartInterface::class);
@@ -123,9 +124,9 @@ class BudgetReportController extends Controller
* @param Carbon $start
* @param Carbon $end
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function mainChart(Collection $accounts, Collection $budgets, Carbon $start, Carbon $end)
public function mainChart(Collection $accounts, Collection $budgets, Carbon $start, Carbon $end): JsonResponse
{
$cache = new CacheProperties;
$cache->addProperty('chart.budget.report.main');

View File

@@ -30,6 +30,7 @@ use FireflyIII\Models\Category;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
use FireflyIII\Support\CacheProperties;
use Illuminate\Http\JsonResponse;
use Illuminate\Support\Collection;
use Preferences;
@@ -59,9 +60,9 @@ class CategoryController extends Controller
* @param AccountRepositoryInterface $accountRepository
* @param Category $category
*
* @return \Symfony\Component\HttpFoundation\Response
* @return JsonResponse
*/
public function all(CategoryRepositoryInterface $repository, AccountRepositoryInterface $accountRepository, Category $category)
public function all(CategoryRepositoryInterface $repository, AccountRepositoryInterface $accountRepository, Category $category): JsonResponse
{
$cache = new CacheProperties;
$cache->addProperty('chart.category.all');
@@ -122,9 +123,9 @@ class CategoryController extends Controller
* @param CategoryRepositoryInterface $repository
* @param AccountRepositoryInterface $accountRepository
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function frontpage(CategoryRepositoryInterface $repository, AccountRepositoryInterface $accountRepository)
public function frontpage(CategoryRepositoryInterface $repository, AccountRepositoryInterface $accountRepository): JsonResponse
{
$start = session('start', Carbon::now()->startOfMonth());
$end = session('end', Carbon::now()->endOfMonth());
@@ -166,9 +167,9 @@ class CategoryController extends Controller
* @param Carbon $start
* @param Carbon $end
*
* @return \Illuminate\Http\JsonResponse|mixed
* @return JsonResponse
*/
public function reportPeriod(Category $category, Collection $accounts, Carbon $start, Carbon $end)
public function reportPeriod(Category $category, Collection $accounts, Carbon $start, Carbon $end): JsonResponse
{
$cache = new CacheProperties;
$cache->addProperty($start);
@@ -224,9 +225,9 @@ class CategoryController extends Controller
* @param Carbon $start
* @param Carbon $end
*
* @return \Illuminate\Http\JsonResponse|mixed
* @return JsonResponse
*/
public function reportPeriodNoCategory(Collection $accounts, Carbon $start, Carbon $end)
public function reportPeriodNoCategory(Collection $accounts, Carbon $start, Carbon $end): JsonResponse
{
$cache = new CacheProperties;
$cache->addProperty($start);
@@ -278,9 +279,9 @@ class CategoryController extends Controller
* @param Category $category
* @param $date
*
* @return \Symfony\Component\HttpFoundation\Response
* @return JsonResponse
*/
public function specificPeriod(Category $category, Carbon $date)
public function specificPeriod(Category $category, Carbon $date): JsonResponse
{
$range = Preferences::get('viewRange', '1M')->data;
$start = app('navigation')->startOfPeriod($date, $range);
@@ -298,7 +299,7 @@ class CategoryController extends Controller
*
* @return array
*/
private function makePeriodChart(Category $category, Carbon $start, Carbon $end)
private function makePeriodChart(Category $category, Carbon $start, Carbon $end): array
{
$cache = new CacheProperties;
$cache->addProperty($start);

View File

@@ -35,6 +35,7 @@ use FireflyIII\Models\Category;
use FireflyIII\Models\Transaction;
use FireflyIII\Models\TransactionType;
use FireflyIII\Support\CacheProperties;
use Illuminate\Http\JsonResponse;
use Illuminate\Support\Collection;
/**
@@ -70,9 +71,9 @@ class CategoryReportController extends Controller
* @param Carbon $end
* @param string $others
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function accountExpense(Collection $accounts, Collection $categories, Carbon $start, Carbon $end, string $others)
public function accountExpense(Collection $accounts, Collection $categories, Carbon $start, Carbon $end, string $others): JsonResponse
{
/** @var MetaPieChartInterface $helper */
$helper = app(MetaPieChartInterface::class);
@@ -92,9 +93,9 @@ class CategoryReportController extends Controller
* @param Carbon $end
* @param string $others
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function accountIncome(Collection $accounts, Collection $categories, Carbon $start, Carbon $end, string $others)
public function accountIncome(Collection $accounts, Collection $categories, Carbon $start, Carbon $end, string $others): JsonResponse
{
/** @var MetaPieChartInterface $helper */
$helper = app(MetaPieChartInterface::class);
@@ -117,9 +118,9 @@ class CategoryReportController extends Controller
* @param Carbon $end
* @param string $others
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function categoryExpense(Collection $accounts, Collection $categories, Carbon $start, Carbon $end, string $others)
public function categoryExpense(Collection $accounts, Collection $categories, Carbon $start, Carbon $end, string $others): JsonResponse
{
/** @var MetaPieChartInterface $helper */
$helper = app(MetaPieChartInterface::class);
@@ -142,9 +143,9 @@ class CategoryReportController extends Controller
* @param Carbon $end
* @param string $others
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function categoryIncome(Collection $accounts, Collection $categories, Carbon $start, Carbon $end, string $others)
public function categoryIncome(Collection $accounts, Collection $categories, Carbon $start, Carbon $end, string $others): JsonResponse
{
/** @var MetaPieChartInterface $helper */
$helper = app(MetaPieChartInterface::class);
@@ -167,9 +168,9 @@ class CategoryReportController extends Controller
* @param Carbon $start
* @param Carbon $end
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function mainChart(Collection $accounts, Collection $categories, Carbon $start, Carbon $end)
public function mainChart(Collection $accounts, Collection $categories, Carbon $start, Carbon $end): JsonResponse
{
$cache = new CacheProperties;
$cache->addProperty('chart.category.report.main');

View File

@@ -33,6 +33,7 @@ use FireflyIII\Models\Transaction;
use FireflyIII\Models\TransactionType;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Support\CacheProperties;
use Illuminate\Http\JsonResponse;
use Illuminate\Support\Collection;
/**
@@ -69,9 +70,9 @@ class ExpenseReportController extends Controller
* @param Carbon $start
* @param Carbon $end
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function mainChart(Collection $accounts, Collection $expense, Carbon $start, Carbon $end)
public function mainChart(Collection $accounts, Collection $expense, Carbon $start, Carbon $end): JsonResponse
{
$cache = new CacheProperties;
$cache->addProperty('chart.expense.report.main');

View File

@@ -29,6 +29,7 @@ use FireflyIII\Models\PiggyBank;
use FireflyIII\Models\PiggyBankEvent;
use FireflyIII\Repositories\PiggyBank\PiggyBankRepositoryInterface;
use FireflyIII\Support\CacheProperties;
use Illuminate\Http\JsonResponse;
use Illuminate\Support\Collection;
/**
@@ -55,9 +56,9 @@ class PiggyBankController extends Controller
* @param PiggyBankRepositoryInterface $repository
* @param PiggyBank $piggyBank
*
* @return \Symfony\Component\HttpFoundation\Response
* @return JsonResponse
*/
public function history(PiggyBankRepositoryInterface $repository, PiggyBank $piggyBank)
public function history(PiggyBankRepositoryInterface $repository, PiggyBank $piggyBank): JsonResponse
{
// chart properties for cache:
$cache = new CacheProperties;

View File

@@ -96,7 +96,7 @@ class ReportController extends Controller
*
* @return \Illuminate\Http\JsonResponse
*/
public function operations(Collection $accounts, Carbon $start, Carbon $end)
public function operations(Collection $accounts, Carbon $start, Carbon $end): JsonResponse
{
// chart properties for cache:
$cache = new CacheProperties;
@@ -153,7 +153,7 @@ class ReportController extends Controller
*
* @return \Illuminate\Http\JsonResponse
*/
public function sum(Collection $accounts, Carbon $start, Carbon $end)
public function sum(Collection $accounts, Carbon $start, Carbon $end): JsonResponse
{
// chart properties for cache:
$cache = new CacheProperties;

View File

@@ -36,6 +36,7 @@ use FireflyIII\Models\Tag;
use FireflyIII\Models\Transaction;
use FireflyIII\Models\TransactionType;
use FireflyIII\Support\CacheProperties;
use Illuminate\Http\JsonResponse;
use Illuminate\Support\Collection;
/**
@@ -63,9 +64,9 @@ class TagReportController extends Controller
* @param Carbon $end
* @param string $others
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function accountExpense(Collection $accounts, Collection $tags, Carbon $start, Carbon $end, string $others)
public function accountExpense(Collection $accounts, Collection $tags, Carbon $start, Carbon $end, string $others): JsonResponse
{
/** @var MetaPieChartInterface $helper */
$helper = app(MetaPieChartInterface::class);
@@ -87,9 +88,9 @@ class TagReportController extends Controller
* @param Carbon $end
* @param string $others
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function accountIncome(Collection $accounts, Collection $tags, Carbon $start, Carbon $end, string $others)
public function accountIncome(Collection $accounts, Collection $tags, Carbon $start, Carbon $end, string $others): JsonResponse
{
/** @var MetaPieChartInterface $helper */
$helper = app(MetaPieChartInterface::class);
@@ -110,9 +111,9 @@ class TagReportController extends Controller
* @param Carbon $start
* @param Carbon $end
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function budgetExpense(Collection $accounts, Collection $tags, Carbon $start, Carbon $end)
public function budgetExpense(Collection $accounts, Collection $tags, Carbon $start, Carbon $end): JsonResponse
{
/** @var MetaPieChartInterface $helper */
$helper = app(MetaPieChartInterface::class);
@@ -133,9 +134,9 @@ class TagReportController extends Controller
* @param Carbon $start
* @param Carbon $end
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function categoryExpense(Collection $accounts, Collection $tags, Carbon $start, Carbon $end)
public function categoryExpense(Collection $accounts, Collection $tags, Carbon $start, Carbon $end): JsonResponse
{
/** @var MetaPieChartInterface $helper */
$helper = app(MetaPieChartInterface::class);
@@ -156,9 +157,9 @@ class TagReportController extends Controller
* @param Carbon $start
* @param Carbon $end
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function mainChart(Collection $accounts, Collection $tags, Carbon $start, Carbon $end)
public function mainChart(Collection $accounts, Collection $tags, Carbon $start, Carbon $end): JsonResponse
{
$cache = new CacheProperties;
$cache->addProperty('chart.category.report.main');
@@ -262,9 +263,9 @@ class TagReportController extends Controller
* @param Carbon $end
* @param string $others
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function tagExpense(Collection $accounts, Collection $tags, Carbon $start, Carbon $end, string $others)
public function tagExpense(Collection $accounts, Collection $tags, Carbon $start, Carbon $end, string $others): JsonResponse
{
/** @var MetaPieChartInterface $helper */
$helper = app(MetaPieChartInterface::class);
@@ -286,9 +287,9 @@ class TagReportController extends Controller
* @param Carbon $end
* @param string $others
*
* @return \Illuminate\Http\JsonResponse
* @return JsonResponse
*/
public function tagIncome(Collection $accounts, Collection $tags, Carbon $start, Carbon $end, string $others)
public function tagIncome(Collection $accounts, Collection $tags, Carbon $start, Carbon $end, string $others): JsonResponse
{
/** @var MetaPieChartInterface $helper */
$helper = app(MetaPieChartInterface::class);