chore: code cleanup.

app/Api/V1/Controllers/Autocomplete/AccountController.php

@@ -92,7 +92,11 @@ class AccountController extends Controller
 
             if (in_array($account->accountType->type, $this->balanceTypes, true)) {
                 $balance         = app('steam')->balance($account, $date);
-                $nameWithBalance = sprintf('%s (%s)', $account->name, app('amount')->formatAnything($currency, $balance, false));
+                $nameWithBalance = sprintf(
+                    '%s (%s)',
+                    $account->name,
+                    app('amount')->formatAnything($currency, $balance, false)
+                );
             }
 
             $return[] = [
@@ -113,10 +117,10 @@ class AccountController extends Controller
         usort(
             $return,
             function ($a, $b) use ($order) {
-                $pos_a = array_search($a['type'], $order, true);
-                $pos_b = array_search($b['type'], $order, true);
+                $posA = array_search($a['type'], $order, true);
+                $posB = array_search($b['type'], $order, true);
 
-                return $pos_a - $pos_b;
+                return $posA - $posB;
             }
         );
 

app/Api/V1/Controllers/Controller.php

@@ -74,6 +74,42 @@ abstract class Controller extends BaseController
         );
     }
 
+    /**
+     * Method to help build URL'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 $return.http_build_query($params);
+    }
+
+    /**
+     * @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 URL.
      *
@@ -110,7 +146,13 @@ abstract class Controller extends BaseController
                     $obj = Carbon::parse($date);
                 } catch (InvalidDateException|InvalidFormatException $e) {
                     // don't care
-                    app('log')->warning(sprintf('Ignored invalid date "%s" in API controller parameter check: %s', substr($date, 0, 20), $e->getMessage()));
+                    app('log')->warning(
+                        sprintf(
+                            'Ignored invalid date "%s" in API controller parameter check: %s',
+                            substr($date, 0, 20),
+                            $e->getMessage()
+                        )
+                    );
                 }
             }
             $bag->set($field, $obj);
@@ -169,41 +211,4 @@ abstract class Controller extends BaseController
 
         return $bag;
     }
-
-
-    /**
-     * Method to help build URL'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 $return.http_build_query($params);
-    }
-
-    /**
-     * @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;
-    }
 }

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

@@ -201,91 +201,6 @@ class DestroyController extends Controller
         return response()->json([], 204);
     }
 
-    /**
-     *
-     */
-    private function destroyBudgets(): void
-    {
-        /** @var AvailableBudgetRepositoryInterface $abRepository */
-        $abRepository = app(AvailableBudgetRepositoryInterface::class);
-        $abRepository->destroyAll();
-
-        /** @var BudgetLimitRepositoryInterface $blRepository */
-        $blRepository = app(BudgetLimitRepositoryInterface::class);
-        $blRepository->destroyAll();
-
-        /** @var BudgetRepositoryInterface $budgetRepository */
-        $budgetRepository = app(BudgetRepositoryInterface::class);
-        $budgetRepository->destroyAll();
-    }
-
-    /**
-     *
-     */
-    private function destroyBills(): void
-    {
-        /** @var BillRepositoryInterface $repository */
-        $repository = app(BillRepositoryInterface::class);
-        $repository->destroyAll();
-    }
-
-    /**
-     *
-     */
-    private function destroyPiggyBanks(): void
-    {
-        /** @var PiggyBankRepositoryInterface $repository */
-        $repository = app(PiggyBankRepositoryInterface::class);
-        $repository->destroyAll();
-    }
-
-    /**
-     *
-     */
-    private function destroyRules(): void
-    {
-        /** @var RuleGroupRepositoryInterface $repository */
-        $repository = app(RuleGroupRepositoryInterface::class);
-        $repository->destroyAll();
-    }
-
-    /**
-     *
-     */
-    private function destroyRecurringTransactions(): void
-    {
-        /** @var RecurringRepositoryInterface $repository */
-        $repository = app(RecurringRepositoryInterface::class);
-        $repository->destroyAll();
-    }
-
-    /**
-     *
-     */
-    private function destroyCategories(): void
-    {
-        /** @var CategoryRepositoryInterface $categoryRepos */
-        $categoryRepos = app(CategoryRepositoryInterface::class);
-        $categoryRepos->destroyAll();
-    }
-
-    /**
-     *
-     */
-    private function destroyTags(): void
-    {
-        /** @var TagRepositoryInterface $tagRepository */
-        $tagRepository = app(TagRepositoryInterface::class);
-        $tagRepository->destroyAll();
-    }
-
-    private function destroyObjectGroups(): void
-    {
-        /** @var ObjectGroupRepositoryInterface $repository */
-        $repository = app(ObjectGroupRepositoryInterface::class);
-        $repository->deleteAll();
-    }
-
     /**
      * @param  array  $types
      */
@@ -311,6 +226,91 @@ class DestroyController extends Controller
         }
     }
 
+    /**
+     *
+     */
+    private function destroyBills(): void
+    {
+        /** @var BillRepositoryInterface $repository */
+        $repository = app(BillRepositoryInterface::class);
+        $repository->destroyAll();
+    }
+
+    /**
+     *
+     */
+    private function destroyBudgets(): void
+    {
+        /** @var AvailableBudgetRepositoryInterface $abRepository */
+        $abRepository = app(AvailableBudgetRepositoryInterface::class);
+        $abRepository->destroyAll();
+
+        /** @var BudgetLimitRepositoryInterface $blRepository */
+        $blRepository = app(BudgetLimitRepositoryInterface::class);
+        $blRepository->destroyAll();
+
+        /** @var BudgetRepositoryInterface $budgetRepository */
+        $budgetRepository = app(BudgetRepositoryInterface::class);
+        $budgetRepository->destroyAll();
+    }
+
+    /**
+     *
+     */
+    private function destroyCategories(): void
+    {
+        /** @var CategoryRepositoryInterface $categoryRepos */
+        $categoryRepos = app(CategoryRepositoryInterface::class);
+        $categoryRepos->destroyAll();
+    }
+
+    private function destroyObjectGroups(): void
+    {
+        /** @var ObjectGroupRepositoryInterface $repository */
+        $repository = app(ObjectGroupRepositoryInterface::class);
+        $repository->deleteAll();
+    }
+
+    /**
+     *
+     */
+    private function destroyPiggyBanks(): void
+    {
+        /** @var PiggyBankRepositoryInterface $repository */
+        $repository = app(PiggyBankRepositoryInterface::class);
+        $repository->destroyAll();
+    }
+
+    /**
+     *
+     */
+    private function destroyRecurringTransactions(): void
+    {
+        /** @var RecurringRepositoryInterface $repository */
+        $repository = app(RecurringRepositoryInterface::class);
+        $repository->destroyAll();
+    }
+
+    /**
+     *
+     */
+    private function destroyRules(): void
+    {
+        /** @var RuleGroupRepositoryInterface $repository */
+        $repository = app(RuleGroupRepositoryInterface::class);
+        $repository->destroyAll();
+    }
+
+    /**
+     *
+     */
+    private function destroyTags(): void
+    {
+        /** @var TagRepositoryInterface $tagRepository */
+        $tagRepository = app(TagRepositoryInterface::class);
+        $tagRepository->destroyAll();
+    }
+
     /**
      * @param  array  $types
      */

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

@@ -69,34 +69,6 @@ class ExportController extends Controller
         return $this->returnExport('accounts');
     }
 
-    /**
-     * @param  string  $key
-     *
-     * @return LaravelResponse
-     * @throws FireflyException
-     */
-    private function returnExport(string $key): LaravelResponse
-    {
-        $date     = date('Y-m-d-H-i-s');
-        $fileName = sprintf('%s-export-%s.csv', $date, $key);
-        $data     = $this->exporter->export();
-
-        /** @var LaravelResponse $response */
-        $response = response($data[$key]);
-        $response
-            ->header('Content-Description', 'File Transfer')
-            ->header('Content-Type', 'application/octet-stream')
-            ->header('Content-Disposition', 'attachment; filename='.$fileName)
-            ->header('Content-Transfer-Encoding', 'binary')
-            ->header('Connection', 'Keep-Alive')
-            ->header('Expires', '0')
-            ->header('Cache-Control', 'must-revalidate, post-check=0, pre-check=0')
-            ->header('Pragma', 'public')
-            ->header('Content-Length', (string)strlen($data[$key]));
-
-        return $response;
-    }
-
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/exportBills
@@ -228,4 +200,32 @@ class ExportController extends Controller
 
         return $this->returnExport('transactions');
     }
+
+    /**
+     * @param  string  $key
+     *
+     * @return LaravelResponse
+     * @throws FireflyException
+     */
+    private function returnExport(string $key): LaravelResponse
+    {
+        $date     = date('Y-m-d-H-i-s');
+        $fileName = sprintf('%s-export-%s.csv', $date, $key);
+        $data     = $this->exporter->export();
+
+        /** @var LaravelResponse $response */
+        $response = response($data[$key]);
+        $response
+            ->header('Content-Description', 'File Transfer')
+            ->header('Content-Type', 'application/octet-stream')
+            ->header('Content-Disposition', 'attachment; filename='.$fileName)
+            ->header('Content-Transfer-Encoding', 'binary')
+            ->header('Connection', 'Keep-Alive')
+            ->header('Expires', '0')
+            ->header('Cache-Control', 'must-revalidate, post-check=0, pre-check=0')
+            ->header('Pragma', 'public')
+            ->header('Content-Length', (string)strlen($data[$key]));
+
+        return $response;
+    }
 }

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

@@ -43,6 +43,7 @@ class PurgeController extends Controller
      * TODO cleanup and use repositories.
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/purgeData
+     *
      * @return JsonResponse
      */
     public function purge(): JsonResponse

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

@@ -29,8 +29,8 @@ use FireflyIII\Models\Account;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
 use FireflyIII\Transformers\AccountTransformer;
 use Illuminate\Http\JsonResponse;
-use League\Fractal\Resource\Item;
 use Illuminate\Support\Facades\Log;
+use League\Fractal\Resource\Item;
 use Preferences;
 
 /**

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

@@ -34,8 +34,8 @@ use FireflyIII\Transformers\AttachmentTransformer;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
-use League\Fractal\Resource\Item;
 use Illuminate\Support\Facades\Log;
+use League\Fractal\Resource\Item;
 
 /**
  * Class StoreController

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

@@ -97,21 +97,6 @@ class ShowController extends Controller
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }
 
-    /**
-     * This endpoint is documented at:
-     * 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
-    {
-        return $this->show($transactionJournal->transactionGroup);
-    }
-
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/transactions/getTransaction
@@ -148,4 +133,19 @@ class ShowController extends Controller
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }
+
+    /**
+     * This endpoint is documented at:
+     * 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
+    {
+        return $this->show($transactionJournal->transactionGroup);
+    }
 }

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

@@ -35,9 +35,9 @@ use FireflyIII\Support\Http\Api\TransactionFilter;
 use FireflyIII\Transformers\TransactionGroupTransformer;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Facades\Log;
 use Illuminate\Validation\ValidationException;
 use League\Fractal\Resource\Item;
-use Illuminate\Support\Facades\Log;
 use Validator;
 
 /**

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

@@ -32,8 +32,8 @@ use FireflyIII\Repositories\TransactionGroup\TransactionGroupRepositoryInterface
 use FireflyIII\Transformers\TransactionGroupTransformer;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
-use League\Fractal\Resource\Item;
 use Illuminate\Support\Facades\Log;
+use League\Fractal\Resource\Item;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
 /**

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

@@ -97,6 +97,35 @@ class UpdateController extends Controller
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }
 
+    /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/currencies/enableCurrency
+     *
+     * Enable a currency.
+     *
+     * @param  TransactionCurrency  $currency
+     *
+     * @return JsonResponse
+     * @throws FireflyException
+     * @throws JsonException
+     */
+    public function enable(TransactionCurrency $currency): JsonResponse
+    {
+        $this->repository->enable($currency);
+        $manager = $this->getManager();
+
+        $defaultCurrency = app('amount')->getDefaultCurrencyByUser(auth()->user());
+        $this->parameters->set('defaultCurrency', $defaultCurrency);
+
+        /** @var CurrencyTransformer $transformer */
+        $transformer = app(CurrencyTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new Item($currency, $transformer, 'currencies');
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+    }
+
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/currencies/defaultCurrency
@@ -128,35 +157,6 @@ class UpdateController extends Controller
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }
 
-    /**
-     * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/currencies/enableCurrency
-     *
-     * Enable a currency.
-     *
-     * @param  TransactionCurrency  $currency
-     *
-     * @return JsonResponse
-     * @throws FireflyException
-     * @throws JsonException
-     */
-    public function enable(TransactionCurrency $currency): JsonResponse
-    {
-        $this->repository->enable($currency);
-        $manager = $this->getManager();
-
-        $defaultCurrency = app('amount')->getDefaultCurrencyByUser(auth()->user());
-        $this->parameters->set('defaultCurrency', $defaultCurrency);
-
-        /** @var CurrencyTransformer $transformer */
-        $transformer = app(CurrencyTransformer::class);
-        $transformer->setParameters($this->parameters);
-
-        $resource = new Item($currency, $transformer, 'currencies');
-
-        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
-    }
-
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/currencies/updateCurrency

app/Api/V1/Controllers/Search/AccountController.php

@@ -32,10 +32,10 @@ use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 use Illuminate\Http\Response;
 use Illuminate\Pagination\LengthAwarePaginator;
+use Illuminate\Support\Facades\Log;
 use JsonException;
 use League\Fractal\Pagination\IlluminatePaginatorAdapter;
 use League\Fractal\Resource\Collection as FractalCollection;
-use Illuminate\Support\Facades\Log;
 
 /**
  * Class AccountController
@@ -61,6 +61,7 @@ class AccountController extends Controller
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/search/searchAccounts
+     *
      * @param  Request  $request
      *
      * @return JsonResponse|Response

app/Api/V1/Controllers/Summary/BasicController.php

@@ -121,6 +121,30 @@ class BasicController 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
@@ -399,28 +423,4 @@ class BasicController 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;
-    }
 }

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

@@ -94,42 +94,6 @@ class ConfigurationController extends Controller
         return response()->json($return);
     }
 
-    /**
-     * Get all config values.
-     *
-     * @return array
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
-     */
-    private function getDynamicConfiguration(): array
-    {
-        $isDemoSite  = app('fireflyconfig')->get('is_demo_site');
-        $updateCheck = app('fireflyconfig')->get('permission_update_check');
-        $lastCheck   = app('fireflyconfig')->get('last_update_check');
-        $singleUser  = app('fireflyconfig')->get('single_user_mode');
-
-        return [
-            'is_demo_site'            => $isDemoSite?->data,
-            'permission_update_check' => null === $updateCheck ? null : (int)$updateCheck->data,
-            'last_update_check'       => null === $lastCheck ? null : (int)$lastCheck->data,
-            'single_user_mode'        => $singleUser?->data,
-        ];
-    }
-
-    /**
-     * @return array
-     */
-    private function getStaticConfiguration(): array
-    {
-        $list   = EitherConfigKey::$static;
-        $return = [];
-        foreach ($list as $key) {
-            $return[$key] = config($key);
-        }
-
-        return $return;
-    }
-
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/configuration/getSingleConfiguration
@@ -200,4 +164,40 @@ class ConfigurationController extends Controller
 
         return response()->json(['data' => $data])->header('Content-Type', self::CONTENT_TYPE);
     }
+
+    /**
+     * Get all config values.
+     *
+     * @return array
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
+     */
+    private function getDynamicConfiguration(): array
+    {
+        $isDemoSite  = app('fireflyconfig')->get('is_demo_site');
+        $updateCheck = app('fireflyconfig')->get('permission_update_check');
+        $lastCheck   = app('fireflyconfig')->get('last_update_check');
+        $singleUser  = app('fireflyconfig')->get('single_user_mode');
+
+        return [
+            'is_demo_site'            => $isDemoSite?->data,
+            'permission_update_check' => null === $updateCheck ? null : (int)$updateCheck->data,
+            'last_update_check'       => null === $lastCheck ? null : (int)$lastCheck->data,
+            'single_user_mode'        => $singleUser?->data,
+        ];
+    }
+
+    /**
+     * @return array
+     */
+    private function getStaticConfiguration(): array
+    {
+        $list   = EitherConfigKey::$static;
+        $return = [];
+        foreach ($list as $key) {
+            $return[$key] = config($key);
+        }
+
+        return $return;
+    }
 }

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

@@ -57,7 +57,7 @@ class CronController extends Controller
         if (true === config('cer.enabled')) {
             $return['exchange_rates'] = $this->exchangeRatesCronJob($config['force'], $config['date']);
         }
-        $return['bill_warnings']          = $this->billWarningCronJob($config['force'], $config['date']);
+        $return['bill_warnings'] = $this->billWarningCronJob($config['force'], $config['date']);
 
         return response()->json($return);
     }

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

@@ -122,6 +122,7 @@ class ShowController extends Controller
      *
      * @param  Webhook  $webhook
      * @param  TransactionGroup  $group
+     *
      * @return JsonResponse
      */
     public function triggerTransaction(Webhook $webhook, TransactionGroup $group): JsonResponse
@@ -141,6 +142,7 @@ class ShowController extends Controller
 
         // trigger event to send them:
         event(new RequestedSendWebhookMessages());
+
         return response()->json([], 204);
     }
 }