https://github.com/hrace009/laravel-settings
Laravel 5 Persistent Settings
https://github.com/hrace009/laravel-settings
Last synced: 2 months ago
JSON representation
Laravel 5 Persistent Settings
- Host: GitHub
- URL: https://github.com/hrace009/laravel-settings
- Owner: hrace009
- License: mit
- Created: 2021-12-01T13:58:39.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-07-17T03:41:02.000Z (10 months ago)
- Last Synced: 2025-01-23T19:42:49.072Z (4 months ago)
- Language: PHP
- Size: 13.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel-Settings
Laravel Persistent Settings (Database + Cache)
Re-Publish new migration file
$ php artisan vendor:publish --provider="hrace009\LaravelSettings\SettingsServiceProvider" --force
And run
$ php artisan migrate
## How to Install
Require this package with composer ([Packagist](https://packagist.org/packages/hrace009/laravel-settings)) using the
following command:
composer require hrace009/laravel-settings
or modify your `composer.json`:
"require": {
"hrace009/laravel-settings": "1.*"
}
then run `composer update`:
After updating composer, Register the ServiceProvider to the `providers` array in `config/app.php`
'hrace009\LaravelSettings\SettingsServiceProvider',
Add an alias for the facade to `aliases` array in your `config/app.php`
'Settings' => hrace009\LaravelSettings\Facades\Settings::class,
Publish the config and migration files now (Attention: This command will not work if you don't follow previous
instruction):
$ php artisan vendor:publish --provider="hrace009\LaravelSettings\SettingsServiceProvider" --force
Change `config/settings.php` according to your needs. If you change `db_table`, don't forget to change the table's name
in the migration file as well.
Create the `settings` table.
$ php artisan migrate
## How to Use it?
Set a value
Settings::set('key', 'value');
Get a value
$value = Settings::get('key');
Get a value with Default Value.
$value = Settings::get('key', 'Default Value');
> Note: If key is not found (null) in cache or settings table, it will return default value
Get a value via an helper
$value = settings('key');
$value = settings('key', 'default value');
Forget a value
Settings::forget('key');
Forget all values
Settings::flush();
## Fallback to Laravel Config (available in v1.0.1)
How to activate?
// Change your config/settings.php
'fallback' => true
Example
/*
* If the value with key => mail.host is not found in cache or DB of Larave Settings
* it will return same value as config::get('mail.host');
*/
Settings::get('mail.host');
> Note: It will work if default value in laravel setting is not set
### Changelogs
v1.0.1 - Dec 4th, 2021
- Second Release
--------------------------
v1.0.0 - Dec 1st, 2021
- First Release
### To Do
-
### License
The Laravel 5 Persistent Settings is open-sourced software licensed under
the [MIT license](http://opensource.org/licenses/MIT)