Store your Laravel application settings in an on-disk JSON file.
This package provides a simple SettingsRepository class that can be used to store your application's settings in a single JSON file.
Installation
You can install the package via composer:
composer require ryangjchandler/laravel-json-settings
You can publish the config file with:
php artisan vendor:publish --tag="laravel-json-settings-config"
Usage
You can resolve an instance of RyanChandler\LaravelJsonSettings\SettingsRepository from the container by type-hinting it in any DI-supported method, e.g. a controller method.
class IndexController
{
public function __invoke(SettingsRepository $settings)
{
return view('index', [
'title' => $settings->get('index.title'),
]);
}
}
The SettingsRepository class contains the following methods:
get(string $key, mixed $default = null)- retrieve the value of a setting by providing the key (dot-notation supported).set(string $key, mixed $value, bool $save = true)- set the value of a setting and toggle auto-save.has(string $key)- determine if a setting exists.save()- manually save your settings back to disk.reload()- clear the cache and reload the settings from disk.
If you prefer to use facades, you can interact with the RyanChandler\LaravelJsonSettings\Facades\Settings facade directly too.
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.
8 Jan 7, 2023
1k Dec 16, 2022
2 Oct 11, 2022
207 Dec 6, 2022
611 Dec 15, 2022
3 Jun 18, 2022
1 Jan 11, 2022
1 Nov 28, 2021
855 Dec 27, 2022
170 Oct 26, 2022
80 Aug 8, 2022
254 Dec 19, 2022
10 Aug 31, 2022
21 Dec 28, 2022
3 Aug 15, 2022
68 Dec 12, 2022
11 Apr 18, 2022
1 Aug 23, 2022
2 Nov 25, 2021