Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/janiskelemen/laravel-setting
Advanced Settings Manager for Laravel
https://github.com/janiskelemen/laravel-setting
config key-value laravel localization manager setting
Last synced: 4 days ago
JSON representation
Advanced Settings Manager for Laravel
- Host: GitHub
- URL: https://github.com/janiskelemen/laravel-setting
- Owner: janiskelemen
- License: mit
- Created: 2019-01-16T15:34:35.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-20T23:54:20.000Z (4 months ago)
- Last Synced: 2025-01-05T01:09:39.922Z (11 days ago)
- Topics: config, key-value, laravel, localization, manager, setting
- Language: PHP
- Homepage:
- Size: 7.53 MB
- Stars: 52
- Watchers: 4
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# Advanced Settings Manager for Laravel
[![Total Downloads][ico-downloads]][link-downloads]
[![Build Status][ico-travis]][link-travis]
- 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
```bash
composer require janiskelemen/laravel-setting
```
## Publish config and migration
```bash
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.
```php
# config/setting.php
return [
'app_name' => 'My Application',
'user_limit' => 10,
];
```
```php
Setting::get('app_name');
//retruns
'My Application'
```
### You can also use multi level arrays
```php
# config/setting.php
return [
'priorities' => [
'low' => 1,
'medium' => 2,
'hight' => 3
],
];
```
```php
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.
```php
# 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,
];
```
```php
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
```php
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.
```php
# config/setting.php
return [
'user_*' => [
'dark_mode' => false,
'permissions' => [
'read' => true,
'write' => false,
]
],
];
```
Set save the new setting on runtime:
```php
// 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:
```php
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:
```php
Setting::get("user_{$otherUser->id}.dark_mode");
//returns
false
```
Get only the changed user settings
```php
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.
```php
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
```php
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.
```php
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:
```php
'model' => \App\YourModelName::class,
```
Your custom model needs to extend the **\JanisKelemen\Setting\EloquentStorage** class.
## Change log
Please see the [changelog](changelog.md) for more information on what has changed recently.
## Testing
```bash
$ composer test
```
## Contributing
Please see [contributing.md](contributing.md) for details.
## Security
If you discover any security related issues, please send me a DM on Twitter [@janiskelemen](https://twitter.com/janiskelemen) instead of using the issue tracker.
## Credits
This package is mostly a fork of [UniSharp/laravel-settings](https://github.com/UniSharp/laravel-settings)
- [HelpSpace.io](https://helpspace.io/?ref=laravel-setting)
- [Janis Kelemen](https://twitter.com/janiskelemen)
- [All Contributors][link-contributors]
## License
MIT. Please see the [license file](LICENSE) for more information.
[ico-downloads]: https://img.shields.io/packagist/dt/janiskelemen/laravel-setting.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/janiskelemen/laravel-setting/master.svg?style=flat-square
[ico-styleci]: https://github.styleci.io/repos/166064246/shield?branch=master
[link-packagist]: https://packagist.org/packages/janiskelemen/laravel-setting
[link-downloads]: https://packagist.org/packages/janiskelemen/laravel-setting
[link-travis]: https://travis-ci.org/janiskelemen/laravel-setting
[link-styleci]: https://github.styleci.io/repos/166064246
[link-author]: https://github.com/janiskelemen
[link-contributors]: ../../contributors]