janiskelemen / laravel-setting
Laravel Settings Manager
Installs: 4 911
Dependents: 0
Suggesters: 0
Security: 0
Stars: 52
Watchers: 4
Forks: 10
Open Issues: 0
Requires
- adbario/php-dot-notation: ^3.1.1
- illuminate/support: ^8|^9|^10|^11
Requires (Dev)
- mockery/mockery: ^1.5
- orchestra/database: dev-master
- orchestra/testbench: ~7.0
- phpunit/phpunit: ^9.0
- sempro/phpunit-pretty-print: ^1.4
README
- Simple key-value storage
- Optional config file for default settings supported
- Support multi-level array (dot delimited keys) structure
- Supports storing individual user settings
- Localization supported
- Settings are cached
Installation
Via Composer
composer require janiskelemen/laravel-setting
Publish config and migration
php artisan vendor:publish --tag=setting php artisan migrate
Setup your settings config
After publishing the setting files you will find a new configuration file: config/setting.php In this config you can define your basic settings like below.
# config/setting.php return [ 'app_name' => 'My Application', 'user_limit' => 10, ];
Setting::get('app_name'); //retruns 'My Application'
You can also use multi level arrays
# config/setting.php return [ 'priorities' => [ 'low' => 1, 'medium' => 2, 'hight' => 3 ], ];
Setting::get('priorities.medium'); //retruns 2
Defining optional config values
If you want to store additional data for a particular setting you can do so using an array and name one of the parameters 'default_value' which will be the default for the setting and is what gets returned by Settings::get('app_name') in this case.
# config/setting.php return [ 'app_name' => [ 'type' => 'text', /* Optional config values */ 'max' => 255, /* Optional config values */ 'default_value' => 'My Application' /* <- This value will be returned by Setting::get('app_name') if key is not found in DB */ ], 'user_limit' => 10, ];
Setting::get('app_name'); //retruns 'My Application' // You can still access the optional parameters Setting::get('app_name.max'); //retruns 255
Get full structure with default_value keys
By suffixing your key name with a dot or by using the Setting::getWithDefaultSubKeys('app_name')
method will return all default parameters including the current value
Setting::get('app_name.'); //retruns [ 'type' => 'text', 'max' => 255, 'default_value' => 'My Application', 'value' => 'My Custom Application Name' //the value key will be added with the current value saved in the database (or default if not in database yet) ]
Scoped settings
You might want to save some settings only for a certain user. You can do this using a placeholder (_*) inside your config key name.
# config/setting.php return [ 'user_*' => [ 'dark_mode' => false, 'permissions' => [ 'read' => true, 'write' => false, ] ], ];
Set save the new setting on runtime:
// Save a new setting under user_1.dark_mode with a value of true Setting::set("user_{$user->id}.dark_mode", true);
Now you can get the value:
Setting::get("user_{$user->id}.dark_mode"); //returns true
The above will return null if the setting does not exist for this user. In order to return something else you can set a default as the second parameter:
Setting::get("user_{$otherUser->id}.dark_mode"); //returns false
Get only the changed user settings
Setting::set("user_{$otherUser->id}.dark_mode", true); Setting::set("user_{$otherUser->id}.permissions.write", true); Setting::get("user_{$otherUser->id}"); //returns [ 'dark_mode' => true, 'permissions' => [ 'write' => false ] ]
In order to get all user settings you can use the getWithDefaultSubKeys()
method or suffix the main key with a dot. The result will return a merged array with the default values from and the config while the changed values from the database will overwrite the default values.
Setting::get("user_{$otherUser->id}."); // same as Setting::getWithDefaultSubKeys("user_{$otherUser->id}"); //returns [ 'dark_mode' => true, // this value comes from the database 'permissions' => [ 'read' => true, // this value is the default from the config 'write' => false, // this value is the default from the config ] ]
Usage
Setting::get('name'); // get setting value with key 'name' // If this key is not found in DB then it will return the value defined from the config file or null if the key is also not defined in the config file. Setting::get('name', 'Joe'); // get setting value with key 'name' // return 'Joe' if the key does not exists. This will overwrite the default coming from the config file. Setting::all(); // get all settings. // This will merge the setting.php config file with the values (only where lang is null) found in the database and returns a collection. Setting::lang('zh-TW')->get('name', 'Joe'); // get setting value with key and language Setting::set('name', 'Joe'); // set setting value by key Setting::lang('zh-TW')->set('name', 'Joe'); // set setting value by key and language Setting::has('name'); // check the key exists in database, return boolean Setting::lang('zh-TW')->has('name'); // check the key exists by language in database, return boolean Setting::forget('name'); // delete the setting from database by key Setting::lang('zh-TW')->forget('name'); // delete the setting from database by key and language
Dealing with locale
By default language parameter are being resets every set or get calls. You could disable that and set your own long term language parameter forever using any route service provider or other method.
Setting::lang(App::getLocale())->langResetting(false);
Custom Setting Model
The Setting model can be overwritten by creating a /config/laravel-setting.php config and adding:
'model' => \App\YourModelName::class,
Your custom model needs to extend the \JanisKelemen\Setting\EloquentStorage class.
Change log
Please see the changelog for more information on what has changed recently.
Testing
$ composer test
Contributing
Please see contributing.md for details.
Security
If you discover any security related issues, please send me a DM on Twitter @janiskelemen instead of using the issue tracker.
Credits
This package is mostly a fork of UniSharp/laravel-settings
License
MIT. Please see the license file for more information.