README

This Laravel package provides a simple abstraction for storing application settings in the database. It mimics the basic behaviour of the config helper and Config facades of core Laravel, but allows the values to be stored in the database where they can be more dynamically managed.

Camc\LaraSettings\LaraSetting::create(['key' => 'foo', 'value' => 'bar']);
// with a helper
lara_settings('foo'); // bar
// or with the facade
LaraSettings::get('foo'); // bar

An admin interface, or using tools like Tinkerwell will allow those settings to be updated on any application instance.

LaraSettings::set('foo', 'baz');
lara_settings('foo'); // baz

Underneath, values are cached to minimise the database hit of retrieving the values.

Dot notation is supported for retrieving values

Camc\LaraSettings\LaraSetting::create([
    'key' => 'foo', 
    'value' => ['bar' => 'baz']
]);
lara_settings('foo.bar') // baz

and a default may be provided to the getter for null values or missing settings:

Camc\LaraSettings\Models\LaraSetting::whereKey('foo')->first()->delete();
lara_settings('foo', 'deleted'); // deleted

// a setting instance will be created if not yet defined
LaraSettings::set('foo', null);
lara_settings('foo', 'null value'); // "null value"

Testing support

You can fake the facade in a similar way to other Laravel facades:

LaraSettings::fake(['a_fake_key' => 'a fake value']);

Installation

composer require camc/lara-settings

Configuration

Configuration currently supports two settings:

model_table - defines the name of the table to be used by the LaraSetting model. Defaults to lara_settings_settings.
cache_key - the key which caches the settings store. Defaults to lara-settings.

The config file can be published via artisan:

php artisan vendor:publish --provider=lara-settings-config

Usage

Beyond the examples shown above, seeding settings with initial values may be useful:

// database/seeders/settings/default.php
<?php

return [
    'foo' => ['bar' => 'baz']
];

// database/seeders

/**
* Only load settings if the file is present
*/
class LaraSettingsSeeder extends Seeder
{
    public function run()
    {
        $settingsFile = require(__DIR__ . '/settings/default.php';
        if (file_exists($settingsFile)) {
            foreach (require($settingsFile) as $key => $value) {
                LaraSettings::set($key, $value);
            }
        }
    } 
}

By checking if the file exists or not, it's possible to not commit the settings file, and then upload a custom file for any given installation.

Development

Tests

composer test

Linting

composer format

Changelog

Please see CHANGELOG for update history.

Future development

Admin support

The LaraSetting model has an unused description attribute which is a placeholder for storing descriptive text about the setting that could be displayed in an admin UI. This field is not intended for dynamic alteration, but an interface should be provided to make the presentation of settings in admin straightforward.

Given the wide variety of ways in which admin could be implemented, it's unlikely that UI will be added to the package, however a command line tool may prove useful.

Model validation

The LaraSetting accepts a string or an array as values. It might be useful to provide mechanisms to validate the content etc.

License

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

camc / lara-settings

Maintainers

Details