cloudcake/laravel-settings

Associate generic data to any other model without polluting your application model logic.

v1.2 2020-01-12 22:32 UTC

Requires (Dev)

• laravel/framework: ~5.5.0|~5.6.0|~5.7.0
• orchestra/testbench: ~3.4.0|~3.5.0|~3.6.0
• phpunit/phpunit: ~7.0

MIT

• Stephen Lake

README

Settings is a package to assist in associating settings or attributes of JSON form to any of your models using polymorphic relationships.

Usage

Publish Migrations

php artisan vendor:publish --provider="Settings\Providers\SettingsServiceProvider" \
                           --tag="migrations"

Setup models with settings

Add the \Settings\Traits\HasSettings trait to any model that should have settings.

use Settings\Traits\HasSettings;

class User extends Model
{
    use HasSettings;
}

Creating Settings

Global Settings

use Settings\Models\Setting;

Setting::make('config', [
  'rateLimit' => true,
  'ipLocks'   => [
    '127.0.0.1',
    '10.0.0.1'
  ]
]);

Model Specific Settings

use Settings\Models\Setting;

Setting::make('preferences', [
  'notifications'    => true,
  'backgroundColour' => '#ffffff'
], \App\User::class);

Attaching Settings

When attaching settings, any fields not provided will receive the default values.

\App\User::find(1)->attachSetting('preferences', [
  'notifications' => false,
]);

The above will set notifications to true while backgroundColour will be inherited from the original setting. If the global setting is changed, the user's setting will return the changed setting.

Getting Settings

Get All Fields

\App\User::first()->setting('preferences');

Get Specific Field

\App\User::first()->setting('preferences')->get('notifications');

Modifying Settings

\App\User::first()->setting('preferences')->set('notifications', true);