From 2630732b8a07225f8a1b78817393373216f41d21 Mon Sep 17 00:00:00 2001 From: James Cole Date: Sun, 18 Oct 2020 08:01:10 +0200 Subject: [PATCH] Code cleanup [skip ci] --- .../V1/Controllers/AttachmentController.php | 4 +- app/Api/V1/Controllers/BillController.php | 2 +- app/Api/V1/Controllers/BudgetController.php | 4 +- .../V1/Controllers/BudgetLimitController.php | 6 +- app/Api/V1/Controllers/CategoryController.php | 2 +- .../Controllers/ConfigurationController.php | 34 ++++---- app/Api/V1/Controllers/Controller.php | 77 +++++++++---------- app/Api/V1/Controllers/CurrencyController.php | 7 +- .../CurrencyExchangeRateController.php | 2 +- app/Api/V1/Controllers/LinkTypeController.php | 6 +- .../V1/Controllers/PiggyBankController.php | 2 +- .../V1/Controllers/RecurrenceController.php | 6 +- app/Api/V1/Controllers/SummaryController.php | 52 ++++++------- .../V1/Controllers/TransactionController.php | 27 +++---- .../Controllers/TransactionLinkController.php | 4 +- app/Api/V1/Controllers/UserController.php | 2 +- 16 files changed, 117 insertions(+), 120 deletions(-) diff --git a/app/Api/V1/Controllers/AttachmentController.php b/app/Api/V1/Controllers/AttachmentController.php index 77ca07819b..aba389d7b3 100644 --- a/app/Api/V1/Controllers/AttachmentController.php +++ b/app/Api/V1/Controllers/AttachmentController.php @@ -95,8 +95,8 @@ class AttachmentController extends Controller * @param Attachment $attachment * * @codeCoverageIgnore - * @throws FireflyException * @return LaravelResponse + * @throws FireflyException */ public function download(Attachment $attachment): LaravelResponse { @@ -187,8 +187,8 @@ class AttachmentController extends Controller * * @param AttachmentStoreRequest $request * - * @throws FireflyException * @return JsonResponse + * @throws FireflyException */ public function store(AttachmentStoreRequest $request): JsonResponse { diff --git a/app/Api/V1/Controllers/BillController.php b/app/Api/V1/Controllers/BillController.php index 123c4b7ec4..136c2a341d 100644 --- a/app/Api/V1/Controllers/BillController.php +++ b/app/Api/V1/Controllers/BillController.php @@ -207,8 +207,8 @@ class BillController extends Controller * * @param BillRequest $request * - * @throws FireflyException * @return JsonResponse + * @throws FireflyException */ public function store(BillRequest $request): JsonResponse { diff --git a/app/Api/V1/Controllers/BudgetController.php b/app/Api/V1/Controllers/BudgetController.php index e22726aacb..ed570f20e5 100644 --- a/app/Api/V1/Controllers/BudgetController.php +++ b/app/Api/V1/Controllers/BudgetController.php @@ -23,8 +23,6 @@ declare(strict_types=1); namespace FireflyIII\Api\V1\Controllers; -use Exception; -use FireflyIII\Api\V1\Requests\BudgetLimitRequest; use FireflyIII\Api\V1\Requests\BudgetStoreRequest; use FireflyIII\Api\V1\Requests\BudgetUpdateRequest; use FireflyIII\Exceptions\FireflyException; @@ -214,9 +212,9 @@ class BudgetController extends Controller * * @param BudgetStoreRequest $request * + * @return JsonResponse * @throws FireflyException * - * @return JsonResponse */ public function store(BudgetStoreRequest $request): JsonResponse { diff --git a/app/Api/V1/Controllers/BudgetLimitController.php b/app/Api/V1/Controllers/BudgetLimitController.php index 8fad0ff3a8..5e9b0798a5 100644 --- a/app/Api/V1/Controllers/BudgetLimitController.php +++ b/app/Api/V1/Controllers/BudgetLimitController.php @@ -244,9 +244,9 @@ class BudgetLimitController extends Controller */ public function update(BudgetLimitRequest $request, BudgetLimit $budgetLimit): JsonResponse { - $data = $request->getAll(); - $budgetLimit = $this->blRepository->update($budgetLimit, $data); - $manager = $this->getManager(); + $data = $request->getAll(); + $budgetLimit = $this->blRepository->update($budgetLimit, $data); + $manager = $this->getManager(); /** @var BudgetLimitTransformer $transformer */ $transformer = app(BudgetLimitTransformer::class); diff --git a/app/Api/V1/Controllers/CategoryController.php b/app/Api/V1/Controllers/CategoryController.php index 312af6a738..e461ff3beb 100644 --- a/app/Api/V1/Controllers/CategoryController.php +++ b/app/Api/V1/Controllers/CategoryController.php @@ -177,8 +177,8 @@ class CategoryController extends Controller * * @param CategoryRequest $request * - * @throws FireflyException * @return JsonResponse + * @throws FireflyException */ public function store(CategoryRequest $request): JsonResponse { diff --git a/app/Api/V1/Controllers/ConfigurationController.php b/app/Api/V1/Controllers/ConfigurationController.php index 28d7e61d61..efc79a3615 100644 --- a/app/Api/V1/Controllers/ConfigurationController.php +++ b/app/Api/V1/Controllers/ConfigurationController.php @@ -74,23 +74,6 @@ class ConfigurationController extends Controller return response()->json(['data' => $configData])->header('Content-Type', self::CONTENT_TYPE); } - /** - * Update the configuration. - * - * @param ConfigurationRequest $request - * @param string $name - * - * @return JsonResponse - */ - public function update(ConfigurationRequest $request, string $name): JsonResponse - { - $data = $request->getAll(); - app('fireflyconfig')->set($name, $data['value']); - $configData = $this->getConfigData(); - - return response()->json(['data' => $configData])->header('Content-Type', self::CONTENT_TYPE); - } - /** * Get all config values. * @@ -114,4 +97,21 @@ class ConfigurationController extends Controller 'single_user_mode' => null === $singleUser ? null : $singleUser->data, ]; } + + /** + * Update the configuration. + * + * @param ConfigurationRequest $request + * @param string $name + * + * @return JsonResponse + */ + public function update(ConfigurationRequest $request, string $name): JsonResponse + { + $data = $request->getAll(); + app('fireflyconfig')->set($name, $data['value']); + $configData = $this->getConfigData(); + + return response()->json(['data' => $configData])->header('Content-Type', self::CONTENT_TYPE); + } } diff --git a/app/Api/V1/Controllers/Controller.php b/app/Api/V1/Controllers/Controller.php index 32ba1a0176..ebfe70a9b3 100644 --- a/app/Api/V1/Controllers/Controller.php +++ b/app/Api/V1/Controllers/Controller.php @@ -44,9 +44,8 @@ abstract class Controller extends BaseController { use AuthorizesRequests, DispatchesJobs, ValidatesRequests; - protected ParameterBag $parameters; - protected const CONTENT_TYPE = 'application/vnd.api+json'; + protected ParameterBag $parameters; /** * Controller constructor. @@ -66,43 +65,6 @@ abstract class Controller extends BaseController } - /** - * Method to help build URI's. - * - * @return string - */ - final protected function buildParams(): string - { - $return = '?'; - $params = []; - foreach ($this->parameters as $key => $value) { - if ('page' === $key) { - continue; - } - if ($value instanceof Carbon) { - $params[$key] = $value->format('Y-m-d'); - continue; - } - $params[$key] = $value; - } - $return .= http_build_query($params); - - return $return; - } - - /** - * @return Manager - */ - final protected function getManager(): Manager - { - // create some objects: - $manager = new Manager; - $baseUrl = request()->getSchemeAndHttpHost() . '/api/v1'; - $manager->setSerializer(new JsonApiSerializer($baseUrl)); - - return $manager; - } - /** * Method to grab all parameters from the URI. * @@ -145,4 +107,41 @@ abstract class Controller extends BaseController return $bag; } + + /** + * Method to help build URI's. + * + * @return string + */ + final protected function buildParams(): string + { + $return = '?'; + $params = []; + foreach ($this->parameters as $key => $value) { + if ('page' === $key) { + continue; + } + if ($value instanceof Carbon) { + $params[$key] = $value->format('Y-m-d'); + continue; + } + $params[$key] = $value; + } + $return .= http_build_query($params); + + return $return; + } + + /** + * @return Manager + */ + final protected function getManager(): Manager + { + // create some objects: + $manager = new Manager; + $baseUrl = request()->getSchemeAndHttpHost() . '/api/v1'; + $manager->setSerializer(new JsonApiSerializer($baseUrl)); + + return $manager; + } } diff --git a/app/Api/V1/Controllers/CurrencyController.php b/app/Api/V1/Controllers/CurrencyController.php index 1f8a9a709d..029fb77e88 100644 --- a/app/Api/V1/Controllers/CurrencyController.php +++ b/app/Api/V1/Controllers/CurrencyController.php @@ -37,7 +37,6 @@ use FireflyIII\Repositories\Account\AccountRepositoryInterface; use FireflyIII\Repositories\Bill\BillRepositoryInterface; use FireflyIII\Repositories\Budget\AvailableBudgetRepositoryInterface; use FireflyIII\Repositories\Budget\BudgetLimitRepositoryInterface; -use FireflyIII\Repositories\Budget\BudgetRepositoryInterface; use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface; use FireflyIII\Repositories\Recurring\RecurringRepositoryInterface; use FireflyIII\Repositories\Rule\RuleRepositoryInterface; @@ -198,7 +197,7 @@ class CurrencyController extends Controller $manager = $this->getManager(); /** @var BillRepositoryInterface $billRepos */ - $billRepos = app(BillRepositoryInterface::class); + $billRepos = app(BillRepositoryInterface::class); $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data; $unfiltered = $billRepos->getBills(); @@ -450,7 +449,7 @@ class CurrencyController extends Controller // get list of budgets. Count it and split it. /** @var RecurringRepositoryInterface $recurringRepos */ $recurringRepos = app(RecurringRepositoryInterface::class); - $unfiltered = $recurringRepos->getAll(); + $unfiltered = $recurringRepos->getAll(); // filter selection $collection = $unfiltered->filter( @@ -500,7 +499,7 @@ class CurrencyController extends Controller // get list of budgets. Count it and split it. /** @var RuleRepositoryInterface $ruleRepos */ - $ruleRepos = app(RuleRepositoryInterface::class); + $ruleRepos = app(RuleRepositoryInterface::class); $unfiltered = $ruleRepos->getAll(); $collection = $unfiltered->filter( diff --git a/app/Api/V1/Controllers/CurrencyExchangeRateController.php b/app/Api/V1/Controllers/CurrencyExchangeRateController.php index 3bb085808a..2f4f1c4a80 100644 --- a/app/Api/V1/Controllers/CurrencyExchangeRateController.php +++ b/app/Api/V1/Controllers/CurrencyExchangeRateController.php @@ -69,8 +69,8 @@ class CurrencyExchangeRateController extends Controller * * @param Request $request * - * @throws FireflyException * @return JsonResponse + * @throws FireflyException */ public function index(Request $request): JsonResponse { diff --git a/app/Api/V1/Controllers/LinkTypeController.php b/app/Api/V1/Controllers/LinkTypeController.php index 36f5e359f6..cc1cbfd92d 100644 --- a/app/Api/V1/Controllers/LinkTypeController.php +++ b/app/Api/V1/Controllers/LinkTypeController.php @@ -80,9 +80,9 @@ class LinkTypeController extends Controller * * @param LinkType $linkType * + * @return JsonResponse * @throws FireflyException * @codeCoverageIgnore - * @return JsonResponse */ public function delete(LinkType $linkType): JsonResponse { @@ -152,8 +152,8 @@ class LinkTypeController extends Controller * * @param LinkTypeRequest $request * - * @throws FireflyException * @return JsonResponse + * @throws FireflyException */ public function store(LinkTypeRequest $request): JsonResponse { @@ -242,8 +242,8 @@ class LinkTypeController extends Controller * @param LinkTypeRequest $request * @param LinkType $linkType * - * @throws FireflyException * @return JsonResponse + * @throws FireflyException */ public function update(LinkTypeRequest $request, LinkType $linkType): JsonResponse { diff --git a/app/Api/V1/Controllers/PiggyBankController.php b/app/Api/V1/Controllers/PiggyBankController.php index d5a3c6257d..8b1133b860 100644 --- a/app/Api/V1/Controllers/PiggyBankController.php +++ b/app/Api/V1/Controllers/PiggyBankController.php @@ -204,8 +204,8 @@ class PiggyBankController extends Controller * * @param PiggyBankStoreRequest $request * - * @throws FireflyException * @return JsonResponse + * @throws FireflyException */ public function store(PiggyBankStoreRequest $request): JsonResponse { diff --git a/app/Api/V1/Controllers/RecurrenceController.php b/app/Api/V1/Controllers/RecurrenceController.php index 2ef5f5d1dd..2c85d0d8c9 100644 --- a/app/Api/V1/Controllers/RecurrenceController.php +++ b/app/Api/V1/Controllers/RecurrenceController.php @@ -151,8 +151,8 @@ class RecurrenceController extends Controller * * @param RecurrenceStoreRequest $request * - * @throws FireflyException * @return JsonResponse + * @throws FireflyException */ public function store(RecurrenceStoreRequest $request): JsonResponse { @@ -226,9 +226,9 @@ class RecurrenceController extends Controller } /** + * @return JsonResponse * @throws FireflyException * @codeCoverageIgnore - * @return JsonResponse */ public function trigger(): JsonResponse { @@ -238,7 +238,7 @@ class RecurrenceController extends Controller $result = $recurring->fire(); } catch (FireflyException $e) { Log::error($e->getMessage()); - throw new FireflyException('200022: Error in cron job.',0, $e); + throw new FireflyException('200022: Error in cron job.', 0, $e); } if (false === $result) { return response()->json([], 204); diff --git a/app/Api/V1/Controllers/SummaryController.php b/app/Api/V1/Controllers/SummaryController.php index e19ce39edc..0ec4ac1daa 100644 --- a/app/Api/V1/Controllers/SummaryController.php +++ b/app/Api/V1/Controllers/SummaryController.php @@ -101,8 +101,8 @@ class SummaryController extends Controller /** * @param DateRequest $request * - * @throws Exception * @return JsonResponse + * @throws Exception */ public function basic(DateRequest $request): JsonResponse { @@ -130,30 +130,6 @@ class SummaryController extends Controller return response()->json($return); } - /** - * Check if date is outside session range. - * - * @param Carbon $date - * - * @param Carbon $start - * @param Carbon $end - * - * @return bool - */ - protected function notInDateRange(Carbon $date, Carbon $start, Carbon $end): bool // Validate a preference - { - $result = false; - if ($start->greaterThanOrEqualTo($date) && $end->greaterThanOrEqualTo($date)) { - $result = true; - } - // start and end in the past? use $end - if ($start->lessThanOrEqualTo($date) && $end->lessThanOrEqualTo($date)) { - $result = true; - } - - return $result; - } - /** * @param Carbon $start * @param Carbon $end @@ -322,8 +298,8 @@ class SummaryController extends Controller * @param Carbon $start * @param Carbon $end * - * @throws Exception * @return array + * @throws Exception */ private function getLeftToSpendInfo(Carbon $start, Carbon $end): array { @@ -429,4 +405,28 @@ class SummaryController extends Controller return $return; } + + /** + * Check if date is outside session range. + * + * @param Carbon $date + * + * @param Carbon $start + * @param Carbon $end + * + * @return bool + */ + protected function notInDateRange(Carbon $date, Carbon $start, Carbon $end): bool // Validate a preference + { + $result = false; + if ($start->greaterThanOrEqualTo($date) && $end->greaterThanOrEqualTo($date)) { + $result = true; + } + // start and end in the past? use $end + if ($start->lessThanOrEqualTo($date) && $end->lessThanOrEqualTo($date)) { + $result = true; + } + + return $result; + } } diff --git a/app/Api/V1/Controllers/TransactionController.php b/app/Api/V1/Controllers/TransactionController.php index 2a1b310538..a7934b824c 100644 --- a/app/Api/V1/Controllers/TransactionController.php +++ b/app/Api/V1/Controllers/TransactionController.php @@ -50,6 +50,7 @@ use League\Fractal\Resource\Collection as FractalCollection; use League\Fractal\Resource\Item; use Log; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; + /** * Class TransactionController */ @@ -234,6 +235,19 @@ class TransactionController extends Controller return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE); } + /** + * Show a single transaction, by transaction journal. + * + * @param TransactionJournal $transactionJournal + * + * @return JsonResponse + * @codeCoverageIgnore + */ + public function showByJournal(TransactionJournal $transactionJournal): JsonResponse + { + return $this->show($transactionJournal->transactionGroup); + } + /** * Show a single transaction. * @@ -269,19 +283,6 @@ class TransactionController extends Controller return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE); } - /** - * Show a single transaction, by transaction journal. - * - * @param TransactionJournal $transactionJournal - * - * @return JsonResponse - * @codeCoverageIgnore - */ - public function showByJournal(TransactionJournal $transactionJournal): JsonResponse - { - return $this->show($transactionJournal->transactionGroup); - } - /** * Store a new transaction. * diff --git a/app/Api/V1/Controllers/TransactionLinkController.php b/app/Api/V1/Controllers/TransactionLinkController.php index c70fe46366..d4b3ade13d 100644 --- a/app/Api/V1/Controllers/TransactionLinkController.php +++ b/app/Api/V1/Controllers/TransactionLinkController.php @@ -157,8 +157,8 @@ class TransactionLinkController extends Controller * * @param TransactionLinkRequest $request * - * @throws FireflyException * @return JsonResponse + * @throws FireflyException */ public function store(TransactionLinkRequest $request): JsonResponse { @@ -188,8 +188,8 @@ class TransactionLinkController extends Controller * @param TransactionLinkRequest $request * @param TransactionJournalLink $journalLink * - * @throws FireflyException * @return JsonResponse + * @throws FireflyException */ public function update(TransactionLinkRequest $request, TransactionJournalLink $journalLink): JsonResponse { diff --git a/app/Api/V1/Controllers/UserController.php b/app/Api/V1/Controllers/UserController.php index 2c3f088a5b..c294deb019 100644 --- a/app/Api/V1/Controllers/UserController.php +++ b/app/Api/V1/Controllers/UserController.php @@ -68,9 +68,9 @@ class UserController extends Controller * * @param User $user * + * @return JsonResponse * @throws FireflyException * @codeCoverageIgnore - * @return JsonResponse */ public function delete(User $user): JsonResponse {