Fix: Error is thrown if the key is not found in the database.

anisAronno · Oct 11, 2023 · efa0869 · efa0869
1 parent 6bb623c
commit efa0869
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 36 deletions.
diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
     "name": "anisaronno/laravel-settings",
     "description": "Laravel Settings Table",
-    "version": "0.1.1",
+    "version": "0.1.2",
     "license": "MIT",
     "keywords": [
         "laravel-settings",

diff --git a/settings.php b/settings.php
@@ -3,35 +3,32 @@
 use AnisAronno\LaravelSettings\Models\SettingsProperty;
 use Illuminate\Support\Collection;
 
-if (!function_exists('getAllSettings')) {
 
+if (!function_exists('getSettings')) {
     /**
-     * Get all Settings
+     * Get Settings
      *
-     * @return Collection
+     * @param string $key
+     * @return string|null
      * @throws Exception
      */
-    function getAllSettings(): Collection
+    function getSettings(string $key): string
     {
-        return AnisAronno\LaravelSettings\Helpers\SettingsHelper::getAllSettings();
+        return AnisAronno\LaravelSettings\Helpers\SettingsHelper::getSettings($key);
     }
 }
 
-if (!function_exists('getSettings')) {
+if (!function_exists('getAllSettings')) {
+
     /**
-     * Get Settings
+     * Get all Settings
      *
-     * @param string $key
-     * @return string|null
+     * @return Collection
      * @throws Exception
      */
-    function getSettings(string $key): ?string
+    function getAllSettings(): Collection
     {
-        try {
-            return AnisAronno\LaravelSettings\Helpers\SettingsHelper::getSettings($key);
-        } catch (\Throwable $th) {
-            return null;
-        }
+        return AnisAronno\LaravelSettings\Helpers\SettingsHelper::getAllSettings();
     }
 }
 

diff --git a/src/Helpers/SettingsHelper.php b/src/Helpers/SettingsHelper.php
@@ -20,12 +20,17 @@ public static function getSettings(string $settingsKey): string
     {
         $key = CacheHelper::getLaravelSettingsCacheKey();
 
+
         try {
             $settings = CacheHelper::init($key)->remember($settingsKey, now()->addDay(), function () use ($settingsKey) {
-                return SettingsProperty::where('settings_key', $settingsKey)->first();
-
+                return SettingsProperty::select('settings_value')->find($settingsKey);
             });
-            return $settings['settings_value'];
+
+            if(isset($settings['settings_value'])) {
+                return $settings['settings_value'];
+            } else {
+                throw new Exception('The '.$settingsKey.' key was not found in the settings table.', 404);
+            }
 
         } catch (\Throwable $th) {
             throw new Exception($th->getMessage(), 400);
@@ -43,7 +48,7 @@ public static function getSettings(string $settingsKey): string
      */
     public static function setSettings(string $key, string $value): SettingsProperty
     {
-        if(! self::issKeyAlphaDash($key, 'ascii')) {
+        if(! self::isKeyAlphaDash($key, 'ascii')) {
             throw new Exception("The settings key field must only contain letters, numbers, dashes, and underscores", 400);
         }
 
@@ -80,7 +85,7 @@ public static function setSettings(string $key, string $value): SettingsProperty
      */
     public static function upsertSettings(string $key, string $value): SettingsProperty
     {
-        if(! self::issKeyAlphaDash($key, 'ascii')) {
+        if(! self::isKeyAlphaDash($key, 'ascii')) {
             throw new Exception("The settings key field must only contain letters, numbers, dashes, and underscores", 400);
         }
 
@@ -132,7 +137,7 @@ public static function getAllSettings(): Collection
      */
     public static function updateSettings(string $key, string $value = ''): bool
     {
-        if(! self::issKeyAlphaDash($key, 'ascii')) {
+        if(! self::isKeyAlphaDash($key, 'ascii')) {
             throw new Exception("The settings key field must only contain letters, numbers, dashes, and underscores", 400);
         }
 
@@ -177,14 +182,15 @@ public static function deleteSettings(string $key): bool
     }
 
     /**
-    * Validate that an attribute contains only alpha-numeric characters, dashes, and underscores.
-    * If the 'ascii' option is passed, validate that an attribute contains only ascii alpha-numeric characters,
-    * dashes, and underscores.
-    *
-    * @param  mixed  $value
-    * @return bool
-    */
-    private static function issKeyAlphaDash($value, $parameters)
+     * Validate that an attribute contains only alpha-numeric characters, dashes, and underscores.
+     * If the 'ascii' option is passed, validate that an attribute contains only ascii alpha-numeric characters,
+     * dashes, and underscores.
+     *
+     * @param  mixed  $value
+     * @param  string  $parameters
+     * @return bool
+     */
+    private static function isKeyAlphaDash($value, string $parameters = 'ascii'): bool
     {
         if (! is_string($value) && ! is_numeric($value)) {
             return false;

diff --git a/src/Models/SettingsProperty.php b/src/Models/SettingsProperty.php
@@ -9,7 +9,7 @@
 
 /**
  * @method static where(string $string, string $settingsKey)
- * @method static select(string $string, string $string1)
+ * @method static select(string $string, string $string1='')
  * @method static updateOrCreate(string[] $array, array $array1)
  * @method static findOrFail($key)
  * @property mixed|string $settings_key
@@ -20,17 +20,17 @@ class SettingsProperty extends Model
 {
     use HasFactory;
 
-    /**
-     * @var mixed|string
-     */
-    protected $table = 'settings';
-
     protected $fillable = [
         'settings_key',
         'settings_value',
         'user_id',
     ];
 
+    /**
+     * @var mixed|string
+     */
+    protected $table = 'settings';
+
     protected $primaryKey = 'settings_key';
 
     public $incrementing = false;