anlutro/l4-settings

Persistant settings in Laravel.

Installs: 4 880

Dependents: 2

Stars: 67

Watchers: 9

Forks: 17

Open Issues: 4

Language: PHP

0.4.0 2015-06-09 06:10 UTC

README

Build Status Latest Stable Version License

Persistant, application-wide settings for Laravel.

Despite the package name, this package works with Laravel 5!

Installation

  1. composer require anlutro/l4-settings

  2. Add anlutro\LaravelSettings\ServiceProvider to the array of providers in config/app.php.

  3. Publish the config file by running php artisan config:publish anlutro/l4-settings (Laravel 4.x) or php artisan vendor:publish (Laravel 5). The config file will give you control over which storage engine to use as well as some storage-specific settings.

Optional: add 'Setting' => 'anlutro\LaravelSettings\Facade' to the array of aliases in config/app.php.

Usage

You can either access the setting store via its facade or inject it by type-hinting towards the abstract class anlutro\LaravelSettings\SettingStore.

<?php
Setting::set('foo', 'bar');
Setting::get('foo', 'default value');
Setting::get('nested.element');
Setting::forget('foo');
$settings = Setting::all();
?>

Call Setting::save() explicitly to save changes made.

Auto-saving

In Laravel 4.x, the library makes sure to auto-save every time the application shuts down if anything has been changed.

In Laravel 5.x, if you add the middleware anlutro\LaravelSettings\SaveMiddleware to your middleware list in app\Http\Kernel.php, settings will be saved automatically at the end of all HTTP requests, but you'll still need to call Setting::save() explicitly in console commands, queue workers etc.

JSON storage

You can modify the path used on run-time using Setting::setPath($path).

Database storage

If you use the database store you need to create the table yourself. It needs two columns - key and value, both should be string-type (varchar or text) - how long depends on the amount of data you plan to store there.

For example, if you want to store settings for multiple users/clients in the same database you can do so by specifying extra columns:

<?php
Setting::setExtraColumns(array(
    'user_id' => Auth::user()->id
));
?>

where user_id = x will now be added to the database query when settings are retrieved, and when new settings are saved, the user_id will be populated.

If you need more fine-tuned control over which data gets queried, you can use the setConstraint method which takes a closure with two arguments:

  • $query is the query builder instance
  • $insert is a boolean telling you whether the query is an insert or not. If it is an insert, you usually don't need to do anything to $query.
<?php
Setting::setConstraint(function($query, $insert) {
    if ($insert) return;
    $query->where(/* ... */);
});
?>

Custom stores

This package uses the Laravel Manager class under the hood, so it's easy to add your own custom session store driver if you want to store in some other way. All you need to do is extend the abstract SettingStore class, implement the abstract methods and call Setting::extend.

<?php
class MyStore extends anlutro\LaravelSettings\SettingStore {
    // ...
}
Setting::extend('mystore', function($app) {
    return $app->make('MyStore');
});
?>

Contact

Open an issue on GitHub if you have any problems or suggestions.

License

The contents of this repository is released under the MIT license.