README

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="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.

ryangjchandler / laravel-json-settings

Maintainers

Details