Initial commit

Author: mjpakzad

.gitignore

@@ -0,0 +1 @@
+/vendor

README.md

@@ -0,0 +1,41 @@
+# laravel-settings
+The laravel settings package let you save your settings in the database and access them easily.
+
+## install
+Add this package to your project using composer<br>
+`composer require mjpakzad/laravel-settings`
+
+Publish the migration file<br>
+`php artisan vendor:publish --provider="Mjpakzad\Settings\SettingsServiceProvider"`
+
+Migrate the new migration to create settings table<br>
+`php artisan migrate`
+
+## Usage
+Create a new setting<br>
+`set_setting($key, $value, $group, $autoload)`
+
+You can group settings for example `footer-settings` or `seo` or anything else, default value of `$group` is `null`.<br>
+Also, you can autoload some settings to load in your AppServiceProvider, default value of `$autoload` is `false`.
+examples<br>
+`set_setting('site-name', 'Laravel settings')`<br>
+`set_setting('blog-title', 'My personal blog', 'blog', true)`
+
+Get a value by key<br>
+`get_setting('site_name')`
+
+Get values by group<br>
+`setting_group('blog')`
+
+Get autoload settings<br>
+`setting_autoload($autoload)`<br>
+default value of `$autoload` is `true`
+
+Also, you can bring all settings out to config.<br>
+`setting_config()`<br>
+This function save all settings as key-value pairs in config, you can filter settings by parameters like below:<br>
+`setting_config($keys, $groups, $autoload)`<br>
+All parameters have `null` value.
+
+Now, you can access them by `config()` method:<br>
+`config('settings')`

composer.json

@@ -0,0 +1,30 @@
+{
+    "name": "mjpakzad/laravel-settings",
+    "description": "The laravel settings package let you save your settings in the database and access them easily.",
+    "homepage": "https://github.com/mjpakzad/laravel-settings",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Mj Pakzad",
+            "email": "[email protected]"
+        }
+    ],
+    "keywords": ["laravel-settings"],
+    "autoload": {
+        "files": [
+            "src/helper.php"
+        ],
+        "psr-4": {
+            "Mjpakzad\\LaravelSettings\\": "src/"
+        }
+    },
+    "minimum-stability": "dev",
+    "require": {},
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Mjpakzad\\LaravelSettings\\SettingServiceProvider"
+            ]
+        }
+    }
+}

database/migrations/create_settings_table.php.stub

@@ -0,0 +1,36 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+use Mjpakzad\LaravelSettings\Models\Setting;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('settings', function (Blueprint $table) {
+            $table->id();
+            $table->string('key');
+            $table->text('value')->nullable();
+            $table->string('group')->index()->nullable();
+            $table->boolean('autoload')->default(Setting::MANUAL);
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('settings');
+    }
+};

src/Models/Setting.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Mjpakzad\LaravelSettings\Models;
+
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * @method string group()
+ * @method string groups()
+ * @method string manual()
+ * @method string autoload()
+ */
+class Setting extends Model
+{
+    use HasFactory;
+
+    public const MANUAL     = false;
+    public const AUTOLOAD   = true;
+
+    protected $fillable = ['key', 'value', 'group', 'autoload'];
+
+    public function scopeGroup($query, $group)
+    {
+        return $query->whereGroup($group);
+    }
+
+    public function scopeGroups($query, $groups)
+    {
+        return $query->whereIn('group', $groups);
+    }
+
+    public function scopeManual($query)
+    {
+        return $query->whereAutoload(self::MANUAL);
+    }
+
+    public function scopeAutoload($query)
+    {
+        return $query->whereAutoload(self::AUTOLOAD);
+    }
+}

src/SettingServiceProvider.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Mjpakzad\LaravelSettings;
+
+use Illuminate\Support\ServiceProvider;
+
+class SettingServiceProvider extends ServiceProvider
+{
+    /**
+     * Register services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        //
+    }
+
+    /**
+     * Bootstrap services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        if($this->app->runningInConsole()) {
+            if(!class_exists('CreateSettingTable')) {
+                $this->publishes([
+                    __DIR__ . '/../database/migrations/create_settings_table.php.stub' =>
+                    database_path('migrations/' . date('Y_m_d_His', time()) . '_create_settings_table.php'),
+                ], 'migrations');
+            }
+        }
+    }
+}

src/helper.php

@@ -0,0 +1,119 @@
+<?php
+if (!function_exists('get_settings')) {
+    /**
+     * Get all autoload settings
+     */
+    function get_settings($keys = null, $groups = null, $autoload = null) {
+        $settings = \Mjpakzad\LaravelSettings\Models\Setting::query();
+        if($keys !== null) {
+            if(is_array($keys)) {
+                $settings->whereIn('key', $keys);
+            } else {
+                $settings->where('key', $keys);
+            }
+        }
+        if($groups !== null) {
+            if(is_array($groups)) {
+                $settings->whereIn('group', $groups);
+            } else {
+                $settings->where('group', $groups);
+            }
+        }
+        if($autoload !== null) {
+            if($autoload) {
+                $settings->autoload();
+            } else {
+                $settings->manual();
+            }
+        }
+        return $settings->pluck('value', 'key');
+    }
+}
+
+if (!function_exists('get_setting')) {
+    /**
+     * Get a specific setting
+     */
+    function get_setting($key) {
+        return \Mjpakzad\LaravelSettings\Models\Setting::where('key', $key)->value('value');
+    }
+}
+
+if (!function_exists('set_setting')) {
+    /**
+     * Create a new setting.
+     *
+     * @return void
+     */
+    function set_setting($key, $value, $group = null, $autoload = null) {
+        $setting = [
+            'key'       => $key,
+            'value'     => $value,
+            'autoload'  => $autoload !== null ? $autoload : false,
+        ];
+        if($group !== null) {
+            $setting['group'] = $group;
+        }
+        \Mjpakzad\LaravelSettings\Models\Setting::create($setting);
+    }
+}
+
+if (!function_exists('setting_config')) {
+    /**
+     * Save settings in config.
+     *
+     * @return void
+     */
+    function setting_config($keys = null, $groups = null, $autoload = null) {
+        config()->set('settings', get_settings($keys, $groups, $autoload)->toArray());
+    }
+}
+
+if(!function_exists('settings')) {
+    /**
+     * Creates a new setting or return settings.
+     *
+     * @param      $key
+     * @param      $value
+     * @param null $group
+     * @param null $autoload
+     *
+     * @return \Illuminate\Support\Collection|void
+     * @example setting('key'|['',], 'group'|['',], true)
+     *
+     * @example setting('site_name', 'laravel settings', 'site settings', true) creates a new settings.
+     */
+    function setting($key, $value, $group = null, $autoload = null) {
+        if($autoload !== null) {
+            set_setting($key, $value, $group, $autoload);
+        } else {
+            return get_settings($key, $value, $autoload);
+        }
+    }
+}
+
+if(!function_exists('setting_group')) {
+    /**
+     * Returns a group of settings.
+     *
+     * @param array|string $group The name of group or groups
+     */
+    function setting_group(array|string $group): \Illuminate\Support\Collection
+    {
+        return get_settings(null, $group);
+    }
+}
+
+if(!function_exists('setting_autoload')) {
+    /**
+     * Return autoload or manual settings
+     *
+     * @param bool $autoload
+     *
+     * @return \Illuminate\Support\Collection
+     */
+    function setting_autoload(bool $autoload = true): \Illuminate\Support\Collection
+    {
+        return get_settings(null, null, $autoload);
+    }
+}