setting

by akaunting

akaunting / setting

Persistent settings package for Laravel

239 Stars 42 Forks Last release: about 2 months ago (1.2.2) MIT License 87 Commits 21 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Persistent settings package for Laravel

Version Downloads StyleCI Quality License

This package allows you to save settings in a more persistent way. You can use the database and/or json file to save your settings. You can also override the Laravel config.

  • Driver support
  • Helper function
  • Blade directive
  • Override config values
  • Encryption
  • Custom file, table and columns
  • Auto save
  • Extra columns
  • Cache support

Getting Started

1. Install

Run the following command:

composer require akaunting/setting

2. Register (for Laravel < 5.5)

Register the service provider in

config/app.php
Akaunting\Setting\Provider::class,

Add alias if you want to use the facade.

'Setting' => Akaunting\Setting\Facade::class,

3. Publish

Publish config file.

php artisan vendor:publish --tag=setting

4. Database

Create table for database driver

php artisan migrate

5. Configure

You can change the options of your app from

config/setting.php
file

Usage

You can either use the helper method like

setting('foo')
or the facade
Setting::get('foo')

Facade

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

Helper

setting('foo', 'default');
setting('nested.element');
setting(['foo' => 'bar']);
setting()->forget('foo');
$settings = setting()->all();

You can call the

save()
method to save the changes.

Auto Save

If you enable the

auto_save
option in the config file, settings will be saved automatically every time the application shuts down if anything has been changed.

Blade Directive

You can get the settings directly in your blade templates using the helper method or the blade directive like

@setting('foo')

Override Config Values

You can easily override default config values by adding them to the

override
option in
config/setting.php
, thereby eliminating the need to modify the default config files and also allowing you to change said values during production. Ex:
'override' => [
    "app.name" => "app_name",
    "app.env" => "app_env",
    "mail.driver" => "app_mail_driver",
    "mail.host" => "app_mail_host",
],

The values on the left corresponds to the respective config value (Ex: config('app.name')) and the value on the right is the name of the

key
in your settings table/json file.

Encryption

If you like to encrypt the values for a given key, you can pass the key to the

encrypted_keys
option in
config/setting.php
and the rest is automatically handled by using Laravel's built-in encryption facilities. Ex:
'encrypted_keys' => [
    "payment.key",
],

JSON Storage

You can modify the path used on run-time using

setting()->setPath($path)
.

Database Storage

If you want to use the database as settings storage then you should run the

php artisan migrate
. You can modify the table fields from the
create_settings_table
file in the migrations directory.

Extra Columns

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

setting()->setExtraColumns(['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
    .
setting()->setConstraint(function($query, $insert) {
    if ($insert) return;
    $query->where(/* ... */);
});

Custom Drivers

This package uses the Laravel

Manager
class under the hood, so it's easy to add your own storage driver. All you need to do is extend the abstract
Driver
class, implement the abstract methods and call
setting()->extend
.
class MyDriver extends Akaunting\Setting\Contracts\Driver
{
    // ...
}

setting()->extend('mydriver', function($app) { return $app->make('MyDriver'); });

Changelog

Please see Releases for more information what has changed recently.

Contributing

Pull requests are more than welcome. You must follow the PSR coding standards.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

License

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.