Settings

README.md

@@ -1,4 +1,4 @@
-# Easy Laravel grouped settings (stored in MYSQL) package with MoonShine Laravel Admin GUI
+# Easy laravel cached settings (stored in MYSQL) package with MoonShine Laravel Admin GUI
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/visual-ideas/laravel-site-settings.svg?style=flat-square)](https://packagist.org/packages/visual-ideas/laravel-site-settings)
 [![Total Downloads](https://img.shields.io/packagist/dt/visual-ideas/laravel-site-settings.svg?style=flat-square)](https://packagist.org/packages/visual-ideas/laravel-site-settings)
@@ -52,9 +52,11 @@ You can use this package as default laravel config() function!
 
 or Blade directive @lssconfig
 ```php
-    @lssconfig('group.setting')
+    @settings('group.setting')
 ```
 
+For PHPStorm you can set this blade directive with [This instruction](https://www.jetbrains.com/help/phpstorm/blade-page.html) 
+
 ## Usage with MoonShine Laravel Admin
 Please see [MoonShine](https://moonshine.cutcode.ru/)
 

composer.json

@@ -39,7 +39,7 @@
         "VI\\LaravelSiteSettings\\LaravelSiteSettingsProvider"
       ],
       "aliases": {
-        "LSS": "VI\\LaravelSiteSettings\\Facades\\LaravelSiteSettings"
+        "Settings": "VI\\LaravelSiteSettings\\Facades\\LaravelSiteSettings"
       }
     }
   },

database/migrations/2022_12_11_111047_create_laravel_site_setting_groups_table.php → database/migrations/2022_12_11_111047_create_settings_groups_table.php

@@ -13,14 +13,14 @@
      */
     public function up()
     {
-        Schema::create('laravel_site_setting_groups', function (Blueprint $table) {
+        Schema::create('setting_groups', function (Blueprint $table) {
             $table->id();
             $table->string('slug', 190)->unique();
             $table->string('name', 190)->nullable();
             $table->timestamps();
         });
 
-        \VI\LaravelSiteSettings\Models\LaravelSiteSettingGroup::create(['slug' =>'default', 'name' =>'Default']);
+        \VI\LaravelSiteSettings\Models\SettingGroup::create(['slug' =>'default', 'name' =>'Default']);
     }
 
     /**
@@ -30,6 +30,6 @@ public function up()
      */
     public function down()
     {
-        Schema::dropIfExists('laravel_site_setting_groups');
+        Schema::dropIfExists('setting_groups');
     }
 };

database/migrations/2022_12_11_121047_create_laravel_site_settings_table.php → database/migrations/2022_12_11_121047_create_settings_table.php

@@ -12,11 +12,10 @@
      */
     public function up()
     {
-        Schema::create('laravel_site_settings', function (Blueprint $table) {
+        Schema::create('settings', function (Blueprint $table) {
             $table->id();
 
-            $table->foreignId('laravel_site_setting_group_id')
-                ->default(1)
+            $table->foreignId('setting_group_id')
                 ->constrained()
                 ->cascadeOnDelete()
                 ->cascadeOnUpdate();
@@ -26,7 +25,7 @@ public function up()
             $table->string('value', 190);
             $table->timestamps();
 
-            $table->unique('laravel_site_setting_group_id', 'slug');
+            $table->unique('setting_group_id', 'slug');
         });
     }
 
@@ -37,6 +36,6 @@ public function up()
      */
     public function down()
     {
-        Schema::dropIfExists('laravel_site_settings');
+        Schema::dropIfExists('settings');
     }
 };

src/Facades/LaravelSiteSettings.php

@@ -8,6 +8,6 @@ class LaravelSiteSettings extends Facade
 {
     protected static function getFacadeAccessor()
     {
-        return 'LssConfig';
+        return 'settings';
     }
 }

src/LaravelSiteSettings.php

@@ -4,7 +4,7 @@
 
 use Illuminate\Contracts\Config\Repository as ConfigContract;
 use Illuminate\Support\Arr;
-use VI\LaravelSiteSettings\Models\LaravelSiteSettingGroup;
+use VI\LaravelSiteSettings\Models\SettingGroup;
 
 class LaravelSiteSettings implements ConfigContract
 {
@@ -15,7 +15,7 @@ public function __construct()
     {
 
         $this->items = cache()->rememberForever(config('laravelsitesettings.cache_key'), function () {
-            return LaravelSiteSettingGroup::all()
+            return SettingGroup::all()
                 ->load('settings')
                 ->keyBy('slug')
                 ->map(function ($group) {
@@ -46,9 +46,6 @@ public function has($key): bool
      */
     public function get($key, $default = null): mixed
     {
-        if (is_array($key)) {
-            return $this->getMany($key);
-        }
 
         return Arr::get($this->items, $key, $default);
     }
@@ -114,21 +111,4 @@ public function push($key, $value): void
         $this->set($key, $array);
     }
 
-    /**
-     * Get many configuration values.
-     *
-     * @param array $keys
-     * @return array
-     */
-    public function getMany(array $keys): array
-    {
-        $config = [];
-
-        foreach ($keys as $key => $default) {
-            $config[$key] = Arr::get($this->items, $key, $default);
-        }
-
-        return $config;
-    }
-
 }

src/LaravelSiteSettingsProvider.php

@@ -4,16 +4,16 @@
 
 use Illuminate\Support\Facades\Blade;
 use Illuminate\Support\ServiceProvider;
-use VI\LaravelSiteSettings\Models\LaravelSiteSetting;
-use VI\LaravelSiteSettings\Models\LaravelSiteSettingGroup;
+use VI\LaravelSiteSettings\Models\Setting;
+use VI\LaravelSiteSettings\Models\SettingGroup;
 use VI\LaravelSiteSettings\Observers\LSSObserver;
 
 class LaravelSiteSettingsProvider extends ServiceProvider
 {
 
     public function register()
     {
-        $this->app->bind('LssConfig', function ($app) {
+        $this->app->bind('settings', function ($app) {
             return new LaravelSiteSettings();
         });
 
@@ -38,12 +38,12 @@ public function boot()
 
         }
 
-        Blade::directive('lssconfig', function (...$expression) {
-            return "<?php echo lssconfig($expression); ?>";
+        Blade::directive('settings', function ($expression) {
+            return "<?php echo settings($expression); ?>";
         });
 
-        LaravelSiteSetting::observe(LSSObserver::class);
-        LaravelSiteSettingGroup::observe(LSSObserver::class);
+        Setting::observe(LSSObserver::class);
+        SettingGroup::observe(LSSObserver::class);
 
     }
 

src/Models/LaravelSiteSetting.php → src/Models/Setting.php

@@ -5,25 +5,20 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
-class LaravelSiteSetting extends Model
+class Setting extends Model
 {
     protected $guarded = [];
 
     protected $fillable = [
-        'laravel_site_setting_group_id',
+        'setting_group_id',
         'slug',
         'name',
         'value',
     ];
 
-    public function laravelSiteSettingGroup(): BelongsTo
+    public function settingsGroup(): BelongsTo
     {
-        return $this->belongsTo(LaravelSiteSettingGroup::class);
-    }
-
-    public function group(): BelongsTo
-    {
-        return $this->laravelSiteSettingGroup();
+        return $this->belongsTo(SettingGroup::class);
     }
 
     public function getNameHumanAttribute(): string

src/Models/LaravelSiteSettingGroup.php → src/Models/SettingGroup.php

@@ -5,7 +5,7 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 
-class LaravelSiteSettingGroup extends Model
+class SettingGroup extends Model
 {
     protected $guarded = [];
 
@@ -14,14 +14,9 @@ class LaravelSiteSettingGroup extends Model
         'name',
     ];
 
-    public function laravel_site_settings(): HasMany
-    {
-        return $this->hasMany(LaravelSiteSetting::class);
-    }
-
     public function settings(): HasMany
     {
-        return $this->laravel_site_settings();
+        return $this->hasMany(Setting::class);
     }
 
     public function getNameHumanAttribute(): string

src/helpers.php

@@ -1,7 +1,7 @@
 <?php
 
 
-if (!function_exists('lss_config')) {
+if (!function_exists('settings')) {
     /**
      * Get / set the specified configuration value.
      *
@@ -11,7 +11,7 @@
      * @param mixed $default
      * @return mixed|\Illuminate\Config\Repository
      */
-    function lss_config($key = null, $default = null)
+    function settings($key = null, $default = null)
     {
         if (is_null($key)) {
             return app('LssConfig')->all();

stubs/MoonShine/Resources/LaravelSiteSettingGroupResource.php.stub

@@ -25,7 +25,7 @@ class LaravelSiteSettingGroupResource extends Resource
         return [
             ID::make()->sortable(),
             Text::make('Slug', 'slug')->required()->sortable()->hint('a-z, 0-9, -'),
-            Text::make('Name', 'name')->nullable()->sortable(),
+            Text::make('Name', 'name')->nullable()->sortable()->hint('Не используется на сайте, только для удобства администрирования!'),
             Date::make('Updated at', 'updated_at')->sortable()->hideOnForm(),
         ];
     }

stubs/MoonShine/Resources/LaravelSiteSettingResource.php.stub

@@ -30,7 +30,7 @@ class LaravelSiteSettingResource extends Resource
                 fn($item) => $item->name_human
             )->nullable()->sortable(),
             Text::make('Slug', 'slug')->required()->sortable()->hint('a-z, 0-9, -'),
-            Text::make('Name', 'name')->nullable()->sortable(),
+            Text::make('Name', 'name')->nullable()->sortable()->hint('Не используется на сайте, только для удобства администрирования!'),
             Text::make('Value', 'value')->required()->sortable(),
             Date::make('Updated at', 'updated_at')->sortable()->hideOnForm(),
         ];