Update PHP doc everywhere.

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

View File

@@ -38,17 +38,16 @@ use Illuminate\Http\Request;
use Illuminate\Support\Collection;
/**
*
* Class AmountController
*/
class AmountController extends Controller
{
use DateCalculation;
/** @var BudgetRepositoryInterface */
/** @var BudgetRepositoryInterface The budget repository */
private $repository;
/**
*
* AmountController constructor.
*/
public function __construct()
{
@@ -69,6 +68,8 @@ class AmountController extends Controller
/**
* Set the amount for a single budget in a specific period. Shows a waring when its a lot.
*
* @param Request $request
* @param BudgetRepositoryInterface $repository
* @param Budget $budget
@@ -122,6 +123,8 @@ class AmountController extends Controller
/**
* Shows some basic info about the income and the suggested budget.
*
* @param Carbon $start
* @param Carbon $end
*
@@ -169,6 +172,8 @@ class AmountController extends Controller
/**
* Store an available budget for the current period.
*
* @param BudgetIncomeRequest $request
*
* @return RedirectResponse
@@ -188,6 +193,8 @@ class AmountController extends Controller
}
/**
* Shows the form to update available budget.
*
* @param Request $request
* @param Carbon $start
* @param Carbon $end

View File

@@ -35,11 +35,11 @@ use Illuminate\Http\Request;
*/
class CreateController extends Controller
{
/** @var BudgetRepositoryInterface */
/** @var BudgetRepositoryInterface The budget repository */
private $repository;
/**
*
* CreateController constructor.
*/
public function __construct()
{
@@ -60,6 +60,8 @@ class CreateController extends Controller
/**
* Form to create a budget.
*
* @param Request $request
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -78,6 +80,8 @@ class CreateController extends Controller
/**
* Stores a budget.
*
* @param BudgetFormRequest $request
*
* @return \Illuminate\Http\RedirectResponse

View File

@@ -35,11 +35,11 @@ use Illuminate\Http\Request;
*/
class DeleteController extends Controller
{
/** @var BudgetRepositoryInterface */
/** @var BudgetRepositoryInterface The budget repository */
private $repository;
/**
*
* DeleteController constructor.
*/
public function __construct()
{
@@ -60,6 +60,8 @@ class DeleteController extends Controller
/**
* Deletes a budget.
*
* @param Budget $budget
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -75,6 +77,8 @@ class DeleteController extends Controller
}
/**
* Destroys a budget.
*
* @param Request $request
* @param Budget $budget
*

View File

@@ -37,11 +37,11 @@ use Illuminate\Http\Request;
*/
class EditController extends Controller
{
/** @var BudgetRepositoryInterface */
/** @var BudgetRepositoryInterface The budget repository */
private $repository;
/**
*
* EditController constructor.
*/
public function __construct()
{
@@ -61,6 +61,8 @@ class EditController extends Controller
}
/**
* Budget edit form.
*
* @param Request $request
* @param Budget $budget
*
@@ -87,6 +89,8 @@ class EditController extends Controller
}
/**
* Budget update routine.
*
* @param BudgetFormRequest $request
* @param Budget $budget
*

View File

@@ -41,11 +41,11 @@ class IndexController extends Controller
{
use DateCalculation;
/** @var BudgetRepositoryInterface */
/** @var BudgetRepositoryInterface The budget repository */
private $repository;
/**
*
* IndexController constructor.
*/
public function __construct()
{
@@ -66,6 +66,10 @@ class IndexController extends Controller
/**
* Show all budgets.
*
* TODO remove moment routine.
*
* @param Request $request
* @param string|null $moment
*

View File

@@ -44,11 +44,11 @@ use Illuminate\Support\Collection;
class ShowController extends Controller
{
/** @var BudgetRepositoryInterface */
/** @var BudgetRepositoryInterface The budget repository */
private $repository;
/**
*
* ShowController constructor.
*/
public function __construct()
{
@@ -68,6 +68,8 @@ class ShowController extends Controller
}
/**
* Show transactions without a budget.
*
* @param Request $request
* @param Carbon|null $start
* @param Carbon|null $end
@@ -99,6 +101,8 @@ class ShowController extends Controller
}
/**
* Shows ALL transactions without a budget.
*
* @param Request $request
* @param JournalRepositoryInterface $repository
*
@@ -128,6 +132,8 @@ class ShowController extends Controller
/**
* Show a single budget.
*
* @param Request $request
* @param Budget $budget
*
@@ -156,6 +162,8 @@ class ShowController extends Controller
}
/**
* Show a single budget by a budget limit.
*
* @param Request $request
* @param Budget $budget
* @param BudgetLimit $budgetLimit
@@ -195,6 +203,8 @@ class ShowController extends Controller
}
/**
* Gets all budget limits for a budget.
*
* @param Budget $budget
* @param Carbon $start
* @param Carbon $end
@@ -229,6 +239,8 @@ class ShowController extends Controller
/**
* Gets period overview used for budgets.
*
* @return Collection
*
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)