Settings & Preferences In Laravel Applications
This Laravel package allows you to manage and save/retrieve settings and preferences in your Laravel application.
- Settings are user defined values that apply to the application.
- Preferences are user defined values that apply to a specific user.
Settings and preferences are being managed separately. Values (by default) are being saved to the
preferences tables) and are cached with the
configured cache for your application.
The backend for storing the settings can be completely replaced, so it is possible to store them in anywhere else like MongoDB, ElasticSearch, Firebase, DynamoDB, S3, etc.
|5.4||0.9 - 1.1|
|5.5||0.9 - 1.2|
|5.6||0.9 - 1.2|
|5.7||1.1 - 1.2|
Minimum requirements (as of v1.2) are PHP 7.1 and Laravel 5.5
Install with composer:
composer require konekt/gears
The service provider and the aliases (facades) get registered automatically with Laravel 5.5 and higher.
For Laravel 5.4 you need to register the package manually:
// config/app.php 'providers' => [ // ... Konekt\Gears\Providers\GearsServiceProvider::class, ], //... 'aliases' => [ // ... 'Settings' => Konekt\Gears\Facades\Settings::class, 'Preferences' => Konekt\Gears\Facades\Preferences::class, ]
Settings are identified by a key (string) and need to be registered in order to be used.
/** @var \Konekt\Gears\Registry\SettingsRegistry $settingsRegistry */ $settingsRegistry = app('gears.settings_registry'); $settingsRegistry->addByKey('mailchimp.api_key');
Saving And Retrieving Settings
use Konekt\Gears\Facades\Settings; // using the facade: Settings::set('mailchimp.api_key', '123456789abcdef'); echo Settings::get('mailchimp.api_key'); // '123456789abcdef' // using the service from the container: $settings = app('gears.settings'); $settings->set('mailchimp.api_key', 'fbcdef'); echo $settings->get('mailgun.api_key'); // fbcdef
There are many more options and possibilities detailed in the Documentation.