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,13 +38,13 @@ use Illuminate\Http\Request;
*/
class CreateController extends Controller
{
/** @var BudgetRepositoryInterface */
/** @var BudgetRepositoryInterface The budget repository */
private $budgets;
/** @var RecurringRepositoryInterface */
/** @var RecurringRepositoryInterface Recurring repository */
private $recurring;
/**
*
* CreateController constructor.
*/
public function __construct()
{
@@ -66,6 +66,8 @@ class CreateController extends Controller
}
/**
* Create a new recurring transaction.
*
* @param Request $request
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -113,6 +115,8 @@ class CreateController extends Controller
/**
* Store a recurring transaction.
*
* @param RecurrenceFormRequest $request
*
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector

View File

@@ -34,11 +34,11 @@ use Illuminate\Http\Request;
*/
class DeleteController extends Controller
{
/** @var RecurringRepositoryInterface */
/** @var RecurringRepositoryInterface Recurring repository */
private $recurring;
/**
*
* DeleteController constructor.
*/
public function __construct()
{
@@ -58,6 +58,8 @@ class DeleteController extends Controller
}
/**
* Delete a recurring transaction form.
*
* @param Recurrence $recurrence
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -68,13 +70,14 @@ class DeleteController extends Controller
// put previous url in session
$this->rememberPreviousUri('recurrences.delete.uri');
// todo actual number.
$journalsCreated = $this->recurring->getTransactions($recurrence)->count();
return view('recurring.delete', compact('recurrence', 'subTitle', 'journalsCreated'));
}
/**
* Destroy the recurring transaction.
*
* @param RecurringRepositoryInterface $repository
* @param Request $request
* @param Recurrence $recurrence

View File

@@ -40,13 +40,13 @@ use Symfony\Component\HttpFoundation\ParameterBag;
*/
class EditController extends Controller
{
/** @var BudgetRepositoryInterface */
/** @var BudgetRepositoryInterface The budget repository */
private $budgets;
/** @var RecurringRepositoryInterface */
/** @var RecurringRepositoryInterface Recurring repository */
private $recurring;
/**
*
* EditController constructor.
*/
public function __construct()
{
@@ -68,6 +68,8 @@ class EditController extends Controller
}
/**
* Edit a recurring transaction.
*
* todo move to repository
* todo handle old repetition type as well.
*
@@ -133,6 +135,8 @@ class EditController extends Controller
}
/**
* Update the recurring transaction.
*
* @param RecurrenceFormRequest $request
* @param Recurrence $recurrence
*

View File

@@ -39,11 +39,11 @@ use Symfony\Component\HttpFoundation\ParameterBag;
*/
class IndexController extends Controller
{
/** @var RecurringRepositoryInterface */
/** @var RecurringRepositoryInterface Recurring repository */
private $recurring;
/**
*
* IndexController constructor.
*/
public function __construct()
{
@@ -63,6 +63,8 @@ class IndexController extends Controller
}
/**
* Show all recurring transactions.
*
* TODO: split collection into pages
*
* @param Request $request
@@ -93,6 +95,8 @@ class IndexController extends Controller
}
/**
* Show a single recurring transaction.
*
* @param Request $request
* @param Recurrence $recurrence
*