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

@@ -66,6 +66,8 @@ class AutoCompleteController extends Controller
}
/**
* List of all journals.
*
* @param JournalCollectorInterface $collector
*
* @return JsonResponse
@@ -97,6 +99,8 @@ class AutoCompleteController extends Controller
}
/**
* List of budgets.
*
* @param BudgetRepositoryInterface $repository
*
* @return JsonResponse
@@ -125,6 +129,8 @@ class AutoCompleteController extends Controller
}
/**
* List of currency names.
*
* @param CurrencyRepositoryInterface $repository
*
* @return JsonResponse
@@ -165,6 +171,8 @@ class AutoCompleteController extends Controller
/**
* List of journals with their ID.
*
* @param JournalCollectorInterface $collector
* @param TransactionJournal $except
*
@@ -198,6 +206,8 @@ class AutoCompleteController extends Controller
}
/**
* List of revenue accounts.
*
* @param AccountRepositoryInterface $repository
*
* @return JsonResponse
@@ -236,6 +246,8 @@ class AutoCompleteController extends Controller
}
/**
* List of journals by type.
*
* @param JournalCollectorInterface $collector
* @param string $what
*
@@ -254,6 +266,8 @@ class AutoCompleteController extends Controller
}
/**
* List if transaction types.
*
* @param JournalRepositoryInterface $repository
*
* @return JsonResponse

View File

@@ -44,6 +44,8 @@ class BoxController extends Controller
{
/**
* How much money user has available.
*
* @param BudgetRepositoryInterface $repository
*
* @return JsonResponse
@@ -98,6 +100,8 @@ class BoxController extends Controller
/**
* Current total balance.
*
* @param CurrencyRepositoryInterface $repository
*
* @return JsonResponse
@@ -183,6 +187,8 @@ class BoxController extends Controller
/**
* Bills to pay and paid.
*
* @param BillRepositoryInterface $repository
*
* @return JsonResponse
@@ -219,6 +225,8 @@ class BoxController extends Controller
/**
* Total user net worth.
*
* @param AccountRepositoryInterface $repository
*
* @return JsonResponse
@@ -282,6 +290,8 @@ class BoxController extends Controller
}
/**
* Get a currency or return default currency.
*
* @param Account $account
*
* @return TransactionCurrency
@@ -307,6 +317,8 @@ class BoxController extends Controller
}
/**
* Check if date is outside session range.
*
* @param Carbon $date
*
* @return bool

View File

@@ -39,6 +39,8 @@ class ExchangeController extends Controller
{
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Returns an exchange rate.
*
* @param Request $request
* @param TransactionCurrency $fromCurrency
* @param TransactionCurrency $toCurrency

View File

@@ -33,10 +33,12 @@ use Illuminate\Http\JsonResponse;
class FrontpageController extends Controller
{
/**
* Piggy bank pie chart.
*
* @param PiggyBankRepositoryInterface $repository
*
* @return JsonResponse
* @throws \Throwable
*/
public function piggyBanks(PiggyBankRepositoryInterface $repository): JsonResponse
{

View File

@@ -31,6 +31,8 @@ use Log;
class IntroController
{
/**
* Returns the introduction wizard for a page.
*
* @param string $route
* @param string|null $specificPage
*
@@ -66,6 +68,8 @@ class IntroController
}
/**
* Returns true if there is a general outro step.
*
* @param string $route
*
* @return bool
@@ -89,6 +93,8 @@ class IntroController
}
/**
* Enable the boxes for a specific page again.
*
* @param string $route
* @param string|null $specialPage
*
@@ -109,6 +115,8 @@ class IntroController
}
/**
* Set that you saw them.
*
* @param string $route
* @param string|null $specialPage
*
@@ -128,6 +136,8 @@ class IntroController
}
/**
* Get the basic steps from config.
*
* @param string $route
*
* @return array
@@ -154,6 +164,8 @@ class IntroController
}
/**
* Get specific info for special routes.
*
* @param string $route
* @param string $specificPage
*

View File

@@ -34,7 +34,6 @@ use FireflyIII\Models\Transaction;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
use FireflyIII\Repositories\Journal\JournalRepositoryInterface;
use FireflyIII\Services\Internal\Update\CurrencyUpdateService;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Collection;
@@ -48,15 +47,15 @@ use Illuminate\Support\Collection;
class ReconcileController extends Controller
{
/** @var CurrencyUpdateService */
private $accountRepos;
/** @var AccountRepositoryInterface The account repository */
private $accountRepos;
/** @var CurrencyRepositoryInterface The currency repository */
private $currencyRepos;
/** @var JournalRepositoryInterface Journals and transactions overview */
private $repository;
/**
*
* ReconcileController constructor.
*/
public function __construct()
{
@@ -78,6 +77,8 @@ class ReconcileController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Overview of reconciliation.
*
* @param Request $request
* @param Account $account
* @param Carbon $start
@@ -86,10 +87,10 @@ class ReconcileController extends Controller
* @return JsonResponse
*
* @throws FireflyException
*
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
* @throws \Throwable
*/
public function overview(Request $request, Account $account, Carbon $start, Carbon $end): JsonResponse
{
@@ -138,6 +139,8 @@ class ReconcileController extends Controller
/**
* Returns a list of transactions in a modal.
*
* @param Account $account
* @param Carbon $start
* @param Carbon $end
@@ -145,7 +148,7 @@ class ReconcileController extends Controller
* @return mixed
*
* @throws FireflyException
* @throws \Throwable
*/
public function transactions(Account $account, Carbon $start, Carbon $end)
{
@@ -185,6 +188,8 @@ class ReconcileController extends Controller
}
/**
* Redirect to actual account.
*
* @param Account $account
*
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector

View File

@@ -37,11 +37,11 @@ use Illuminate\Http\Request;
*/
class RecurrenceController extends Controller
{
/** @var RecurringRepositoryInterface */
/** @var RecurringRepositoryInterface The recurring repository. */
private $recurring;
/**
*
* RecurrenceController constructor.
*/
public function __construct()
{
@@ -58,6 +58,8 @@ class RecurrenceController extends Controller
}
/**
* Shows all events for a repetition. Used in calendar.
*
* @param Request $request
*
* @throws FireflyException
@@ -139,6 +141,8 @@ class RecurrenceController extends Controller
}
/**
* Suggests repetition moments.
*
* @param Request $request
*
* @return JsonResponse