Code cleanup.

2025-09-04 03:43:07 +00:00 · 2023-12-20 19:35:52 +01:00
parent c4f6366642
commit 64ec0cf62e
997 changed files with 12908 additions and 28136 deletions
--- a/app/Api/V1/Controllers/Models/Transaction/DestroyController.php
+++ b/app/Api/V1/Controllers/Models/Transaction/DestroyController.php
@@ -44,8 +44,6 @@ class DestroyController extends Controller

    /**
     * TransactionController constructor.
-     *
-
     */
    public function __construct()
    {
@@ -71,16 +69,13 @@ class DestroyController extends Controller
     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/transactions/deleteTransaction
     *
     * Remove the specified resource from storage.
-     *
-     * @param TransactionGroup $transactionGroup
-     *
-     * @return JsonResponse
     */
    public function destroy(TransactionGroup $transactionGroup): JsonResponse
    {
        app('log')->debug(sprintf('Now in %s', __METHOD__));
        // grab asset account(s) from group:
        $accounts = [];
+
        /** @var TransactionJournal $journal */
        foreach ($transactionGroup->transactionJournals as $journal) {
            /** @var Transaction $transaction */
@@ -111,10 +106,6 @@ class DestroyController extends Controller
     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/transactions/deleteTransactionJournal
     *
     * Remove the specified resource from storage.
-     *
-     * @param TransactionJournal $transactionJournal
-     *
-     * @return JsonResponse
     */
    public function destroyJournal(TransactionJournal $transactionJournal): JsonResponse
    {
--- a/app/Api/V1/Controllers/Models/Transaction/ListController.php
+++ b/app/Api/V1/Controllers/Models/Transaction/ListController.php
@@ -47,8 +47,6 @@ class ListController extends Controller

    /**
     * TransactionController constructor.
-     *
-
     */
    public function __construct()
    {
@@ -70,9 +68,6 @@ class ListController extends Controller
     * This endpoint is documented at:
     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/transactions/listAttachmentByTransaction
     *
-     * @param TransactionGroup $transactionGroup
-     *
-     * @return JsonResponse
     * @throws FireflyException
     */
    public function attachments(TransactionGroup $transactionGroup): JsonResponse
@@ -89,7 +84,7 @@ class ListController extends Controller

        // make paginator:
        $paginator = new LengthAwarePaginator($attachments, $count, $pageSize, $this->parameters->get('page'));
-        $paginator->setPath(route('api.v1.transactions.attachments', [$transactionGroup->id]) . $this->buildParams());
+        $paginator->setPath(route('api.v1.transactions.attachments', [$transactionGroup->id]).$this->buildParams());

        /** @var AttachmentTransformer $transformer */
        $transformer = app(AttachmentTransformer::class);
@@ -105,9 +100,6 @@ class ListController extends Controller
     * This endpoint is documented at:
     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/transactions/listEventByTransaction
     *
-     * @param TransactionGroup $transactionGroup
-     *
-     * @return JsonResponse
     * @throws FireflyException
     */
    public function piggyBankEvents(TransactionGroup $transactionGroup): JsonResponse
@@ -122,7 +114,7 @@ class ListController extends Controller
        $events = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
        // make paginator:
        $paginator = new LengthAwarePaginator($events, $count, $pageSize, $this->parameters->get('page'));
-        $paginator->setPath(route('api.v1.transactions.piggy-bank-events', [$transactionGroup->id]) . $this->buildParams());
+        $paginator->setPath(route('api.v1.transactions.piggy-bank-events', [$transactionGroup->id]).$this->buildParams());

        /** @var PiggyBankEventTransformer $transformer */
        $transformer = app(PiggyBankEventTransformer::class);
@@ -143,9 +135,6 @@ class ListController extends Controller
     * This endpoint is documented at:
     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/transactions/listLinksByJournal
     *
-     * @param TransactionJournal $transactionJournal
-     *
-     * @return JsonResponse
     * @throws FireflyException
     */
    public function transactionLinks(TransactionJournal $transactionJournal): JsonResponse
@@ -158,7 +147,7 @@ class ListController extends Controller

        // make paginator:
        $paginator = new LengthAwarePaginator($journalLinks, $count, $pageSize, $this->parameters->get('page'));
-        $paginator->setPath(route('api.v1.transaction-journals.transaction-links', [$transactionJournal->id]) . $this->buildParams());
+        $paginator->setPath(route('api.v1.transaction-journals.transaction-links', [$transactionJournal->id]).$this->buildParams());

        /** @var TransactionLinkTransformer $transformer */
        $transformer = app(TransactionLinkTransformer::class);
--- a/app/Api/V1/Controllers/Models/Transaction/ShowController.php
+++ b/app/Api/V1/Controllers/Models/Transaction/ShowController.php
@@ -51,9 +51,6 @@ class ShowController extends Controller
     *
     * Show all transactions.
     *
-     * @param Request $request
-     *
-     * @return JsonResponse
     * @throws FireflyException
     */
    public function index(Request $request): JsonResponse
@@ -64,6 +61,7 @@ class ShowController extends Controller

        $types   = $this->mapTransactionTypes($this->parameters->get('type'));
        $manager = $this->getManager();
+
        /** @var User $admin */
        $admin = auth()->user();

@@ -79,12 +77,13 @@ class ShowController extends Controller
            // set page to retrieve
            ->setPage($this->parameters->get('page'))
            // set types of transactions to return.
-            ->setTypes($types);
+            ->setTypes($types)
+        ;
        if (null !== $this->parameters->get('start') || null !== $this->parameters->get('end')) {
            $collector->setRange($this->parameters->get('start'), $this->parameters->get('end'));
        }
        $paginator = $collector->getPaginatedGroups();
-        $paginator->setPath(route('api.v1.transactions.index') . $this->buildParams());
+        $paginator->setPath(route('api.v1.transactions.index').$this->buildParams());
        $transactions = $paginator->getCollection();

        /** @var TransactionGroupTransformer $transformer */
@@ -102,10 +101,6 @@ class ShowController extends Controller
     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/transactions/getTransactionByJournal
     *
     * Show a single transaction, by transaction journal.
-     *
-     * @param TransactionJournal $transactionJournal
-     *
-     * @return JsonResponse
     */
    public function showJournal(TransactionJournal $transactionJournal): JsonResponse
    {
@@ -117,16 +112,14 @@ class ShowController extends Controller
     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/transactions/getTransaction
     *
     * Show a single transaction.
-     *
-     * @param TransactionGroup $transactionGroup
-     *
-     * @return JsonResponse
     */
    public function show(TransactionGroup $transactionGroup): JsonResponse
    {
        $manager = $this->getManager();
+
        /** @var User $admin */
        $admin = auth()->user();
+
        // use new group collector:
        /** @var GroupCollectorInterface $collector */
        $collector = app(GroupCollectorInterface::class);
@@ -135,12 +128,14 @@ class ShowController extends Controller
            // filter on transaction group.
            ->setTransactionGroup($transactionGroup)
            // all info needed for the API:
-            ->withAPIInformation();
+            ->withAPIInformation()
+        ;

        $selectedGroup = $collector->getGroups()->first();
        if (null === $selectedGroup) {
            throw new NotFoundHttpException();
        }
+
        /** @var TransactionGroupTransformer $transformer */
        $transformer = app(TransactionGroupTransformer::class);
        $transformer->setParameters($this->parameters);
--- a/app/Api/V1/Controllers/Models/Transaction/StoreController.php
+++ b/app/Api/V1/Controllers/Models/Transaction/StoreController.php
@@ -38,7 +38,6 @@ use Illuminate\Http\JsonResponse;
 use Illuminate\Support\Facades\Log;
 use Illuminate\Validation\ValidationException;
 use League\Fractal\Resource\Item;
-use Validator;

 /**
 * Class StoreController
@@ -51,8 +50,6 @@ class StoreController extends Controller

    /**
     * TransactionController constructor.
-     *
-
     */
    public function __construct()
    {
@@ -76,9 +73,6 @@ class StoreController extends Controller
     *
     * Store a new transaction.
     *
-     * @param StoreRequest $request
-     *
-     * @return JsonResponse
     * @throws FireflyException|ValidationException
     */
    public function store(StoreRequest $request): JsonResponse
@@ -88,22 +82,25 @@ class StoreController extends Controller
        $data['user'] = auth()->user()->id;

        Log::channel('audit')
-           ->info('Store new transaction over API.', $data);
+            ->info('Store new transaction over API.', $data)
+        ;

        try {
            $transactionGroup = $this->groupRepository->store($data);
        } catch (DuplicateTransactionException $e) { // @phpstan-ignore-line
            app('log')->warning('Caught a duplicate transaction. Return error message.');
-            $validator = Validator::make(
+            $validator = \Validator::make(
                ['transactions' => [['description' => $e->getMessage()]]],
                ['transactions.0.description' => new IsDuplicateTransaction()]
            );
+
            throw new ValidationException($validator); // @phpstan-ignore-line
        } catch (FireflyException $e) { // @phpstan-ignore-line
            app('log')->warning('Caught an exception. Return error message.');
            app('log')->error($e->getMessage());
            $message   = sprintf('Internal exception: %s', $e->getMessage());
-            $validator = Validator::make(['transactions' => [['description' => $message]]], ['transactions.0.description' => new IsDuplicateTransaction()]);
+            $validator = \Validator::make(['transactions' => [['description' => $message]]], ['transactions.0.description' => new IsDuplicateTransaction()]);
+
            throw new ValidationException($validator); // @phpstan-ignore-line
        }
        app('preferences')->mark();
@@ -112,8 +109,10 @@ class StoreController extends Controller
        event(new StoredTransactionGroup($transactionGroup, $applyRules, $fireWebhooks));

        $manager = $this->getManager();
+
        /** @var User $admin */
        $admin = auth()->user();
+
        // use new group collector:
        /** @var GroupCollectorInterface $collector */
        $collector = app(GroupCollectorInterface::class);
@@ -122,12 +121,14 @@ class StoreController extends Controller
            // filter on transaction group.
            ->setTransactionGroup($transactionGroup)
            // all info needed for the API:
-            ->withAPIInformation();
+            ->withAPIInformation()
+        ;

        $selectedGroup = $collector->getGroups()->first();
        if (null === $selectedGroup) {
            throw new FireflyException('200032: Cannot find transaction. Possibly, a rule deleted this transaction after its creation.');
        }
+
        /** @var TransactionGroupTransformer $transformer */
        $transformer = app(TransactionGroupTransformer::class);
        $transformer->setParameters($this->parameters);
--- a/app/Api/V1/Controllers/Models/Transaction/UpdateController.php
+++ b/app/Api/V1/Controllers/Models/Transaction/UpdateController.php
@@ -44,8 +44,6 @@ class UpdateController extends Controller

    /**
     * TransactionController constructor.
-     *
-
     */
    public function __construct()
    {
@@ -68,11 +66,6 @@ class UpdateController extends Controller
     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/transactions/updateTransaction
     *
     * Update a transaction.
-     *
-     * @param UpdateRequest    $request
-     * @param TransactionGroup $transactionGroup
-     *
-     * @return JsonResponse
     */
    public function update(UpdateRequest $request, TransactionGroup $transactionGroup): JsonResponse
    {
@@ -89,6 +82,7 @@ class UpdateController extends Controller

        /** @var User $admin */
        $admin = auth()->user();
+
        // use new group collector:
        /** @var GroupCollectorInterface $collector */
        $collector = app(GroupCollectorInterface::class);
@@ -97,12 +91,14 @@ class UpdateController extends Controller
            // filter on transaction group.
            ->setTransactionGroup($transactionGroup)
            // all info needed for the API:
-            ->withAPIInformation();
+            ->withAPIInformation()
+        ;

        $selectedGroup = $collector->getGroups()->first();
        if (null === $selectedGroup) {
            throw new NotFoundHttpException();
        }
+
        /** @var TransactionGroupTransformer $transformer */
        $transformer = app(TransactionGroupTransformer::class);
        $transformer->setParameters($this->parameters);