Chore: Add phpdocs

app/Api/V1/Controllers/Data/DestroyController.php

@@ -279,6 +279,9 @@ class DestroyController extends Controller
         $tagRepository->destroyAll();
     }
 
+    /**
+     * @return void
+     */
     private function destroyObjectGroups(): void
     {
         /** @var ObjectGroupRepositoryInterface $repository */

app/Api/V1/Controllers/Data/Export/ExportController.php

@@ -29,6 +29,8 @@ use FireflyIII\Api\V1\Requests\Data\Export\ExportRequest;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Support\Export\ExportDataGenerator;
 use Illuminate\Http\Response as LaravelResponse;
+use Psr\Container\ContainerExceptionInterface;
+use Psr\Container\NotFoundExceptionInterface;
 
 /**
  * Class ExportController
@@ -74,6 +76,8 @@ class ExportController extends Controller
      *
      * @return LaravelResponse
      * @throws FireflyException
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
      */
     private function returnExport(string $key): LaravelResponse
     {

app/Api/V1/Controllers/Data/PurgeController.php

@@ -37,6 +37,9 @@ use FireflyIII\Models\TransactionGroup;
 use FireflyIII\Models\TransactionJournal;
 use Illuminate\Http\JsonResponse;
 
+/**
+ * Class PurgeController
+ */
 class PurgeController extends Controller
 {
     /**
@@ -60,7 +63,7 @@ class PurgeController extends Controller
 
         // piggies
         $set = PiggyBank::leftJoin('accounts', 'accounts.id', 'piggy_banks.account_id')
-                        ->where('accounts.user_id', $user->id)->onlyTrashed()->get(['piggy_banks.*']);
+            ->where('accounts.user_id', $user->id)->onlyTrashed()->get(['piggy_banks.*']);
         /** @var PiggyBank $piggy */
         foreach ($set as $piggy) {
             $piggy->forceDelete();

app/Api/V1/Controllers/Models/TransactionLink/DestroyController.php

@@ -30,6 +30,9 @@ use FireflyIII\Repositories\LinkType\LinkTypeRepositoryInterface;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 
+/**
+ * Class DestroyController
+ */
 class DestroyController extends Controller
 {
     private LinkTypeRepositoryInterface $repository;

app/Api/V1/Controllers/Models/TransactionLink/ShowController.php

@@ -37,6 +37,9 @@ use League\Fractal\Pagination\IlluminatePaginatorAdapter;
 use League\Fractal\Resource\Collection as FractalCollection;
 use League\Fractal\Resource\Item;
 
+/**
+ * Class ShowController
+ */
 class ShowController extends Controller
 {
     private LinkTypeRepositoryInterface $repository;

app/Api/V1/Controllers/Models/TransactionLink/StoreController.php

@@ -35,6 +35,9 @@ use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use League\Fractal\Resource\Item;
 
+/**
+ * Class StoreController
+ */
 class StoreController extends Controller
 {
     use TransactionFilter;

app/Api/V1/Controllers/Models/TransactionLink/UpdateController.php

@@ -34,6 +34,9 @@ use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use League\Fractal\Resource\Item;
 
+/**
+ * Class UpdateController
+ */
 class UpdateController extends Controller
 {
     private JournalRepositoryInterface  $journalRepository;

app/Api/V1/Controllers/System/ConfigurationController.php

@@ -138,7 +138,6 @@ class ConfigurationController extends Controller
      *
      * @return JsonResponse
      * @throws ContainerExceptionInterface
-     * @throws FireflyException
      * @throws NotFoundExceptionInterface
      */
     public function show(string $configKey): JsonResponse

app/Api/V1/Controllers/System/CronController.php

@@ -28,6 +28,8 @@ use FireflyIII\Api\V1\Requests\System\CronRequest;
 use FireflyIII\Support\Http\Controllers\CronRunner;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Support\Facades\Log;
+use Psr\Container\ContainerExceptionInterface;
+use Psr\Container\NotFoundExceptionInterface;
 
 /**
  * Class CronController
@@ -41,9 +43,11 @@ class CronController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/about/getCron
      *
      * @param CronRequest $request
-     * @param string      $token
+     * @param string $token
      *
      * @return JsonResponse
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
      */
     public function cron(CronRequest $request, string $token): JsonResponse
     {

app/Api/V1/Controllers/Webhook/MessageController.php

@@ -35,6 +35,9 @@ use League\Fractal\Pagination\IlluminatePaginatorAdapter;
 use League\Fractal\Resource\Collection as FractalCollection;
 use League\Fractal\Resource\Item;
 
+/**
+ * Class MessageController
+ */
 class MessageController extends Controller
 {
     public const RESOURCE_KEY = 'webhook_messages';

app/Api/V1/Requests/Data/Export/ExportRequest.php

@@ -38,6 +38,9 @@ class ExportRequest extends FormRequest
     use ChecksLogin;
     use ConvertsDataTypes;
 
+    /**
+     * @return array
+     */
     public function getAll(): array
     {
         $result     = [

app/Api/V1/Requests/Models/Transaction/UpdateRequest.php

@@ -59,6 +59,7 @@ class UpdateRequest extends FormRequest
      * Get all data. Is pretty complex because of all the ??-statements.
      *
      * @return array
+     * @throws FireflyException
      */
     public function getAll(): array
     {
@@ -152,6 +153,7 @@ class UpdateRequest extends FormRequest
      * Get transaction data.
      *
      * @return array
+     * @throws FireflyException
      */
     private function getTransactionData(): array
     {

app/Api/V1/Requests/User/PreferenceStoreRequest.php

@@ -27,6 +27,9 @@ use FireflyIII\Support\Request\ChecksLogin;
 use FireflyIII\Support\Request\ConvertsDataTypes;
 use Illuminate\Foundation\Http\FormRequest;
 
+/**
+ * Class PreferenceStoreRequest
+ */
 class PreferenceStoreRequest extends FormRequest
 {
     use ChecksLogin;

app/Api/V1/Requests/User/PreferenceUpdateRequest.php

@@ -28,6 +28,9 @@ use FireflyIII\Support\Request\ChecksLogin;
 use FireflyIII\Support\Request\ConvertsDataTypes;
 use Illuminate\Foundation\Http\FormRequest;
 
+/**
+ * Class PreferenceUpdateRequest
+ */
 class PreferenceUpdateRequest extends FormRequest
 {
     use ChecksLogin;

app/Api/V2/Controllers/Model/Budget/ListController.php

@@ -31,6 +31,9 @@ use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 use Illuminate\Pagination\LengthAwarePaginator;
 
+/**
+ * Class ListController
+ */
 class ListController extends Controller
 {
     private BudgetRepositoryInterface $repository;

app/Api/V2/Controllers/Model/BudgetLimit/ListController.php

@@ -32,6 +32,9 @@ use FireflyIII\Transformers\V2\BudgetLimitTransformer;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Pagination\LengthAwarePaginator;
 
+/**
+ * Class ListController
+ */
 class ListController extends Controller
 {
     private BudgetLimitRepositoryInterface $repository;

app/Api/V2/Controllers/System/ConfigurationController.php

@@ -24,6 +24,9 @@ declare(strict_types=1);
 
 namespace FireflyIII\Api\V2\Controllers\System;
 
+/**
+ * Class ConfigurationController
+ */
 class ConfigurationController
 {
 }

app/Api/V2/Controllers/System/DebugController.php

@@ -26,6 +26,9 @@ namespace FireflyIII\Api\V2\Controllers\System;
 
 use FireflyIII\Api\V2\Controllers\Controller;
 
+/**
+ * Class DebugController
+ */
 class DebugController extends Controller
 {
 }