konekt/gears

Settings and User Preferences library for Laravel

1.13.0 2024-02-10 12:09 UTC

Requires

• php: ^8.0
• illuminate/database: ^10.0|^11.0
• illuminate/support: ^10.0|^11.0
• konekt/enum: ^2.1|^3.0|^4.0

Requires (Dev)

• ext-pdo: *
• illuminate/events: ^10.0|^11.0
• orchestra/testbench: ^8.0|^9.0
• phpunit/phpunit: 9 - 10

MIT

• Attila Fulop

• laravel
• Settings
• preferences
• konekt
• artkonekt

README

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 database (settings and 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.

Laravel Compatibility

Laravel	Gears
5.4	0.9 - 1.1
5.5	0.9 - 1.2
5.6	0.9 - 1.2
5.7	1.1 - 1.2
5.8	1.2 - 1.5
6.x	1.2 - 1.8
7.x	1.3 - 1.8
8.x	1.5 - 1.10
9.x	1.8 - 1.12
10.x	1.11+
11.x	1.13+

Installation

Minimum requirements (as of v1.13) are PHP 8.1 and Laravel 10.0

Install with composer:

composer require konekt/gears

The service provider and the aliases (facades) get registered automatically.

Usage

Settings are identified by a key (string) and need to be registered in order to be used.

Register Settings

/** @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

To run the entire CI job suite locally: act -P ubuntu-latest=shivammathur/node:latest

There are many more options and possibilities detailed in the Documentation.