Refactor Options to a Setting service bound with the service container

app/Http/Controllers/SettingController.php

@@ -0,0 +1,164 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use App\Http\Requests\SettingStoreRequest;
+use App\Http\Requests\SettingUpdateRequest;
+use App\Services\SettingServiceInterface;
+use Illuminate\Http\Request;
+use App\Classes\DbProtection;
+use App\Http\Controllers\Controller;
+use Illuminate\Support\Collection;
+
+
+class SettingController extends Controller
+{
+
+    /**
+     * The Settings Service instance.
+     */
+    protected SettingServiceInterface $settingService;
+
+
+    /**
+     * Create a new controller instance.
+     * 
+     */
+    public function __construct(SettingServiceInterface $SettingServiceInterface)
+    {
+        $this->settingService = $SettingServiceInterface;
+    }
+
+
+    /**
+     * List all settings
+     * 
+     * @return \Illuminate\Http\Response
+     */
+    public function index()
+    {
+        $settings = $this->settingService->all();
+        $settingsResources = collect();
+        $settings->each(function ($item, $key) use ($settingsResources) {
+            $settingsResources->push([
+                'name' => $key,
+                'data' => $item
+            ]);
+        });
+
+        // return SettingResource::collection($tata);
+        return response()->json($settingsResources->all(), 200);
+    }
+
+
+    /**
+     * Display a resource
+     *
+     * @param string $name
+     * 
+     * @return \App\Http\Resources\TwoFAccountReadResource
+     */
+    public function show($name)
+    {
+        $setting = $this->settingService->get($name);
+
+        if (!$setting) {
+            abort(404);
+        }
+
+        return response()->json([
+            'name' => $name,
+            'data' => $setting
+        ], 200);
+    }
+
+
+    /**
+     * Save options
+     * @return [type] [description]
+     */
+    public function store(SettingStoreRequest $request)
+    {
+        $validated = $request->validated();
+
+        $this->settingService->set($validated['name'], $validated['data']);
+
+        return response()->json([
+            'name' => $validated['name'],
+            'data' => $validated['data']
+        ], 201);
+    }
+
+
+    /**
+     * Save options
+     * @return [type] [description]
+     */
+    public function update(SettingUpdateRequest $request, $name)
+    {
+        $validated = $request->validated();
+
+        $setting = $this->settingService->get($name);
+
+        if (is_null($setting)) {
+            abort(404);
+        }
+
+        $setting = $this->settingService->set($name, $validated['data']);
+
+        return response()->json([
+            'name' => $name,
+            'data' => $validated['data']
+        ], 200);
+
+        // The useEncryption option impacts the [existing] content of the database.
+        // Encryption/Decryption of the data is done only if the user change the value of the option
+        // to prevent successive encryption
+
+        if( $request->has('useEncryption'))
+        {
+            if( $request->useEncryption && !$this->settingService->get('useEncryption') ) {
+
+                // user enabled the encryption
+                if( !DbProtection::enable() ) {
+                    return response()->json(['message' => __('errors.error_during_encryption')], 400);
+                }
+            }
+            else if( !$request->useEncryption && $this->settingService->get('useEncryption') ) {
+
+                // user disabled the encryption
+                if( !DbProtection::disable() ) {
+                    return response()->json(['message' => __('errors.error_during_decryption')], 400);
+                }
+            }
+        }
+
+    }
+
+
+    /**
+     * Save options
+     * @return [type] [description]
+     */
+    public function destroy($name)
+    {
+        $setting = $this->settingService->get($name);
+
+        if (is_null($setting)) {
+            abort(404);
+        }
+
+        $optionsConfig = config('app.options');
+        if(array_key_exists($name, $optionsConfig)) {
+            return response()->json(
+                ['message' => 'bad request',
+                'reason' => [__('errors.delete_user_setting_only')]
+            ], 400);
+        }
+
+        $this->settingService->delete($name);
+
+        return response()->json(null, 204);
+    }
+
+}

app/Http/Controllers/Settings/OptionController.php

@@ -1,61 +0,0 @@
-<?php
-
-namespace App\Http\Controllers\Settings;
-
-use App\Classes\Options;
-use Illuminate\Http\Request;
-use App\Classes\DbProtection;
-use App\Http\Controllers\Controller;
-
-class OptionController extends Controller
-{
-
-
-    /**
-     * Get options
-     * @return [type] [description]
-     */
-    public function index()
-    {
-        // Fetch all setting values
-        $settings = Options::get();
-
-        return response()->json(['settings' => $settings], 200);
-    }
-
-
-    /**
-     * Save options
-     * @return [type] [description]
-     */
-    public function store(Request $request)
-    {
-        // The useEncryption option impacts the [existing] content of the database.
-        // Encryption/Decryption of the data is done only if the user change the value of the option
-        // to prevent successive encryption
-
-        if( isset($request->useEncryption))
-        {
-            if( $request->useEncryption && !Options::get('useEncryption') ) {
-
-                // user enabled the encryption
-                if( !DbProtection::enable() ) {
-                    return response()->json(['message' => __('errors.error_during_encryption'), 'settings' => Options::get()], 400);
-                }
-            }
-            else if( !$request->useEncryption && Options::get('useEncryption') ) {
-
-                // user disabled the encryption
-                if( !DbProtection::disable() ) {
-                    return response()->json(['message' => __('errors.error_during_decryption'), 'settings' => Options::get()], 400);
-                }
-            }
-        }
-
-        // Store all options
-        Options::store($request->all());
-
-        return response()->json(['message' => __('settings.forms.setting_saved'), 'settings' => Options::get()], 200);
-    }
-
-}

app/Http/Controllers/SinglePageController.php

@@ -2,18 +2,35 @@
 
 namespace App\Http\Controllers;
 
-use App\Classes\Options;
+use App\Services\SettingServiceInterface;
 use Illuminate\Http\Request;
+use Illuminate\Support\Collection;
 
 class SinglePageController extends Controller
 {
 
+    /**
+     * The Settings Service instance.
+     */
+    protected SettingServiceInterface $settingService;
+
+
+    /**
+     * Create a new controller instance.
+     * 
+     */
+    public function __construct(SettingServiceInterface $SettingServiceInterface)
+    {
+        $this->settingService = $SettingServiceInterface;
+    }
+
+
     /**
      * return the main view
      * @return view
      */
     public function index()
     {
-        return view('landing')->with('appSettings', Options::get()->toJson());
+        return view('landing')->with('appSettings', $this->settingService->all()->toJson());
     }
 }

app/Http/Controllers/TwoFAccountController.php

@@ -4,7 +4,6 @@ namespace App\Http\Controllers;
 
 use App\Group;
 use App\TwoFAccount;
-use App\Classes\Options;
 use App\Http\Requests\TwoFAccountReorderRequest;
 use App\Http\Requests\TwoFAccountStoreRequest;
 use App\Http\Requests\TwoFAccountUpdateRequest;