Add phpdocs everywhere.

This commit is contained in:
James Cole
2018-07-22 08:10:16 +02:00
parent 4a90ce35f2
commit 4d5bdd25a8
86 changed files with 661 additions and 80 deletions

View File

@@ -71,6 +71,7 @@ class ShowController extends Controller
); );
} }
/** @noinspection MoreThanThreeArgumentsInspection */
/** /**
* Show an account. * Show an account.
* *

View File

@@ -36,11 +36,11 @@ use Illuminate\Http\Response as LaravelResponse;
*/ */
class AttachmentController extends Controller class AttachmentController extends Controller
{ {
/** @var AttachmentRepositoryInterface */ /** @var AttachmentRepositoryInterface Attachment repository */
private $repository; private $repository;
/** /**
* * AttachmentController constructor.
*/ */
public function __construct() public function __construct()
{ {
@@ -59,6 +59,8 @@ class AttachmentController extends Controller
} }
/** /**
* Form to delete an attachment.
*
* @param Attachment $attachment * @param Attachment $attachment
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -74,6 +76,8 @@ class AttachmentController extends Controller
} }
/** /**
* Destroy attachment.
*
* @param Request $request * @param Request $request
* @param Attachment $attachment * @param Attachment $attachment
* *
@@ -92,6 +96,8 @@ class AttachmentController extends Controller
} }
/** /**
* Download attachment to PC.
*
* @param Attachment $attachment * @param Attachment $attachment
* *
* @return mixed * @return mixed
@@ -123,6 +129,8 @@ class AttachmentController extends Controller
} }
/** /**
* Edit an attachment.
*
* @param Request $request * @param Request $request
* @param Attachment $attachment * @param Attachment $attachment
* *
@@ -146,6 +154,8 @@ class AttachmentController extends Controller
} }
/** /**
* Index of all attachments.
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/ */
public function index() public function index()
@@ -164,6 +174,8 @@ class AttachmentController extends Controller
} }
/** /**
* Update attachment.
*
* @param AttachmentFormRequest $request * @param AttachmentFormRequest $request
* @param Attachment $attachment * @param Attachment $attachment
* *
@@ -191,6 +203,8 @@ class AttachmentController extends Controller
} }
/** /**
* View attachment in browser.
*
* @param Attachment $attachment * @param Attachment $attachment
* *
* @return LaravelResponse * @return LaravelResponse

View File

@@ -32,12 +32,13 @@ use Illuminate\Foundation\Auth\AuthenticatesUsers;
use Illuminate\Http\Request; use Illuminate\Http\Request;
/** /**
* @codeCoverageIgnore
* Class LoginController * Class LoginController
* *
* This controller handles authenticating users for the application and * This controller handles authenticating users for the application and
* redirecting them to your home screen. The controller uses a trait * redirecting them to your home screen. The controller uses a trait
* to conveniently provide its functionality to your applications. * to conveniently provide its functionality to your applications.
*
* @codeCoverageIgnore
*/ */
class LoginController extends Controller class LoginController extends Controller
{ {

View File

@@ -33,12 +33,13 @@ use Illuminate\Http\Request;
use Illuminate\Support\Facades\Validator; use Illuminate\Support\Facades\Validator;
/** /**
* @codeCoverageIgnore
* Class RegisterController * Class RegisterController
* *
* This controller handles the registration of new users as well as their * This controller handles the registration of new users as well as their
* validation and creation. By default this controller uses a trait to * validation and creation. By default this controller uses a trait to
* provide this functionality without requiring any additional code. * provide this functionality without requiring any additional code.
*
* @codeCoverageIgnore
*/ */
class RegisterController extends Controller class RegisterController extends Controller
{ {

View File

@@ -30,12 +30,13 @@ use Illuminate\Foundation\Auth\ResetsPasswords;
use Illuminate\Http\Request; use Illuminate\Http\Request;
/** /**
* @codeCoverageIgnore
* Class ResetPasswordController * Class ResetPasswordController
* *
* This controller is responsible for handling password reset requests * This controller is responsible for handling password reset requests
* and uses a simple trait to include this behavior. You're free to * and uses a simple trait to include this behavior. You're free to
* explore this trait and override any methods you wish to tweak. * explore this trait and override any methods you wish to tweak.
*
* @codeCoverageIgnore
*/ */
class ResetPasswordController extends Controller class ResetPasswordController extends Controller
{ {

View File

@@ -54,7 +54,7 @@ class BillController extends Controller
private $ruleGroupRepos; private $ruleGroupRepos;
/** /**
* * BillController constructor.
*/ */
public function __construct() public function __construct()
{ {
@@ -79,6 +79,8 @@ class BillController extends Controller
} }
/** /**
* Create a new bill.
*
* @param Request $request * @param Request $request
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -104,6 +106,8 @@ class BillController extends Controller
} }
/** /**
* Delete a bill.
*
* @param Bill $bill * @param Bill $bill
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -118,6 +122,8 @@ class BillController extends Controller
} }
/** /**
* Destroy a bill.
*
* @param Request $request * @param Request $request
* @param Bill $bill * @param Bill $bill
* *
@@ -135,6 +141,8 @@ class BillController extends Controller
} }
/** /**
* Edit a bill.
*
* @param Request $request * @param Request $request
* @param Bill $bill * @param Bill $bill
* *
@@ -178,6 +186,8 @@ class BillController extends Controller
} }
/** /**
* Show all bills.
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/ */
public function index() public function index()
@@ -218,6 +228,8 @@ class BillController extends Controller
} }
/** /**
* Rescan bills for transactions.
*
* @param Request $request * @param Request $request
* @param Bill $bill * @param Bill $bill
* *
@@ -253,6 +265,8 @@ class BillController extends Controller
} }
/** /**
* Show a bill.
*
* @param Request $request * @param Request $request
* @param Bill $bill * @param Bill $bill
* *
@@ -295,6 +309,8 @@ class BillController extends Controller
/** /**
* Store a new bill.
*
* @param BillFormRequest $request * @param BillFormRequest $request
* *
* @return RedirectResponse * @return RedirectResponse
@@ -350,6 +366,8 @@ class BillController extends Controller
} }
/** /**
* Update a bill.
*
* @param BillFormRequest $request * @param BillFormRequest $request
* @param Bill $bill * @param Bill $bill
* *

View File

@@ -127,7 +127,7 @@ class ShowController extends Controller
$transactions = $collector->getPaginatedJournals(); $transactions = $collector->getPaginatedJournals();
$transactions->setPath(route('budgets.no-budget')); $transactions->setPath(route('budgets.no-budget'));
return view('budgets.no-budget', compact('transactions', 'subTitle', 'moment', 'periods', 'start', 'end')); return view('budgets.no-budget', compact('transactions', 'subTitle', 'moment', 'start', 'end'));
} }

View File

@@ -45,8 +45,6 @@ class NoCategoryController extends Controller
/** @var JournalRepositoryInterface Journals and transactions overview */ /** @var JournalRepositoryInterface Journals and transactions overview */
private $journalRepos; private $journalRepos;
/** @var CategoryRepositoryInterface The category repository */
private $repository;
/** /**
* CategoryController constructor. * CategoryController constructor.
@@ -60,7 +58,6 @@ class NoCategoryController extends Controller
app('view')->share('title', (string)trans('firefly.categories')); app('view')->share('title', (string)trans('firefly.categories'));
app('view')->share('mainTitleIcon', 'fa-bar-chart'); app('view')->share('mainTitleIcon', 'fa-bar-chart');
$this->journalRepos = app(JournalRepositoryInterface::class); $this->journalRepos = app(JournalRepositoryInterface::class);
$this->repository = app(CategoryRepositoryInterface::class);
return $next($request); return $next($request);
} }
@@ -71,7 +68,8 @@ class NoCategoryController extends Controller
* Show transactions without a category. * Show transactions without a category.
* *
* @param Request $request * @param Request $request
* @param string|null $moment * @param Carbon|null $start
* @param Carbon|null $end
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/ */
@@ -107,6 +105,8 @@ class NoCategoryController extends Controller
/** /**
* Show all transactions without a category.
*
* @param Request $request * @param Request $request
* @param string|null $moment * @param string|null $moment
* *
@@ -142,6 +142,8 @@ class NoCategoryController extends Controller
/** /**
* Show period overview for no category view.
*
* @param Carbon $theDate * @param Carbon $theDate
* *
* @return Collection * @return Collection

View File

@@ -56,6 +56,8 @@ class CategoryController extends Controller
} }
/** /**
* Create category.
*
* @param Request $request * @param Request $request
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -72,6 +74,8 @@ class CategoryController extends Controller
} }
/** /**
* Delete a category.
*
* @param Category $category * @param Category $category
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -87,6 +91,8 @@ class CategoryController extends Controller
} }
/** /**
* Destroy a category.
*
* @param Request $request * @param Request $request
* @param Category $category * @param Category $category
* *
@@ -104,6 +110,8 @@ class CategoryController extends Controller
} }
/** /**
* Edit a category.
*
* @param Request $request * @param Request $request
* @param Category $category * @param Category $category
* *
@@ -123,6 +131,8 @@ class CategoryController extends Controller
} }
/** /**
* Show all categories.
*
* @param Request $request * @param Request $request
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -150,6 +160,8 @@ class CategoryController extends Controller
/** /**
* Store new category.
*
* @param CategoryFormRequest $request * @param CategoryFormRequest $request
* @param CategoryRepositoryInterface $repository * @param CategoryRepositoryInterface $repository
* *
@@ -177,6 +189,8 @@ class CategoryController extends Controller
/** /**
* Update category.
*
* @param CategoryFormRequest $request * @param CategoryFormRequest $request
* @param CategoryRepositoryInterface $repository * @param CategoryRepositoryInterface $repository
* @param Category $category * @param Category $category

View File

@@ -49,7 +49,7 @@ class ExpenseReportController extends Controller
protected $generator; protected $generator;
/** /**
* * ExpenseReportController constructor.
*/ */
public function __construct() public function __construct()
{ {

View File

@@ -147,9 +147,9 @@ class ReportController extends Controller
/** /**
* Shows sum income and expense, debit/credit: operations. * Shows sum income and expense, debit/credit: operations.
* *
* @param Collection $accounts
* @param Carbon $start * @param Carbon $start
* @param Carbon $end * @param Carbon $end
* @param Collection $accounts
* *
* @return \Illuminate\Http\JsonResponse * @return \Illuminate\Http\JsonResponse
* *

View File

@@ -44,13 +44,13 @@ class Controller extends BaseController
{ {
use AuthorizesRequests, DispatchesJobs, ValidatesRequests; use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
/** @var string */ /** @var string Format for date and time. */
protected $dateTimeFormat; protected $dateTimeFormat;
/** @var string */ /** @var string Format for "23 Feb, 2016". */
protected $monthAndDayFormat; protected $monthAndDayFormat;
/** @var string */ /** @var string Format for "March 2018" */
protected $monthFormat; protected $monthFormat;
/** @var string */ /** @var string Redirect user */
protected $redirectUri = '/'; protected $redirectUri = '/';
/** /**
@@ -119,6 +119,10 @@ class Controller extends BaseController
} }
/** /**
* Is transaction opening balance?
*
* TODO move to trait.
*
* @param TransactionJournal $journal * @param TransactionJournal $journal
* *
* @return bool * @return bool
@@ -130,6 +134,10 @@ class Controller extends BaseController
/** /**
* Redirect to asset account that transaction belongs to.
*
* TODO move to trait.
*
* @param TransactionJournal $journal * @param TransactionJournal $journal
* *
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
@@ -153,6 +161,8 @@ class Controller extends BaseController
} }
/** /**
* Remember previous URL.
*
* @param string $identifier * @param string $identifier
*/ */
protected function rememberPreviousUri(string $identifier): void protected function rememberPreviousUri(string $identifier): void
@@ -161,6 +171,10 @@ class Controller extends BaseController
} }
/** /**
* Get user's language.
*
* TODO pretty sure nobody uses this.
*
* @return string * @return string
*/ */
private function getLanguage(): string private function getLanguage(): string
@@ -180,6 +194,10 @@ class Controller extends BaseController
} }
/** /**
* Get the specific name of a page for intro.
*
* TODO move to trait.
*
* @return string * @return string
*/ */
private function getSpecificPageName(): string private function getSpecificPageName(): string
@@ -188,6 +206,10 @@ class Controller extends BaseController
} }
/** /**
* Returns if user has seen demo.
*
* TODO move to trait.
*
* @return bool * @return bool
*/ */
private function hasSeenDemo(): bool private function hasSeenDemo(): bool

View File

@@ -41,11 +41,11 @@ class CurrencyController extends Controller
/** @var CurrencyRepositoryInterface The currency repository */ /** @var CurrencyRepositoryInterface The currency repository */
protected $repository; protected $repository;
/** @var UserRepositoryInterface */ /** @var UserRepositoryInterface The user repository */
protected $userRepository; protected $userRepository;
/** /**
* * CurrencyController constructor.
*/ */
public function __construct() public function __construct()
{ {
@@ -65,6 +65,8 @@ class CurrencyController extends Controller
/** /**
* Create a currency.
*
* @param Request $request * @param Request $request
* *
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector|View * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector|View
@@ -92,6 +94,8 @@ class CurrencyController extends Controller
} }
/** /**
* Make currency the default currency.
*
* @param Request $request * @param Request $request
* @param TransactionCurrency $currency * @param TransactionCurrency $currency
* *
@@ -103,7 +107,7 @@ class CurrencyController extends Controller
app('preferences')->mark(); app('preferences')->mark();
$request->session()->flash('success', (string)trans('firefly.new_default_currency', ['name' => $currency->name])); $request->session()->flash('success', (string)trans('firefly.new_default_currency', ['name' => $currency->name]));
Cache::forget('FFCURRENCYSYMBOL'); Cache::forget('FFCURRENCYSYMBOL'); // todo are these even used?
Cache::forget('FFCURRENCYCODE'); Cache::forget('FFCURRENCYCODE');
return redirect(route('currencies.index')); return redirect(route('currencies.index'));
@@ -111,6 +115,8 @@ class CurrencyController extends Controller
/** /**
* Deletes a currency.
*
* @param Request $request * @param Request $request
* @param TransactionCurrency $currency * @param TransactionCurrency $currency
* *
@@ -143,6 +149,8 @@ class CurrencyController extends Controller
/** /**
* Destroys a currency.
*
* @param Request $request * @param Request $request
* @param TransactionCurrency $currency * @param TransactionCurrency $currency
* *
@@ -174,6 +182,8 @@ class CurrencyController extends Controller
/** /**
* Edit a currency.
*
* @param Request $request * @param Request $request
* @param TransactionCurrency $currency * @param TransactionCurrency $currency
* *
@@ -205,6 +215,8 @@ class CurrencyController extends Controller
} }
/** /**
* Show overview of currencies.
*
* @param Request $request * @param Request $request
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -238,6 +250,8 @@ class CurrencyController extends Controller
/** /**
* Store new currency.
*
* @param CurrencyFormRequest $request * @param CurrencyFormRequest $request
* *
* @return $this|\Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector * @return $this|\Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
@@ -279,6 +293,8 @@ class CurrencyController extends Controller
/** /**
* Updates a currency.
*
* @param CurrencyFormRequest $request * @param CurrencyFormRequest $request
* @param TransactionCurrency $currency * @param TransactionCurrency $currency
* *

View File

@@ -52,6 +52,8 @@ class DebugController extends Controller
} }
/** /**
* Show all possible errors.
*
* @throws FireflyException * @throws FireflyException
*/ */
public function displayError(): void public function displayError(): void
@@ -68,6 +70,8 @@ class DebugController extends Controller
} }
/** /**
* Clear log and session.
*
* @param Request $request * @param Request $request
* *
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
@@ -99,6 +103,8 @@ class DebugController extends Controller
} }
/** /**
* Show debug info.
*
* @param Request $request * @param Request $request
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -176,6 +182,8 @@ class DebugController extends Controller
} }
/** /**
* Return all possible routes.
*
* @return string * @return string
* *
* @SuppressWarnings(PHPMD.CyclomaticComplexity) * @SuppressWarnings(PHPMD.CyclomaticComplexity)
@@ -217,6 +225,8 @@ class DebugController extends Controller
} }
/** /**
* Flash all types of messages.
*
* @param Request $request * @param Request $request
* *
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
@@ -258,6 +268,8 @@ class DebugController extends Controller
} }
/** /**
* All packages that are installed.
*
* @return array * @return array
*/ */
private function collectPackages(): array private function collectPackages(): array

View File

@@ -39,7 +39,7 @@ use Illuminate\Http\Response as LaravelResponse;
class ExportController extends Controller class ExportController extends Controller
{ {
/** /**
* * ExportController constructor.
*/ */
public function __construct() public function __construct()
{ {
@@ -57,6 +57,8 @@ class ExportController extends Controller
} }
/** /**
* Download exported file.
*
* @param ExportJobRepositoryInterface $repository * @param ExportJobRepositoryInterface $repository
* @param ExportJob $job * @param ExportJob $job
* *
@@ -94,6 +96,8 @@ class ExportController extends Controller
} }
/** /**
* Get current export status.
*
* @param ExportJob $job * @param ExportJob $job
* *
* @return \Illuminate\Http\JsonResponse * @return \Illuminate\Http\JsonResponse
@@ -104,6 +108,8 @@ class ExportController extends Controller
} }
/** /**
* Index of export routine.
*
* @param ExportJobRepositoryInterface $jobs * @param ExportJobRepositoryInterface $jobs
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -125,6 +131,8 @@ class ExportController extends Controller
} }
/** /**
* Submit the job.
*
* @param ExportFormRequest $request * @param ExportFormRequest $request
* @param AccountRepositoryInterface $repository * @param AccountRepositoryInterface $repository
* @param ExportJobRepositoryInterface $jobs * @param ExportJobRepositoryInterface $jobs

View File

@@ -31,7 +31,7 @@ use Log;
*/ */
class HelpController extends Controller class HelpController extends Controller
{ {
/** @var HelpInterface */ /** @var HelpInterface Help interface. */
private $help; private $help;
/** /**
@@ -51,6 +51,8 @@ class HelpController extends Controller
} }
/** /**
* Show help for a route.
*
* @param $route * @param $route
* *
* @return JsonResponse * @return JsonResponse
@@ -64,6 +66,10 @@ class HelpController extends Controller
} }
/** /**
* Gets the help text.
*
* TODO move to repos or trait.
*
* @param string $route * @param string $route
* @param string $language * @param string $language
* *

View File

@@ -52,6 +52,8 @@ class HomeController extends Controller
} }
/** /**
* Change index date range.
*
* @param Request $request * @param Request $request
* *
* @return JsonResponse * @return JsonResponse
@@ -90,6 +92,8 @@ class HomeController extends Controller
/** /**
* Show index.
*
* @param AccountRepositoryInterface $repository * @param AccountRepositoryInterface $repository
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector|\Illuminate\View\View

View File

@@ -41,7 +41,7 @@ class IndexController extends Controller
public $providers; public $providers;
/** @var ImportJobRepositoryInterface The import job repository */ /** @var ImportJobRepositoryInterface The import job repository */
public $repository; public $repository;
/** @var UserRepositoryInterface */ /** @var UserRepositoryInterface The user repository */
public $userRepository; public $userRepository;
/** /**

View File

@@ -38,6 +38,8 @@ use Log;
class JavascriptController extends Controller class JavascriptController extends Controller
{ {
/** /**
* Show info about accounts.
*
* @param AccountRepositoryInterface $repository * @param AccountRepositoryInterface $repository
* @param CurrencyRepositoryInterface $currencyRepository * @param CurrencyRepositoryInterface $currencyRepository
* *
@@ -68,6 +70,8 @@ class JavascriptController extends Controller
} }
/** /**
* Get info about currencies.
*
* @param CurrencyRepositoryInterface $repository * @param CurrencyRepositoryInterface $repository
* *
* @return Response * @return Response
@@ -89,6 +93,8 @@ class JavascriptController extends Controller
} }
/** /**
* Show some common variables to be used in scripts.
*
* @param Request $request * @param Request $request
* @param AccountRepositoryInterface $repository * @param AccountRepositoryInterface $repository
* @param CurrencyRepositoryInterface $currencyRepository * @param CurrencyRepositoryInterface $currencyRepository
@@ -135,6 +141,8 @@ class JavascriptController extends Controller
} }
/** /**
* Get config for date range.
*
* @return array * @return array
* @SuppressWarnings(PHPMD.ExcessiveMethodLength) * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
*/ */

View File

@@ -88,13 +88,13 @@ class RecurrenceController extends Controller
// if $firstDate is beyond start, use that one: // if $firstDate is beyond start, use that one:
$actualStart = clone $firstDate; $actualStart = clone $firstDate;
if ($repetitionType === 'weekly' || $repetitionType === 'monthly') { if ('weekly' === $repetitionType || 'monthly' === $repetitionType) {
$repetitionMoment = explode(',', $request->get('type'))[1] ?? '1'; $repetitionMoment = explode(',', $request->get('type'))[1] ?? '1';
} }
if ($repetitionType === 'ndom') { if ('ndom' === $repetitionType) {
$repetitionMoment = str_ireplace('ndom,', '', $request->get('type')); $repetitionMoment = str_ireplace('ndom,', '', $request->get('type'));
} }
if ($repetitionType === 'yearly') { if ('yearly' === $repetitionType) {
$repetitionMoment = explode(',', $request->get('type'))[1] ?? '2018-01-01'; $repetitionMoment = explode(',', $request->get('type'))[1] ?? '2018-01-01';
} }
$repetition = new RecurrenceRepetition; $repetition = new RecurrenceRepetition;

View File

@@ -31,10 +31,12 @@ use Illuminate\Http\Request;
class JsonController extends Controller class JsonController extends Controller
{ {
/** /**
* Render HTML form for rule action.
*
* @param Request $request * @param Request $request
* *
* @return JsonResponse * @return JsonResponse
* @throws \Throwable
*/ */
public function action(Request $request): JsonResponse public function action(Request $request): JsonResponse
{ {
@@ -50,10 +52,12 @@ class JsonController extends Controller
} }
/** /**
* Render HTML for rule trigger.
*
* @param Request $request * @param Request $request
* *
* @return JsonResponse * @return JsonResponse
* @throws \Throwable
*/ */
public function trigger(Request $request): JsonResponse public function trigger(Request $request): JsonResponse
{ {

View File

@@ -54,6 +54,8 @@ class NewUserController extends Controller
} }
/** /**
* Form the user gets when he has no data in the system.
*
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector|View * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector|View
*/ */
public function index() public function index()
@@ -74,6 +76,8 @@ class NewUserController extends Controller
} }
/** /**
* Store his new settings.
*
* @param NewUserFormRequest $request * @param NewUserFormRequest $request
* @param CurrencyRepositoryInterface $currencyRepository * @param CurrencyRepositoryInterface $currencyRepository
* *
@@ -117,6 +121,8 @@ class NewUserController extends Controller
} }
/** /**
* Creates an asset account.
*
* @param NewUserFormRequest $request * @param NewUserFormRequest $request
* @param TransactionCurrency $currency * @param TransactionCurrency $currency
* *
@@ -143,6 +149,8 @@ class NewUserController extends Controller
} }
/** /**
* Creates a cash wallet.
*
* @param TransactionCurrency $currency * @param TransactionCurrency $currency
* @param string $language * @param string $language
* *
@@ -169,6 +177,8 @@ class NewUserController extends Controller
} }
/** /**
* Create a savings account.
*
* @param NewUserFormRequest $request * @param NewUserFormRequest $request
* @param TransactionCurrency $currency * @param TransactionCurrency $currency
* @param string $language * @param string $language

View File

@@ -51,11 +51,11 @@ class PiggyBankController extends Controller
private $accountRepos; private $accountRepos;
/** @var CurrencyRepositoryInterface The currency repository */ /** @var CurrencyRepositoryInterface The currency repository */
private $currencyRepos; private $currencyRepos;
/** @var PiggyBankRepositoryInterface */ /** @var PiggyBankRepositoryInterface Piggy bank repository. */
private $piggyRepos; private $piggyRepos;
/** /**
* * PiggyBankController constructor.
*/ */
public function __construct() public function __construct()
{ {
@@ -128,6 +128,8 @@ class PiggyBankController extends Controller
} }
/** /**
* Create a piggy bank.
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/ */
public function create() public function create()
@@ -145,6 +147,8 @@ class PiggyBankController extends Controller
} }
/** /**
* Delete a piggy bank.
*
* @param PiggyBank $piggyBank * @param PiggyBank $piggyBank
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -160,6 +164,8 @@ class PiggyBankController extends Controller
} }
/** /**
* Destroy the piggy bank.
*
* @param PiggyBank $piggyBank * @param PiggyBank $piggyBank
* *
* @return RedirectResponse * @return RedirectResponse
@@ -174,6 +180,8 @@ class PiggyBankController extends Controller
} }
/** /**
* Edit a piggy bank.
*
* @param PiggyBank $piggyBank * @param PiggyBank $piggyBank
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -214,6 +222,8 @@ class PiggyBankController extends Controller
} }
/** /**
* Show overview of all piggy banks.
*
* @param Request $request * @param Request $request
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -270,6 +280,8 @@ class PiggyBankController extends Controller
} }
/** /**
* Add money to piggy bank.
*
* @param Request $request * @param Request $request
* @param PiggyBank $piggyBank * @param PiggyBank $piggyBank
* *
@@ -310,6 +322,8 @@ class PiggyBankController extends Controller
} }
/** /**
* Remove money from piggy bank.
*
* @param Request $request * @param Request $request
* @param PiggyBank $piggyBank * @param PiggyBank $piggyBank
* *
@@ -351,6 +365,8 @@ class PiggyBankController extends Controller
} }
/** /**
* Remove money from piggy bank form.
*
* @param PiggyBank $piggyBank * @param PiggyBank $piggyBank
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -390,6 +406,8 @@ class PiggyBankController extends Controller
} }
/** /**
* Set the order of a piggy bank.
*
* @param Request $request * @param Request $request
* @param PiggyBank $piggyBank * @param PiggyBank $piggyBank
* *
@@ -404,6 +422,8 @@ class PiggyBankController extends Controller
} }
/** /**
* Show a single piggy bank.
*
* @param PiggyBank $piggyBank * @param PiggyBank $piggyBank
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -424,6 +444,8 @@ class PiggyBankController extends Controller
} }
/** /**
* Store a new piggy bank.
*
* @param PiggyBankFormRequest $request * @param PiggyBankFormRequest $request
* *
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
@@ -453,6 +475,8 @@ class PiggyBankController extends Controller
} }
/** /**
* Update a piggy bank.
*
* @param PiggyBankFormRequest $request * @param PiggyBankFormRequest $request
* @param PiggyBank $piggyBank * @param PiggyBank $piggyBank
* *

View File

@@ -32,7 +32,7 @@ use Illuminate\Http\Request;
class PreferencesController extends Controller class PreferencesController extends Controller
{ {
/** /**
* * PreferencesController constructor.
*/ */
public function __construct() public function __construct()
{ {
@@ -49,6 +49,8 @@ class PreferencesController extends Controller
} }
/** /**
* Show overview of preferences.
*
* @param AccountRepositoryInterface $repository * @param AccountRepositoryInterface $repository
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -83,6 +85,8 @@ class PreferencesController extends Controller
} }
/** /**
* Store new preferences.
*
* @param Request $request * @param Request $request
* *
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector

View File

@@ -74,6 +74,8 @@ class ProfileController extends Controller
} }
/** /**
* Change your email address.
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/ */
public function changeEmail() public function changeEmail()
@@ -87,6 +89,8 @@ class ProfileController extends Controller
} }
/** /**
* Change your password.
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/ */
public function changePassword() public function changePassword()
@@ -115,6 +119,8 @@ class ProfileController extends Controller
} }
/** /**
* Screen to confirm email change.
*
* @param UserRepositoryInterface $repository * @param UserRepositoryInterface $repository
* @param string $token * @param string $token
* *
@@ -151,6 +157,8 @@ class ProfileController extends Controller
} }
/** /**
* Delete your account view.
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/ */
public function deleteAccount() public function deleteAccount()
@@ -163,6 +171,8 @@ class ProfileController extends Controller
} }
/** /**
* Delete 2FA routine.
*
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
*/ */
public function deleteCode() public function deleteCode()
@@ -176,6 +186,8 @@ class ProfileController extends Controller
} }
/** /**
* Enable 2FA screen.
*
* @param UserRepositoryInterface $repository * @param UserRepositoryInterface $repository
* *
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
@@ -203,6 +215,8 @@ class ProfileController extends Controller
} }
/** /**
* Index for profile.
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/ */
public function index() public function index()
@@ -236,6 +250,8 @@ class ProfileController extends Controller
} }
/** /**
* Submit the change email form.
*
* @param EmailFormRequest $request * @param EmailFormRequest $request
* @param UserRepositoryInterface $repository * @param UserRepositoryInterface $repository
* *
@@ -279,6 +295,8 @@ class ProfileController extends Controller
} }
/** /**
* Submit change password form.
*
* @param ProfileFormRequest $request * @param ProfileFormRequest $request
* @param UserRepositoryInterface $repository * @param UserRepositoryInterface $repository
* *
@@ -307,6 +325,8 @@ class ProfileController extends Controller
/** @noinspection PhpUnusedParameterInspection */ /** @noinspection PhpUnusedParameterInspection */
/** /**
* Submit 2FA for the first time.
*
* @param TokenFormRequest $request * @param TokenFormRequest $request
* *
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
@@ -324,6 +344,8 @@ class ProfileController extends Controller
} }
/** /**
* Submit delete account.
*
* @param UserRepositoryInterface $repository * @param UserRepositoryInterface $repository
* @param DeleteAccountFormRequest $request * @param DeleteAccountFormRequest $request
* *
@@ -348,6 +370,7 @@ class ProfileController extends Controller
} }
/** /**
* Regenerate access token.
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
*/ */
public function regenerate() public function regenerate()
@@ -362,6 +385,8 @@ class ProfileController extends Controller
} }
/** /**
* Undo change of user email address.
*
* @param UserRepositoryInterface $repository * @param UserRepositoryInterface $repository
* @param string $token * @param string $token
* @param string $hash * @param string $hash
@@ -413,6 +438,8 @@ class ProfileController extends Controller
} }
/** /**
* Validate users new password.
*
* @param User $user * @param User $user
* @param string $current * @param string $current
* @param string $new * @param string $new
@@ -435,7 +462,7 @@ class ProfileController extends Controller
} }
/** /**
* * Create new RSA keys.
*/ */
private function createOAuthKeys(): void private function createOAuthKeys(): void
{ {
@@ -459,6 +486,8 @@ class ProfileController extends Controller
// @codeCoverageIgnoreEnd // @codeCoverageIgnoreEnd
/** /**
* Get the domain of FF system.
*
* @return string * @return string
*/ */
private function getDomain(): string private function getDomain(): string

View File

@@ -39,18 +39,19 @@ use Log;
/** /**
* Class ReportController. * Class ReportController.
*
* @SuppressWarnings(PHPMD.CouplingBetweenObjects) * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/ */
class ReportController extends Controller class ReportController extends Controller
{ {
/** @var ReportHelperInterface */ /** @var ReportHelperInterface Helper interface. */
protected $helper; protected $helper;
/** @var BudgetRepositoryInterface The budget repository */ /** @var BudgetRepositoryInterface The budget repository */
private $repository; private $repository;
/** /**
* * ReportController constructor.
*/ */
public function __construct() public function __construct()
{ {
@@ -70,6 +71,8 @@ class ReportController extends Controller
} }
/** @noinspection MoreThanThreeArgumentsInspection */ /** @noinspection MoreThanThreeArgumentsInspection */
/** /**
* Show account report.
*
* @param Collection $accounts * @param Collection $accounts
* @param Collection $expense * @param Collection $expense
* @param Carbon $start * @param Carbon $start
@@ -101,6 +104,8 @@ class ReportController extends Controller
} }
/** /**
* Show audit report.
*
* @param Collection $accounts * @param Collection $accounts
* @param Carbon $start * @param Carbon $start
* @param Carbon $end * @param Carbon $end
@@ -135,6 +140,8 @@ class ReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */ /** @noinspection MoreThanThreeArgumentsInspection */
/** /**
* Show budget report.
*
* @param Collection $accounts * @param Collection $accounts
* @param Collection $budgets * @param Collection $budgets
* @param Carbon $start * @param Carbon $start
@@ -171,6 +178,8 @@ class ReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */ /** @noinspection MoreThanThreeArgumentsInspection */
/** /**
* Show category report.
*
* @param Collection $accounts * @param Collection $accounts
* @param Collection $categories * @param Collection $categories
* @param Carbon $start * @param Carbon $start
@@ -206,6 +215,8 @@ class ReportController extends Controller
} }
/** /**
* Show default report.
*
* @param Collection $accounts * @param Collection $accounts
* @param Carbon $start * @param Carbon $start
* @param Carbon $end * @param Carbon $end
@@ -240,6 +251,8 @@ class ReportController extends Controller
} }
/** /**
* Show index.
*
* @param AccountRepositoryInterface $repository * @param AccountRepositoryInterface $repository
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -258,10 +271,13 @@ class ReportController extends Controller
} }
/** /**
* Show options for reports.
*
* @param string $reportType * @param string $reportType
* *
* @return mixed * @return mixed
* @SuppressWarnings(PHPMD.CyclomaticComplexity) * @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @throws \Throwable
*/ */
public function options(string $reportType) public function options(string $reportType)
{ {
@@ -287,6 +303,8 @@ class ReportController extends Controller
} }
/** /**
* Process the submit of report.
*
* @param ReportFormRequest $request * @param ReportFormRequest $request
* *
* @return RedirectResponse|\Illuminate\Routing\Redirector * @return RedirectResponse|\Illuminate\Routing\Redirector
@@ -365,6 +383,8 @@ class ReportController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */ /** @noinspection MoreThanThreeArgumentsInspection */
/** /**
* Get a tag report.
*
* @param Collection $accounts * @param Collection $accounts
* @param Collection $tags * @param Collection $tags
* @param Carbon $start * @param Carbon $start
@@ -400,7 +420,10 @@ class ReportController extends Controller
} }
/** /**
* Get options for account report.
*
* @return string * @return string
* @throws \Throwable
*/ */
private function accountReportOptions(): string private function accountReportOptions(): string
{ {
@@ -420,7 +443,9 @@ class ReportController extends Controller
} }
/** /**
* Get options for budget report.
* @return string * @return string
* @throws \Throwable
*/ */
private function budgetReportOptions(): string private function budgetReportOptions(): string
{ {
@@ -432,7 +457,9 @@ class ReportController extends Controller
} }
/** /**
* Get options for category report.
* @return string * @return string
* @throws \Throwable
*/ */
private function categoryReportOptions(): string private function categoryReportOptions(): string
{ {
@@ -444,7 +471,9 @@ class ReportController extends Controller
} }
/** /**
* Get options for default report.
* @return string * @return string
* @throws \Throwable
*/ */
private function noReportOptions(): string private function noReportOptions(): string
{ {
@@ -452,7 +481,9 @@ class ReportController extends Controller
} }
/** /**
* Get options for tag report.
* @return string * @return string
* @throws \Throwable
*/ */
private function tagReportOptions(): string private function tagReportOptions(): string
{ {

View File

@@ -30,7 +30,7 @@ use FireflyIII\Models\Bill;
use FireflyIII\Models\RuleGroup; use FireflyIII\Models\RuleGroup;
use FireflyIII\Repositories\Bill\BillRepositoryInterface; use FireflyIII\Repositories\Bill\BillRepositoryInterface;
use FireflyIII\Repositories\Rule\RuleRepositoryInterface; use FireflyIII\Repositories\Rule\RuleRepositoryInterface;
use FireflyIII\Repositories\RuleGroup\RuleGroupRepositoryInterface;
use FireflyIII\Support\Http\Controllers\RuleManagement; use FireflyIII\Support\Http\Controllers\RuleManagement;
use Illuminate\Http\RedirectResponse; use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request; use Illuminate\Http\Request;
@@ -188,7 +188,6 @@ class CreateController extends Controller
*/ */
private function getActionsForBill(Bill $bill): array private function getActionsForBill(Bill $bill): array
{ {
$result = '';
try { try {
$result = view( $result = view(
'rules.partials.action', 'rules.partials.action',

View File

@@ -42,7 +42,8 @@ use Log;
use Throwable; use Throwable;
/** /**
* Class SelectController * Class SelectController.
*
* @SuppressWarnings(PHPMD.CouplingBetweenObjects) * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/ */
class SelectController extends Controller class SelectController extends Controller
@@ -107,6 +108,8 @@ class SelectController extends Controller
/** /**
* View to select transactions by a rule.
*
* @param Rule $rule * @param Rule $rule
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -255,6 +258,8 @@ class SelectController extends Controller
/** /**
* Get a list of triggers.
*
* @param TestRuleFormRequest $request * @param TestRuleFormRequest $request
* *
* @return array * @return array

View File

@@ -58,6 +58,8 @@ class RuleGroupController extends Controller
} }
/** /**
* Create a new rule group.
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/ */
public function create() public function create()
@@ -75,6 +77,8 @@ class RuleGroupController extends Controller
} }
/** /**
* Delege a rule group.
*
* @param RuleGroup $ruleGroup * @param RuleGroup $ruleGroup
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -90,6 +94,8 @@ class RuleGroupController extends Controller
} }
/** /**
* Actually destroy the rule group.
*
* @param Request $request * @param Request $request
* @param RuleGroupRepositoryInterface $repository * @param RuleGroupRepositoryInterface $repository
* @param RuleGroup $ruleGroup * @param RuleGroup $ruleGroup
@@ -114,6 +120,8 @@ class RuleGroupController extends Controller
} }
/** /**
* Move a rule group down.
*
* @param RuleGroupRepositoryInterface $repository * @param RuleGroupRepositoryInterface $repository
* @param RuleGroup $ruleGroup * @param RuleGroup $ruleGroup
* *
@@ -127,6 +135,8 @@ class RuleGroupController extends Controller
} }
/** /**
* Edit a rule group.
*
* @param Request $request * @param Request $request
* @param RuleGroup $ruleGroup * @param RuleGroup $ruleGroup
* *
@@ -189,6 +199,8 @@ class RuleGroupController extends Controller
} }
/** /**
* Select transactions to apply the group on.
*
* @param RuleGroup $ruleGroup * @param RuleGroup $ruleGroup
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -203,6 +215,8 @@ class RuleGroupController extends Controller
} }
/** /**
* Store the rule group.
*
* @param RuleGroupFormRequest $request * @param RuleGroupFormRequest $request
* @param RuleGroupRepositoryInterface $repository * @param RuleGroupRepositoryInterface $repository
* *
@@ -229,6 +243,8 @@ class RuleGroupController extends Controller
} }
/** /**
* Move the rule group up.
*
* @param RuleGroupRepositoryInterface $repository * @param RuleGroupRepositoryInterface $repository
* @param RuleGroup $ruleGroup * @param RuleGroup $ruleGroup
* *
@@ -244,6 +260,8 @@ class RuleGroupController extends Controller
} }
/** /**
* Update the rule group.
*
* @param RuleGroupFormRequest $request * @param RuleGroupFormRequest $request
* @param RuleGroupRepositoryInterface $repository * @param RuleGroupRepositoryInterface $repository
* @param RuleGroup $ruleGroup * @param RuleGroup $ruleGroup

View File

@@ -51,6 +51,8 @@ class SearchController extends Controller
} }
/** /**
* Do the search.
*
* @param Request $request * @param Request $request
* @param SearchInterface $searcher * @param SearchInterface $searcher
* *
@@ -69,11 +71,13 @@ class SearchController extends Controller
} }
/** /**
* JSON request that does the work.
*
* @param Request $request * @param Request $request
* @param SearchInterface $searcher * @param SearchInterface $searcher
* *
* @return \Illuminate\Http\JsonResponse * @return \Illuminate\Http\JsonResponse
* @throws \Throwable
*/ */
public function search(Request $request, SearchInterface $searcher): JsonResponse public function search(Request $request, SearchInterface $searcher): JsonResponse
{ {

View File

@@ -33,16 +33,16 @@ use Log;
use phpseclib\Crypt\RSA; use phpseclib\Crypt\RSA;
/** /**
* @codeCoverageIgnore
* Class InstallController * Class InstallController
* @codeCoverageIgnore
*/ */
class InstallController extends Controller class InstallController extends Controller
{ {
/** @var string */ /** @var string Forbidden error */
public const FORBIDDEN_ERROR = 'Internal PHP function "proc_close" is disabled for your installation. Auto-migration is not possible.'; public const FORBIDDEN_ERROR = 'Internal PHP function "proc_close" is disabled for your installation. Auto-migration is not possible.';
/** @var string */ /** @var string Basedir error */
public const BASEDIR_ERROR = 'Firefly III cannot execute the upgrade commands. It is not allowed to because of an open_basedir restriction.'; public const BASEDIR_ERROR = 'Firefly III cannot execute the upgrade commands. It is not allowed to because of an open_basedir restriction.';
/** @var string */ /** @var string Other errors */
public const OTHER_ERROR = 'An unknown error prevented Firefly III from executing the upgrade commands. Sorry.'; public const OTHER_ERROR = 'An unknown error prevented Firefly III from executing the upgrade commands. Sorry.';
/** @noinspection MagicMethodsValidityInspection */ /** @noinspection MagicMethodsValidityInspection */
/** @noinspection PhpMissingParentConstructorInspection */ /** @noinspection PhpMissingParentConstructorInspection */
@@ -55,6 +55,8 @@ class InstallController extends Controller
} }
/** /**
* Show index.
*
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
*/ */
public function index() public function index()
@@ -63,6 +65,8 @@ class InstallController extends Controller
} }
/** /**
* Create specific RSA keys.
*
* @return \Illuminate\Http\JsonResponse|\Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector * @return \Illuminate\Http\JsonResponse|\Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
*/ */
public function keys() public function keys()
@@ -91,6 +95,8 @@ class InstallController extends Controller
} }
/** /**
* Run migration commands.
*
* @return JsonResponse * @return JsonResponse
*/ */
public function migrate(): JsonResponse public function migrate(): JsonResponse
@@ -118,6 +124,8 @@ class InstallController extends Controller
} }
/** /**
* Do database upgrade.
*
* @return \Illuminate\Http\JsonResponse * @return \Illuminate\Http\JsonResponse
*/ */
public function upgrade(): JsonResponse public function upgrade(): JsonResponse
@@ -143,6 +151,8 @@ class InstallController extends Controller
} }
/** /**
* Do database verification.
*
* @return \Illuminate\Http\JsonResponse * @return \Illuminate\Http\JsonResponse
*/ */
public function verify(): JsonResponse public function verify(): JsonResponse
@@ -168,6 +178,8 @@ class InstallController extends Controller
} }
/** /**
* Check if forbidden functions are set.
*
* @return bool * @return bool
*/ */
private function hasForbiddenFunctions(): bool private function hasForbiddenFunctions(): bool

View File

@@ -39,11 +39,11 @@ use Illuminate\Support\Collection;
*/ */
class TagController extends Controller class TagController extends Controller
{ {
/** @var TagRepositoryInterface */ /** @var TagRepositoryInterface The tag repository. */
protected $repository; protected $repository;
/** /**
* * TagController constructor.
*/ */
public function __construct() public function __construct()
{ {
@@ -63,6 +63,8 @@ class TagController extends Controller
} }
/** /**
* Create a new tag.
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/ */
public function create() public function create()
@@ -97,6 +99,8 @@ class TagController extends Controller
} }
/** /**
* Destroy a tag.
*
* @param Tag $tag * @param Tag $tag
* *
* @return RedirectResponse * @return RedirectResponse
@@ -162,6 +166,8 @@ class TagController extends Controller
} }
/** /**
* Show a single tag.
*
* @param Request $request * @param Request $request
* @param Tag $tag * @param Tag $tag
* @param string|null $moment * @param string|null $moment
@@ -235,6 +241,8 @@ class TagController extends Controller
} }
/** /**
* Store a tag.
*
* @param TagFormRequest $request * @param TagFormRequest $request
* *
* @return RedirectResponse * @return RedirectResponse
@@ -261,6 +269,8 @@ class TagController extends Controller
} }
/** /**
* Update a tag.
*
* @param TagFormRequest $request * @param TagFormRequest $request
* @param Tag $tag * @param Tag $tag
* *
@@ -288,6 +298,8 @@ class TagController extends Controller
} }
/** /**
* Get overview of periods for tag.
*
* @param Tag $tag * @param Tag $tag
* *
* @return Collection * @return Collection

View File

@@ -60,6 +60,8 @@ class BulkController extends Controller
} }
/** /**
* Edit a set of journals in bulk.
*
* @param Collection $journals * @param Collection $journals
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -84,6 +86,8 @@ class BulkController extends Controller
/** /**
* Update all journals.
*
* @param BulkEditJournalRequest $request * @param BulkEditJournalRequest $request
* *
* @return mixed * @return mixed

View File

@@ -63,6 +63,8 @@ class ConvertController extends Controller
/** /**
* Show overview of a to be converted transaction.
*
* @param TransactionType $destinationType * @param TransactionType $destinationType
* @param TransactionJournal $journal * @param TransactionJournal $journal
* *
@@ -110,6 +112,8 @@ class ConvertController extends Controller
/** /**
* Do the conversion.
*
* @param Request $request * @param Request $request
* @param TransactionType $destinationType * @param TransactionType $destinationType
* @param TransactionJournal $journal * @param TransactionJournal $journal
@@ -164,6 +168,8 @@ class ConvertController extends Controller
/** /**
* Get the destination account. Is complex.
*
* @param TransactionJournal $journal * @param TransactionJournal $journal
* @param TransactionType $destinationType * @param TransactionType $destinationType
* @param array $data * @param array $data
@@ -223,6 +229,8 @@ class ConvertController extends Controller
/** /**
* Get the source account.
*
* @param TransactionJournal $journal * @param TransactionJournal $journal
* @param TransactionType $destinationType * @param TransactionType $destinationType
* @param array $data * @param array $data

View File

@@ -38,11 +38,11 @@ class LinkController extends Controller
{ {
/** @var JournalRepositoryInterface Journals and transactions overview */ /** @var JournalRepositoryInterface Journals and transactions overview */
private $journalRepository; private $journalRepository;
/** @var LinkTypeRepositoryInterface */ /** @var LinkTypeRepositoryInterface Link repository. */
private $repository; private $repository;
/** /**
* * LinkController constructor.
*/ */
public function __construct() public function __construct()
{ {
@@ -62,6 +62,8 @@ class LinkController extends Controller
} }
/** /**
* Delete a link.
*
* @param TransactionJournalLink $link * @param TransactionJournalLink $link
* *
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -76,6 +78,8 @@ class LinkController extends Controller
} }
/** /**
* Actually destroy it.
*
* @param TransactionJournalLink $link * @param TransactionJournalLink $link
* *
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
@@ -91,6 +95,8 @@ class LinkController extends Controller
} }
/** /**
* Store a new link.
*
* @param JournalLinkRequest $request * @param JournalLinkRequest $request
* @param TransactionJournal $journal * @param TransactionJournal $journal
* *
@@ -129,6 +135,7 @@ class LinkController extends Controller
} }
/** /**
* Switch link from A <> B to B <> A.
* @param TransactionJournalLink $link * @param TransactionJournalLink $link
* *
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector

View File

@@ -51,7 +51,7 @@ class MassController extends Controller
private $repository; private $repository;
/** /**
* * MassController constructor.
*/ */
public function __construct() public function __construct()
{ {
@@ -69,6 +69,8 @@ class MassController extends Controller
} }
/** /**
* Mass delete transactions.
*
* @param Collection $journals * @param Collection $journals
* *
* @return IlluminateView * @return IlluminateView
@@ -84,6 +86,8 @@ class MassController extends Controller
} }
/** /**
* Do the mass delete.
*
* @param MassDeleteJournalRequest $request * @param MassDeleteJournalRequest $request
* *
* @return mixed * @return mixed
@@ -114,6 +118,8 @@ class MassController extends Controller
} }
/** /**
* Mass edit of journals.
*
* @param Collection $journals * @param Collection $journals
* *
* @return IlluminateView * @return IlluminateView
@@ -157,6 +163,8 @@ class MassController extends Controller
} }
/** /**
* Mass update of journals.
*
* @param MassEditJournalRequest $request * @param MassEditJournalRequest $request
* @param JournalRepositoryInterface $repository * @param JournalRepositoryInterface $repository
* *

View File

@@ -46,7 +46,7 @@ use View;
*/ */
class SingleController extends Controller class SingleController extends Controller
{ {
/** @var AttachmentHelperInterface */ /** @var AttachmentHelperInterface The attachment helper. */
private $attachments; private $attachments;
/** @var BudgetRepositoryInterface The budget repository */ /** @var BudgetRepositoryInterface The budget repository */
private $budgets; private $budgets;
@@ -54,7 +54,7 @@ class SingleController extends Controller
private $repository; private $repository;
/** /**
* * SingleController constructor.
*/ */
public function __construct() public function __construct()
{ {
@@ -81,6 +81,8 @@ class SingleController extends Controller
} }
/** /**
* CLone a transaction.
*
* @param TransactionJournal $journal * @param TransactionJournal $journal
* *
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
@@ -137,6 +139,8 @@ class SingleController extends Controller
} }
/** /**
* Create a new journal.
*
* @param Request $request * @param Request $request
* @param string|null $what * @param string|null $what
* *
@@ -206,6 +210,8 @@ class SingleController extends Controller
} }
/** /**
* Actually destroys the journal.
*
* @param TransactionJournal $transactionJournal * @param TransactionJournal $transactionJournal
* *
* @return \Illuminate\Http\RedirectResponse * @return \Illuminate\Http\RedirectResponse
@@ -228,6 +234,8 @@ class SingleController extends Controller
} }
/** /**
* Edit a journal.
*
* @param TransactionJournal $journal * @param TransactionJournal $journal
* *
* @param JournalRepositoryInterface $repository * @param JournalRepositoryInterface $repository
@@ -321,6 +329,8 @@ class SingleController extends Controller
} }
/** /**
* Stores a new journal.
*
* @param JournalFormRequest $request * @param JournalFormRequest $request
* @param JournalRepositoryInterface $repository * @param JournalRepositoryInterface $repository
* *
@@ -383,6 +393,8 @@ class SingleController extends Controller
} }
/** /**
* Update a journal.
*
* @param JournalFormRequest $request * @param JournalFormRequest $request
* @param JournalRepositoryInterface $repository * @param JournalRepositoryInterface $repository
* @param TransactionJournal $journal * @param TransactionJournal $journal
@@ -439,6 +451,8 @@ class SingleController extends Controller
} }
/** /**
* Checks if journal is split.
*
* @param TransactionJournal $journal * @param TransactionJournal $journal
* *
* @return bool * @return bool

View File

@@ -42,11 +42,12 @@ use View;
/** /**
* Class SplitController. * Class SplitController.
*
* @SuppressWarnings(PHPMD.CouplingBetweenObjects) * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/ */
class SplitController extends Controller class SplitController extends Controller
{ {
/** @var AttachmentHelperInterface */ /** @var AttachmentHelperInterface Attachment helper */
private $attachments; private $attachments;
/** @var BudgetRepositoryInterface The budget repository */ /** @var BudgetRepositoryInterface The budget repository */
@@ -58,7 +59,7 @@ class SplitController extends Controller
private $repository; private $repository;
/** /**
* * SplitController constructor.
*/ */
public function __construct() public function __construct()
{ {
@@ -80,6 +81,8 @@ class SplitController extends Controller
} }
/** /**
* Edit a split.
*
* @param Request $request * @param Request $request
* @param TransactionJournal $journal * @param TransactionJournal $journal
* *
@@ -119,6 +122,8 @@ class SplitController extends Controller
} }
/** /**
* Store new split journal.
*
* @param SplitJournalFormRequest $request * @param SplitJournalFormRequest $request
* @param TransactionJournal $journal * @param TransactionJournal $journal
* *
@@ -169,6 +174,8 @@ class SplitController extends Controller
} }
/** /**
* Create data-array from a journal.
*
* @param SplitJournalFormRequest|Request $request * @param SplitJournalFormRequest|Request $request
* @param TransactionJournal $journal * @param TransactionJournal $journal
* *
@@ -216,6 +223,8 @@ class SplitController extends Controller
} }
/** /**
* Get transaction overview from journal.
*
* @param TransactionJournal $journal * @param TransactionJournal $journal
* *
* @return array * @return array
@@ -255,6 +264,8 @@ class SplitController extends Controller
} }
/** /**
* Get info from old input.
*
* @param $array * @param $array
* @param $old * @param $old
* *

View File

@@ -121,6 +121,8 @@ class TransactionController extends Controller
} }
/** /**
* Index for ALL transactions.
*
* @param Request $request * @param Request $request
* @param string $what * @param string $what
* *
@@ -153,6 +155,8 @@ class TransactionController extends Controller
} }
/** /**
* Do a reconciliation.
*
* @param Request $request * @param Request $request
* *
* @return JsonResponse * @return JsonResponse
@@ -173,6 +177,8 @@ class TransactionController extends Controller
} }
/** /**
* Reorder transactions.
*
* @param Request $request * @param Request $request
* *
* @return \Illuminate\Http\JsonResponse * @return \Illuminate\Http\JsonResponse
@@ -199,6 +205,8 @@ class TransactionController extends Controller
} }
/** /**
* Show a transaction.
*
* @param TransactionJournal $journal * @param TransactionJournal $journal
* @param LinkTypeRepositoryInterface $linkTypeRepository * @param LinkTypeRepositoryInterface $linkTypeRepository
* *
@@ -239,6 +247,8 @@ class TransactionController extends Controller
} }
/** /**
* Get period overview for index.
*
* @param string $what * @param string $what
* *
* @param Carbon $date * @param Carbon $date
@@ -294,6 +304,8 @@ class TransactionController extends Controller
} }
/** /**
* Collect the sum per currency.
*
* @param Collection $collection * @param Collection $collection
* *
* @return array * @return array

View File

@@ -48,8 +48,9 @@ use Illuminate\View\Middleware\ShareErrorsFromSession;
use Laravel\Passport\Http\Middleware\CreateFreshApiToken; use Laravel\Passport\Http\Middleware\CreateFreshApiToken;
/** /**
* @codeCoverageIgnore
* Class Kernel * Class Kernel
*
* @codeCoverageIgnore
*/ */
class Kernel extends HttpKernel class Kernel extends HttpKernel
{ {

View File

@@ -53,6 +53,8 @@ class AuthenticateTwoFactor
/** /**
* Handle 2FA request.
*
* @param $request * @param $request
* @param Closure $next * @param Closure $next
* *

View File

@@ -28,7 +28,7 @@ use Illuminate\Contracts\Auth\Factory as Auth;
use Illuminate\Routing\Route; use Illuminate\Routing\Route;
/** /**
* Class HttpBinder * Class Binder
*/ */
class Binder class Binder
{ {
@@ -39,6 +39,8 @@ class Binder
*/ */
protected $auth; protected $auth;
/** /**
* The binders.
*
* @var array * @var array
*/ */
protected $binders = []; protected $binders = [];
@@ -77,6 +79,8 @@ class Binder
} }
/** /**
* Do the binding.
*
* @param $key * @param $key
* @param $value * @param $value
* @param $route * @param $route

View File

@@ -25,8 +25,9 @@ namespace FireflyIII\Http\Middleware;
use Illuminate\Cookie\Middleware\EncryptCookies as Middleware; use Illuminate\Cookie\Middleware\EncryptCookies as Middleware;
/** /**
* @codeCoverageIgnore
* Class EncryptCookies * Class EncryptCookies
*
* @codeCoverageIgnore
*/ */
class EncryptCookies extends Middleware class EncryptCookies extends Middleware
{ {

View File

@@ -99,6 +99,8 @@ class Installer
} }
/** /**
* Is access denied error.
*
* @param string $message * @param string $message
* *
* @return bool * @return bool
@@ -109,6 +111,8 @@ class Installer
} }
/** /**
* Is no tables exist error.
*
* @param string $message * @param string $message
* *
* @return bool * @return bool

View File

@@ -25,7 +25,7 @@ namespace FireflyIII\Http\Middleware;
use Closure; use Closure;
use Illuminate\Http\Request; use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth; use Illuminate\Support\Facades\Auth;
use Session;
/** /**
* Class IsSandStormUser. * Class IsSandStormUser.

View File

@@ -61,7 +61,7 @@ class Range
} }
/** /**
* * Configure the list length.
*/ */
private function configureList(): void private function configureList(): void
{ {
@@ -70,7 +70,7 @@ class Range
} }
/** /**
* * Configure the user's view.
*/ */
private function configureView(): void private function configureView(): void
{ {
@@ -101,6 +101,8 @@ class Range
} }
/** /**
* Error when sqlite in docker.
*
* @param Request $request * @param Request $request
*/ */
private function loseItAll(Request $request): void private function loseItAll(Request $request): void
@@ -113,6 +115,8 @@ class Range
} }
/** /**
* Set the range for the current view.
*
* @SuppressWarnings(PHPMD.CyclomaticComplexity) * @SuppressWarnings(PHPMD.CyclomaticComplexity)
*/ */
private function setRange(): void private function setRange(): void

View File

@@ -26,8 +26,9 @@ use Closure;
use Illuminate\Support\Facades\Auth; use Illuminate\Support\Facades\Auth;
/** /**
* @codeCoverageIgnore
* Class RedirectIfAuthenticated * Class RedirectIfAuthenticated
*
* @codeCoverageIgnore
*/ */
class RedirectIfAuthenticated class RedirectIfAuthenticated
{ {

View File

@@ -60,7 +60,7 @@ class Sandstorm
$repository = app(UserRepositoryInterface::class); $repository = app(UserRepositoryInterface::class);
$userId = (string)$request->header('X-Sandstorm-User-Id'); $userId = (string)$request->header('X-Sandstorm-User-Id');
// catch anonymous: // catch anonymous:
$userId = $userId === '' ? 'anonymous' : $userId; $userId = '' === $userId ? 'anonymous' : $userId;
$email = $userId . '@firefly'; $email = $userId . '@firefly';
$user = $repository->findByEmail($email) ?? $this->createUser($email); $user = $repository->findByEmail($email) ?? $this->createUser($email);
Log::debug(sprintf('Sandstorm user email is "%s"', $email)); Log::debug(sprintf('Sandstorm user email is "%s"', $email));
@@ -75,6 +75,8 @@ class Sandstorm
/** /**
* Create a user.
*
* @param string $email * @param string $email
* *
* @return User * @return User

View File

@@ -26,8 +26,9 @@ use Illuminate\Http\Request;
use Illuminate\Session\Middleware\StartSession; use Illuminate\Session\Middleware\StartSession;
/** /**
* @codeCoverageIgnore
* Class StartFireflySession. * Class StartFireflySession.
*
* @codeCoverageIgnore
*/ */
class StartFireflySession extends StartSession class StartFireflySession extends StartSession
{ {

View File

@@ -25,8 +25,9 @@ namespace FireflyIII\Http\Middleware;
use Illuminate\Foundation\Http\Middleware\TrimStrings as Middleware; use Illuminate\Foundation\Http\Middleware\TrimStrings as Middleware;
/** /**
* @codeCoverageIgnore
* Class TrimStrings * Class TrimStrings
*
* @codeCoverageIgnore
*/ */
class TrimStrings extends Middleware class TrimStrings extends Middleware
{ {

View File

@@ -27,12 +27,13 @@ use Illuminate\Contracts\Config\Repository;
use Illuminate\Http\Request; use Illuminate\Http\Request;
/** /**
* @codeCoverageIgnore
* Class TrustProxies * Class TrustProxies
*
* @codeCoverageIgnore
*/ */
class TrustProxies extends Middleware class TrustProxies extends Middleware
{ {
/** @var int */ /** @var int The headers to check. */
protected $headers = Request::HEADER_X_FORWARDED_ALL; protected $headers = Request::HEADER_X_FORWARDED_ALL;
/** /**

View File

@@ -25,8 +25,9 @@ namespace FireflyIII\Http\Middleware;
use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken as Middleware; use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken as Middleware;
/** /**
* Class VerifyCsrfToken.
*
* @codeCoverageIgnore * @codeCoverageIgnore
* Class VerifyCsrfToken
*/ */
class VerifyCsrfToken extends Middleware class VerifyCsrfToken extends Middleware
{ {

View File

@@ -31,6 +31,8 @@ use FireflyIII\Rules\UniqueIban;
class AccountFormRequest extends Request class AccountFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -40,6 +42,8 @@ class AccountFormRequest extends Request
} }
/** /**
* Get all data.
*
* @return array * @return array
*/ */
public function getAccountData(): array public function getAccountData(): array
@@ -64,6 +68,8 @@ class AccountFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests; namespace FireflyIII\Http\Requests;
/** /**
* @codeCoverageIgnore
* Class AttachmentFormRequest. * Class AttachmentFormRequest.
*
* @codeCoverageIgnore
*/ */
class AttachmentFormRequest extends Request class AttachmentFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -38,6 +41,8 @@ class AttachmentFormRequest extends Request
} }
/** /**
* Returns the data required by the controller.
*
* @return array * @return array
*/ */
public function getAttachmentData(): array public function getAttachmentData(): array
@@ -49,6 +54,8 @@ class AttachmentFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -28,6 +28,8 @@ namespace FireflyIII\Http\Requests;
class BillFormRequest extends Request class BillFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -37,6 +39,8 @@ class BillFormRequest extends Request
} }
/** /**
* Returns the data required by the controller.
*
* @return array * @return array
*/ */
public function getBillData(): array public function getBillData(): array
@@ -55,6 +59,8 @@ class BillFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -25,12 +25,15 @@ namespace FireflyIII\Http\Requests;
use FireflyIII\Repositories\Budget\BudgetRepositoryInterface; use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
/** /**
* @codeCoverageIgnore
* Class BudgetFormRequest. * Class BudgetFormRequest.
*
* @codeCoverageIgnore
*/ */
class BudgetFormRequest extends Request class BudgetFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -39,6 +42,8 @@ class BudgetFormRequest extends Request
} }
/** /**
* Returns the data required by the controller.
*
* @return array * @return array
*/ */
public function getBudgetData(): array public function getBudgetData(): array
@@ -50,6 +55,8 @@ class BudgetFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests; namespace FireflyIII\Http\Requests;
/** /**
* @codeCoverageIgnore
* Class BudgetIncomeRequest. * Class BudgetIncomeRequest.
*
* @codeCoverageIgnore
*/ */
class BudgetIncomeRequest extends Request class BudgetIncomeRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -38,6 +41,8 @@ class BudgetIncomeRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -28,6 +28,8 @@ namespace FireflyIII\Http\Requests;
class BulkEditJournalRequest extends Request class BulkEditJournalRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -37,6 +39,8 @@ class BulkEditJournalRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -30,6 +30,8 @@ use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
class CategoryFormRequest extends Request class CategoryFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -39,6 +41,8 @@ class CategoryFormRequest extends Request
} }
/** /**
* Get information for the controller.
*
* @return array * @return array
*/ */
public function getCategoryData(): array public function getCategoryData(): array
@@ -49,6 +53,8 @@ class CategoryFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests; namespace FireflyIII\Http\Requests;
/** /**
* @codeCoverageIgnore
* Class ConfigurationRequest. * Class ConfigurationRequest.
*
* @codeCoverageIgnore
*/ */
class ConfigurationRequest extends Request class ConfigurationRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -38,6 +41,8 @@ class ConfigurationRequest extends Request
} }
/** /**
* Returns the data required by the controller.
*
* @return array * @return array
*/ */
public function getConfigurationData(): array public function getConfigurationData(): array
@@ -49,6 +54,8 @@ class ConfigurationRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -28,6 +28,8 @@ namespace FireflyIII\Http\Requests;
class CurrencyFormRequest extends Request class CurrencyFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -37,6 +39,8 @@ class CurrencyFormRequest extends Request
} }
/** /**
* Returns the data required by the controller.
*
* @return array * @return array
*/ */
public function getCurrencyData(): array public function getCurrencyData(): array
@@ -50,6 +54,8 @@ class CurrencyFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests; namespace FireflyIII\Http\Requests;
/** /**
* @codeCoverageIgnore
* Class DeleteAccountFormRequest. * Class DeleteAccountFormRequest.
*
* @codeCoverageIgnore
*/ */
class DeleteAccountFormRequest extends Request class DeleteAccountFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -38,6 +41,8 @@ class DeleteAccountFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests; namespace FireflyIII\Http\Requests;
/** /**
* @codeCoverageIgnore
* Class EmailFormRequest. * Class EmailFormRequest.
*
* @codeCoverageIgnore
*/ */
class EmailFormRequest extends Request class EmailFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -38,6 +41,8 @@ class EmailFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -30,6 +30,8 @@ use Carbon\Carbon;
class ExportFormRequest extends Request class ExportFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -39,6 +41,8 @@ class ExportFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -33,6 +33,8 @@ use Log;
class JournalFormRequest extends Request class JournalFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -140,8 +142,9 @@ class JournalFormRequest extends Request
} }
/** /**
* @return array * Rules for this request.
* *
* @return array
* @throws FireflyException * @throws FireflyException
*/ */
public function rules(): array public function rules(): array
@@ -234,6 +237,8 @@ class JournalFormRequest extends Request
} }
/** /**
* Check if amounts are valid.
*
* @param Validator $validator * @param Validator $validator
*/ */
private function validNativeAmount(Validator $validator): void private function validNativeAmount(Validator $validator): void
@@ -257,6 +262,8 @@ class JournalFormRequest extends Request
} }
/** /**
* Check if deposit amount is valid.
*
* @param Validator $validator * @param Validator $validator
* *
* @SuppressWarnings(PHPMD.CyclomaticComplexity) * @SuppressWarnings(PHPMD.CyclomaticComplexity)
@@ -274,6 +281,8 @@ class JournalFormRequest extends Request
} }
/** /**
* Check if transfer amount is valid.
*
* @param Validator $validator * @param Validator $validator
* *
* @SuppressWarnings(PHPMD.CyclomaticComplexity) * @SuppressWarnings(PHPMD.CyclomaticComplexity)
@@ -299,6 +308,8 @@ class JournalFormRequest extends Request
} }
/** /**
* Check if withdrawal amount is valid.
*
* @param Validator $validator * @param Validator $validator
* @SuppressWarnings(PHPMD.CyclomaticComplexity) * @SuppressWarnings(PHPMD.CyclomaticComplexity)
*/ */

View File

@@ -31,6 +31,8 @@ use FireflyIII\Models\LinkType;
class JournalLinkRequest extends Request class JournalLinkRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -40,6 +42,8 @@ class JournalLinkRequest extends Request
} }
/** /**
* Returns the data required by the controller.
*
* @return array * @return array
*/ */
public function getLinkInfo(): array public function getLinkInfo(): array
@@ -59,6 +63,8 @@ class JournalLinkRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -28,6 +28,8 @@ namespace FireflyIII\Http\Requests;
class LinkTypeFormRequest extends Request class LinkTypeFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -37,6 +39,8 @@ class LinkTypeFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests; namespace FireflyIII\Http\Requests;
/** /**
* @codeCoverageIgnore
* Class MassDeleteJournalRequest. * Class MassDeleteJournalRequest.
*
* @codeCoverageIgnore
*/ */
class MassDeleteJournalRequest extends Request class MassDeleteJournalRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -38,6 +41,8 @@ class MassDeleteJournalRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests; namespace FireflyIII\Http\Requests;
/** /**
* @codeCoverageIgnore
* Class MassEditJournalRequest. * Class MassEditJournalRequest.
*
* @codeCoverageIgnore
*/ */
class MassEditJournalRequest extends Request class MassEditJournalRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -38,6 +41,8 @@ class MassEditJournalRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests; namespace FireflyIII\Http\Requests;
/** /**
* @codeCoverageIgnore
* Class NewUserFormRequest. * Class NewUserFormRequest.
*
* @codeCoverageIgnore
*/ */
class NewUserFormRequest extends Request class NewUserFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -38,6 +41,8 @@ class NewUserFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -28,6 +28,8 @@ namespace FireflyIII\Http\Requests;
class PiggyBankFormRequest extends Request class PiggyBankFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -37,6 +39,8 @@ class PiggyBankFormRequest extends Request
} }
/** /**
* Returns the data required by the controller.
*
* @return array * @return array
*/ */
public function getPiggyBankData(): array public function getPiggyBankData(): array
@@ -52,6 +56,8 @@ class PiggyBankFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests; namespace FireflyIII\Http\Requests;
/** /**
* @codeCoverageIgnore
* Class ProfileFormRequest. * Class ProfileFormRequest.
*
* @codeCoverageIgnore
*/ */
class ProfileFormRequest extends Request class ProfileFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -38,6 +41,8 @@ class ProfileFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -32,6 +32,8 @@ use Log;
class ReconciliationStoreRequest extends Request class ReconciliationStoreRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -41,6 +43,8 @@ class ReconciliationStoreRequest extends Request
} }
/** /**
* Returns the data required by the controller.
*
* @return array * @return array
*/ */
public function getAll(): array public function getAll(): array
@@ -64,6 +68,8 @@ class ReconciliationStoreRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -28,6 +28,8 @@ namespace FireflyIII\Http\Requests;
class ReconciliationUpdateRequest extends Request class ReconciliationUpdateRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -53,6 +55,8 @@ class ReconciliationUpdateRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -37,6 +37,8 @@ class RecurrenceFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -46,6 +48,8 @@ class RecurrenceFormRequest extends Request
} }
/** /**
* Get the data required by the controller.
*
* @return array * @return array
* @throws FireflyException * @throws FireflyException
* *
@@ -133,6 +137,8 @@ class RecurrenceFormRequest extends Request
} }
/** /**
* The rules for this request.
*
* @return array * @return array
* @throws FireflyException * @throws FireflyException
* *
@@ -228,6 +234,8 @@ class RecurrenceFormRequest extends Request
} }
/** /**
* Parses repetition data.
*
* @return array * @return array
* *
* @SuppressWarnings(PHPMD.CyclomaticComplexity) * @SuppressWarnings(PHPMD.CyclomaticComplexity)

View File

@@ -38,6 +38,8 @@ use Log;
class ReportFormRequest extends Request class ReportFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -47,6 +49,8 @@ class ReportFormRequest extends Request
} }
/** /**
* Validate list of accounts.
*
* @return Collection * @return Collection
*/ */
public function getAccountList(): Collection public function getAccountList(): Collection
@@ -69,6 +73,8 @@ class ReportFormRequest extends Request
} }
/** /**
* Validate list of budgets.
*
* @return Collection * @return Collection
*/ */
public function getBudgetList(): Collection public function getBudgetList(): Collection
@@ -90,6 +96,8 @@ class ReportFormRequest extends Request
} }
/** /**
* Validate list of categories.
*
* @return Collection * @return Collection
*/ */
public function getCategoryList(): Collection public function getCategoryList(): Collection
@@ -111,6 +119,8 @@ class ReportFormRequest extends Request
} }
/** /**
* Validate end date.
*
* @return Carbon * @return Carbon
* *
* @throws FireflyException * @throws FireflyException
@@ -137,6 +147,8 @@ class ReportFormRequest extends Request
} }
/** /**
* Validate list of expense accounts.
*
* @return Collection * @return Collection
*/ */
public function getExpenseList(): Collection public function getExpenseList(): Collection
@@ -159,6 +171,8 @@ class ReportFormRequest extends Request
} }
/** /**
* Validate start date.
*
* @return Carbon * @return Carbon
* *
* @throws FireflyException * @throws FireflyException
@@ -184,6 +198,8 @@ class ReportFormRequest extends Request
} }
/** /**
* Validate list of tags.
*
* @return Collection * @return Collection
*/ */
public function getTagList(): Collection public function getTagList(): Collection
@@ -205,6 +221,8 @@ class ReportFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -33,6 +33,8 @@ use Illuminate\Foundation\Http\FormRequest;
class Request extends FormRequest class Request extends FormRequest
{ {
/** /**
* Return a boolean value.
*
* @param string $field * @param string $field
* *
* @return bool * @return bool
@@ -50,6 +52,8 @@ class Request extends FormRequest
} }
/** /**
* Return floating value.
*
* @param string $field * @param string $field
* *
* @return float * @return float
@@ -60,6 +64,8 @@ class Request extends FormRequest
} }
/** /**
* Return integer value.
*
* @param string $field * @param string $field
* *
* @return int * @return int
@@ -70,6 +76,8 @@ class Request extends FormRequest
} }
/** /**
* Return string value.
*
* @param string $field * @param string $field
* *
* @return string * @return string
@@ -133,6 +141,8 @@ class Request extends FormRequest
} }
/** /**
* Return date or NULL.
*
* @param string $field * @param string $field
* *
* @return Carbon|null * @return Carbon|null

View File

@@ -30,6 +30,8 @@ use FireflyIII\Repositories\Rule\RuleRepositoryInterface;
class RuleFormRequest extends Request class RuleFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -39,6 +41,8 @@ class RuleFormRequest extends Request
} }
/** /**
* Get all data for controller.
*
* @return array * @return array
* *
* @SuppressWarnings(PHPMD.ExcessiveMethodLength) * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
@@ -89,6 +93,8 @@ class RuleFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -30,6 +30,8 @@ use FireflyIII\Repositories\RuleGroup\RuleGroupRepositoryInterface;
class RuleGroupFormRequest extends Request class RuleGroupFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -39,6 +41,8 @@ class RuleGroupFormRequest extends Request
} }
/** /**
* Get all data for controller.
*
* @return array * @return array
*/ */
public function getRuleGroupData(): array public function getRuleGroupData(): array
@@ -50,6 +54,8 @@ class RuleGroupFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -25,12 +25,15 @@ namespace FireflyIII\Http\Requests;
use Carbon\Carbon; use Carbon\Carbon;
/** /**
* @codeCoverageIgnore
* Class ExportFormRequest. * Class ExportFormRequest.
*
* @codeCoverageIgnore
*/ */
class SelectTransactionsRequest extends Request class SelectTransactionsRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -40,6 +43,8 @@ class SelectTransactionsRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -30,6 +30,8 @@ use Illuminate\Validation\Validator;
class SplitJournalFormRequest extends Request class SplitJournalFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -39,6 +41,8 @@ class SplitJournalFormRequest extends Request
} }
/** /**
* Get all info for the controller.
*
* @return array * @return array
* *
* @SuppressWarnings(PHPMD.ExcessiveMethodLength) * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
@@ -107,6 +111,8 @@ class SplitJournalFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array
@@ -149,6 +155,8 @@ class SplitJournalFormRequest extends Request
} }
/** /**
* Verify that source and destination are not the same.
*
* @param Validator $validator * @param Validator $validator
* *
* @SuppressWarnings(PHPMD.CyclomaticComplexity) * @SuppressWarnings(PHPMD.CyclomaticComplexity)

View File

@@ -30,6 +30,8 @@ use FireflyIII\Repositories\Tag\TagRepositoryInterface;
class TagFormRequest extends Request class TagFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -39,6 +41,8 @@ class TagFormRequest extends Request
} }
/** /**
* Get all data for controller.
*
* @return array * @return array
*/ */
public function collectTagData(): array public function collectTagData(): array
@@ -66,6 +70,8 @@ class TagFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests; namespace FireflyIII\Http\Requests;
/** /**
* @codeCoverageIgnore
* Class RuleFormRequest. * Class RuleFormRequest.
*
* @codeCoverageIgnore
*/ */
class TestRuleFormRequest extends Request class TestRuleFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -38,6 +41,8 @@ class TestRuleFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests; namespace FireflyIII\Http\Requests;
/** /**
* @codeCoverageIgnore
* Class TokenFormRequest. * Class TokenFormRequest.
*
* @codeCoverageIgnore
*/ */
class TokenFormRequest extends Request class TokenFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -38,6 +41,8 @@ class TokenFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests; namespace FireflyIII\Http\Requests;
/** /**
* @codeCoverageIgnore
* Class UserFormRequest. * Class UserFormRequest.
*
* @codeCoverageIgnore
*/ */
class UserFormRequest extends Request class UserFormRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -38,6 +41,8 @@ class UserFormRequest extends Request
} }
/** /**
* Get data for controller.
*
* @return array * @return array
*/ */
public function getUserData(): array public function getUserData(): array
@@ -51,6 +56,8 @@ class UserFormRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests; namespace FireflyIII\Http\Requests;
/** /**
* @codeCoverageIgnore
* Class UserRegistrationRequest. * Class UserRegistrationRequest.
*
* @codeCoverageIgnore
*/ */
class UserRegistrationRequest extends Request class UserRegistrationRequest extends Request
{ {
/** /**
* Verify the request.
*
* @return bool * @return bool
*/ */
public function authorize(): bool public function authorize(): bool
@@ -38,6 +41,8 @@ class UserRegistrationRequest extends Request
} }
/** /**
* Rules for this request.
*
* @return array * @return array
*/ */
public function rules(): array public function rules(): array