Update some phpdocs, courtesy of Psalm.

This commit is contained in:
James Cole
2020-03-25 07:03:23 +01:00
parent bcfbdcf3f0
commit 5445752588
41 changed files with 61 additions and 50 deletions

View File

@@ -71,7 +71,7 @@ class DeleteController extends Controller
*
* @param Account $account
*
* @return Factory|View
* @return Factory|RedirectResponse|Redirector|View
*/
public function delete(Account $account)
{

View File

@@ -81,8 +81,7 @@ class EditController extends Controller
* @param Account $account
* @param AccountRepositoryInterface $repository
*
* @return Factory|View
*
* @return Factory|RedirectResponse|Redirector|View
*/
public function edit(Request $request, Account $account, AccountRepositoryInterface $repository)
{

View File

@@ -216,7 +216,8 @@ class ReconcileController extends Controller
* @param string $difference
*
* @throws DuplicateTransactionException
* @return string
*
* @return RedirectResponse|Redirector|string
*/
private function createReconciliation(Account $account, Carbon $start, Carbon $end, string $difference)
{

View File

@@ -86,7 +86,8 @@ class ShowController extends Controller
* @param Carbon|null $end
*
* @throws Exception
* @return RedirectResponse|Redirector|View
*
* @return RedirectResponse|Redirector|\Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/
public function show(Request $request, Account $account, Carbon $start = null, Carbon $end = null)
{
@@ -158,7 +159,8 @@ class ShowController extends Controller
* @param Account $account
*
* @throws Exception
* @return RedirectResponse|Redirector|View
*
* @return RedirectResponse|Redirector|\Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/
public function showAll(Request $request, Account $account)
{

View File

@@ -90,7 +90,7 @@ class LinkController extends Controller
* @param Request $request
* @param LinkType $linkType
*
* @return RedirectResponse|Redirector|View
* @return Factory|RedirectResponse|Redirector|\Illuminate\View\View
*/
public function delete(Request $request, LinkType $linkType)
{

View File

@@ -55,7 +55,7 @@ class TelemetryController extends Controller
}
/**
* @return string
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
*/
public function deleteSubmitted()
{
@@ -67,7 +67,7 @@ class TelemetryController extends Controller
}
/**
* @return string
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
*/
public function deleteAll()
{

View File

@@ -57,10 +57,9 @@ class ForgotPasswordController extends Controller
* Send a reset link to the given user.
*
* @param Request $request
*
* @param UserRepositoryInterface $repository
*
* @return RedirectResponse|JsonResponse
* @return Factory|RedirectResponse|View
*/
public function sendResetLinkEmail(Request $request, UserRepositoryInterface $repository)
{

View File

@@ -68,7 +68,8 @@ class ResetPasswordController extends Controller
* @param Request $request
*
* @throws \Illuminate\Validation\ValidationException
* @return RedirectResponse|JsonResponse
*
* @return Factory|JsonResponse|RedirectResponse|View
*/
public function reset(Request $request)
{

View File

@@ -75,7 +75,7 @@ class CurrencyController extends Controller
*
* @param Request $request
*
* @return RedirectResponse|Redirector|View
* @return Factory|RedirectResponse|Redirector|\Illuminate\View\View
*/
public function create(Request $request)
{
@@ -128,7 +128,7 @@ class CurrencyController extends Controller
* @param Request $request
* @param TransactionCurrency $currency
*
* @return RedirectResponse|Redirector|View
* @return Factory|RedirectResponse|Redirector|\Illuminate\View\View
*/
public function delete(Request $request, TransactionCurrency $currency)
{
@@ -266,7 +266,7 @@ class CurrencyController extends Controller
* @param Request $request
* @param TransactionCurrency $currency
*
* @return RedirectResponse|Redirector|View
* @return Factory|RedirectResponse|Redirector|\Illuminate\View\View
*/
public function edit(Request $request, TransactionCurrency $currency)
{

View File

@@ -73,7 +73,7 @@ class PrerequisitesController extends Controller
* @param string $importProvider
* @param ImportJob $importJob
*
* @return Factory|View
* @return Factory|RedirectResponse|Redirector|View
*/
public function index(string $importProvider, ImportJob $importJob = null)
{

View File

@@ -58,7 +58,7 @@ class NewUserController extends Controller
/**
* Form the user gets when he has no data in the system.
*
* @return RedirectResponse|Redirector|View
* @return RedirectResponse|Redirector|\Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/
public function index()
{

View File

@@ -88,7 +88,7 @@ class ProfileController extends Controller
*
* @param Request $request
*
* @return Factory|View
* @return Factory|RedirectResponse|Redirector|View
*/
public function changeEmail(Request $request)
{
@@ -114,7 +114,7 @@ class ProfileController extends Controller
*
* @param Request $request
*
* @return Factory|View
* @return Factory|RedirectResponse|Redirector|View
*/
public function changePassword(Request $request)
{

View File

@@ -115,7 +115,7 @@ class InstallController extends Controller
/**
* Show index.
*
* @return RedirectResponse|Redirector
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/
public function index()
{

View File

@@ -68,7 +68,7 @@ class BulkController extends Controller
*
* TODO user wont be able to tell if journal is part of split.
*
* @param Collection $journals
* @param array $journals
*
* @return Factory|View
*/

View File

@@ -87,7 +87,8 @@ class ConvertController extends Controller
* @param TransactionGroup $group
*
* @throws Exception
* @return RedirectResponse|Redirector|View
*
* @return RedirectResponse|Redirector|\Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/
public function index(TransactionType $destinationType, TransactionGroup $group)
{

View File

@@ -63,7 +63,7 @@ class EditController extends Controller
/**
* @param TransactionGroup $transactionGroup
*
* @return Factory|View
* @return Factory|View|\Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
*/
public function edit(TransactionGroup $transactionGroup)
{