Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michaelnabil230/laravel-setting
Persist setting in Laravel
https://github.com/michaelnabil230/laravel-setting
Last synced: about 1 month ago
JSON representation
Persist setting in Laravel
- Host: GitHub
- URL: https://github.com/michaelnabil230/laravel-setting
- Owner: michaelnabil230
- License: mit
- Created: 2022-01-07T15:44:01.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-09T04:28:05.000Z (about 1 year ago)
- Last Synced: 2024-07-23T04:24:23.235Z (5 months ago)
- Language: PHP
- Homepage:
- Size: 145 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# This package allows you to persist in setting for Laravel projects and support laravel 10.
[](https://packagist.org/packages/michaelnabil230/laravel-setting)
[](https://packagist.org/packages/michaelnabil230/laravel-setting)
[](https://github.com/michaelnabil230/laravel-setting/stargazers)
[](https://github.com/michaelnabil230/laravel-setting/blob/main/LICENSE)
[](https://github.com/michaelnabil230/laravel-setting/issues)
## Installation
You can install the package via composer:
```bash
composer require michaelnabil230/laravel-setting
```
You can publish and run the migrations with:
```bash
php artisan vendor:publish --tag="setting-migrations"
php artisan migrate
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="setting-config"
```
This is the contents of the published config file:
```php
use MichaelNabil230\Setting\Models\Setting;
return [
/*
|--------------------------------------------------------------------------
| Default Settings Store
|--------------------------------------------------------------------------
|
| This option controls the default settings store that gets used while
| using this settings library.
|
| Supported: "json", "database", "redis"
|
*/
'default' => 'json',
/*
|--------------------------------------------------------------------------
| Drivers Stores
|--------------------------------------------------------------------------
|
| The settings are stored.
|
*/
'drivers' => [
'database' => [
'driver' => \MichaelNabil230\Setting\Stores\DatabaseSettingStore::class,
'options' => [
'model' => Setting::class,
'table' => 'settings', // name of table in dataBase
'cache' => [
'enableCache' => false,
'cacheTtl' => 15, // TTL in seconds.
]
],
],
'redis' => [
'driver' => \MichaelNabil230\Setting\Stores\RedisSettingStore::class,
'options' => [
'connection' => 'default',
'prefix' => 'setting',
],
],
'json' => [
'driver' => \MichaelNabil230\Setting\Stores\JsonSettingStore::class,
'options' => [
'path' => storage_path('settings.json'),
]
],
],
/*
|--------------------------------------------------------------------------
| Keys
|--------------------------------------------------------------------------
|
| Your keys are used to insert settings data.
|
*/
'keys' => [
//
],
/*
|--------------------------------------------------------------------------
| Default Settings
|--------------------------------------------------------------------------
|
| Default settings are used when a setting is not found in the store.
|
*/
'defaults' => [
//
],
];
```
You can either access the setting store via its facade
```php
save();
Setting::get('foo', 'default value');
Setting::get('nested.element');
Setting::has('foo');
Setting::flip('foo');
Setting::enable('foo');
Setting::disable('foo');
Setting::forget('foo');
Setting::forgetAll();
$settings = Setting::all();
?>
```
You could also use the `setting()` helper:
```php
// Get the store instance
setting();
// Get values
setting('foo');
setting('foo.bar');
setting('foo', 'default value');
setting()->get('foo');
setting()->get('foo.bar');
// Set values
setting(['foo' => 'bar'])->save();
setting(['foo.bar' => 'baz'])->save();
setting()->set('foo', 'bar')->save();
// Flipping a boolean setting:
setting()->set('notifications', true)->save();
// Disable notifications.
setting()->flip('notifications')->save();
dd(setting()->get('notifications')); // Returns false.
// Enable notifications.
setting()->flip('notifications')->save();
dd(setting()->get('notifications')); // Returns true.
// Default flip setting:
setting()->flip('new-key')->save();
dd(setting()->get('new-key')); // Returns true.
// Enabling a boolean setting:
setting()->set('notifications', false)->save();
setting()->enable('notifications')->save();
dd(setting()->get('notifications')); // Returns true.
// Disabling a boolean setting:
setting()->set('notifications', true)->save();
setting()->disable('notifications')->save();
dd(setting()->get('notifications')); // Returns false.
// Method chaining
setting(['foo' => 'bar'])->save();
```
You could also use the @setting() directive blade:
```
@setting('foo')
@setting('foo', 'default value')
```
### Command line helper
```
php artisan setting:forget foo
php artisan setting:get || php artisan setting:get foo
php artisan setting:set-or-update foo bar
```
### Store cache
When reading from the store, you can enable the cache.
You can also configure flushing of the cache when writing and configure time to live.
Reading will come from the store, and then from the cache, this can reduce load on the store.
```php
'cache' => [
'enableCache' => false,
'cacheTtl' => 15, // TTL in seconds.
]
```
# Configuration
### Default:
```php
'json',
// ...
];
```
You can specify here your default store driver that you would to use.
### Drivers:
```php
[
'database' => [
'driver' => \MichaelNabil230\Setting\Stores\DatabaseSettingStore::class,
'options' => [
'model' => Setting::class,
'table' => 'settings', // name of table in dataBase
'cache' => [
'enableCache' => false,
'cacheTtl' => 15, // TTL in seconds.
]
],
],
'redis' => [
'driver' => \MichaelNabil230\Setting\Stores\RedisSettingStore::class,
'options' => [
'connection' => 'default',
'prefix' => 'setting',
],
],
'json' => [
'driver' => \MichaelNabil230\Setting\Stores\JsonSettingStore::class,
'options' => [
'path' => storage_path('settings.json'),
]
],
],
];
```
This is the list of the supported store drivers. You can expand this list by adding a custom store driver.
The store config is structured like this:
```php
[
'driver' => App\Stores\CustomStore::class,
'options' => [
// ...
],
],
```
##### 1. Create the Custom Store class
```php
[
'custom' => [
'driver' => App\Settings\CustomStore::class,
],
],
];
```
If you used the abstract `MichaelNabil230\Setting\Contracts\Store` class, you can pass a `options` array
like credential keys, path ...
```php
return [
'drivers' => [
'custom' => [
'driver' => App\Settings\CustomStore::class,
'options' => [
// more customize
],
],
],
];
```
Last and not least, you can set it as the `default` store.
# Integration with `stancl/tenancy`
Install the package like usual, but publish the migrations and move them to `migrations/tenant`:
```
php artisan vendor:publish --tag="setting-migrations"
mv database/migrations/*_create_settings_table.php database/migrations/tenant
```
Then add this to your `AppServiceProvider::boot()` method:
```php
Event::listen(TenancyBootstrapped::class, function (TenancyBootstrapped $event) {
\MichaelNabil230\Setting\Stores\DatabaseSettingStore::$cacheKey = 'setting.cache.tenant.' . $event->tenancy->tenant->id;
});
```
## Testing
```bash
composer test
```
## Support
[](https://ko-fi.com/michaelnabil230)[](https://www.buymeacoffee.com/michaelnabil230)[](https://www.paypal.com/paypalme/MichaelNabil23)
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Michael Nabil](https://github.com/michaelnabil230)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.