faustbrian/laravel-settings

Persistent Settings with multiple Drivers for Laravel 5

1.1.0 2018-11-10 06:39 UTC

README

Build Status PHP from Packagist Latest Version License

Installation

Require this package, with Composer, in the root directory of your project.

$ composer require faustbrian/laravel-settings

Configuration

Laravel Settings supports optional configuration.

To get started, you'll need to publish all configurations:

$ php artisan vendor:publish --provider="BrianFaust\Settings\SettingsServiceProvider" --tag="config"

This will create a config/settings.php file in your app that you can modify to set your configuration. Also, make sure you check for changes to the original config file in this package between releases.

Migration (Only required if you use the database driver)

To get started, you'll need to publish all migrations:

$ php artisan vendor:publish --provider="BrianFaust\Settings\ServiceProvider" --tag="migrations"

And then run the migrations to setup the database table.

$ php artisan migrate

Usage

Get all settings
Setting::all();
Check if a setting exists
Setting::has($key);
Get a setting
Setting::get($key);
Set a setting
Setting::put($key, $value);
Delete a setting
Setting::forget($key);
Delete all settings
Setting::flush();

Testing

$ phpunit

Security

If you discover a security vulnerability within this package, please send an e-mail to hello@brianfaust.me. All security vulnerabilities will be promptly addressed.

Credits

License

MIT © Brian Faust