qcod/laravel-settings

Store key value pair in database as settings

1.0.9 2020-09-14 01:17 UTC

This package is auto-updated.

Last update: 2021-07-14 03:03:39 UTC


README

Latest Version on Packagist Software License Build Status StyleCI Total Downloads

Use qcod/laravel-settings to store key value pair settings in the database.

All the settings saved in db is cached to improve performance by reducing sql query to zero.

Installation

1 - You can install the package via composer:

$ composer require qcod/laravel-settings

2 - If you are installing on Laravel 5.4 or lower you will be needed to manually register Service Provider by adding it in config/app.php providers array and Facade in aliases arrays.

'providers' => [
    //...
    QCod\Settings\SettingsServiceProvider::class
]

'aliases' => [
    //...
    "Settings" => QCod\Settings\Facade::class
]

In Laravel 5.5 or above the service provider automatically get registered and a facade Setting::get('app_name') will be available.

3 - Now run the migration by php artisan migrate to create the settings table.

Optionally you can publish migration by running

php artisan vendor:publish --provider="QCod\Settings\SettingsServiceProvider" --tag="migrations"

Getting Started

You can use helper function settings('app_name') or Settings::get('app_name') to use laravel settings.

Available methods

// Pass `true` to ignore cached settings
settings()->all($fresh = false);

// Get a single setting
settings()->get($key, $defautl = null);

// Set a single setting
settings()->set($key, $value);

// Set a multiple settings
settings()->set([
   'app_name' => 'QCode',
   'app_email' => 'info@email.com',
   'app_type' => 'SaaS'
]);

// check for setting key
settings()->has($key);

// remove a setting
settings()->remove($key);

Groups

From v 1.0.6 You can organize your settings into groups. If you skip the group name it will store settings with default group name.

If you are updating from previous version dont forget to run the migration

You have all above methods available just set you working group by calling ->group('group_name') method and chain on:

settings()->group('team.1')->set('app_name', 'My Team App');
settings()->group('team.1')->get('app_name');
> My Team App

settings()->group('team.2')->set('app_name', 'My Team 2 App');
settings()->group('team.2')->get('app_name');
> My Team 2 App

// You can use facade
\Settings::group('team.1')->get('app_name')
> My Team App

Changelog

Please see CHANGELOG for more information on what has changed recently.

Testing

The package contains some integration/smoke tests, set up with Orchestra. The tests can be run via phpunit.

$ composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email saquibweb@gmail.com instead of using the issue tracker.

Credits

About QCode.in

QCode.in (https://www.qcode.in) is blog by Saqueib which covers All about Full Stack Web Development.

License

The MIT License (MIT). Please see License File for more information.