Laravel Model Settings

[!TIP]

Store settings for individual Eloquent models, with optional defaults shared by all models.

Use this package when each model needs its own settings, but should fall back to shared values when a model value is missing.

Installation

You can install the package via Composer:

composer require dragon-code/laravel-model-settings

php artisan vendor:publish --tag="model-settings"

php artisan migrate

Quick Start

Add the HasSettings trait to a model:

use DragonCode\LaravelModelSettings\Concerns\HasSettings;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    use HasSettings;
}

Use settings on a saved model:

$user = User::query()->findOrFail(123);

$user->settings()->set('timezone', 'UTC');
$user->settings()->set('notifications', ['email' => true]);

$user->settings()->get('timezone');      // 'UTC'
$user->settings()->get('notifications'); // ['email' => true]
$user->settings()->get('missing');       // null

$user->settings()->all();                // array of all resolved settings

$user->settings()->forget('timezone');
$user->settings()->get('timezone');      // null

Default Settings

Default settings are shared fallback values:

use DragonCode\LaravelModelSettings\Storages\DefaultStorage;

$defaults = app(DefaultStorage::class);

$defaults->set('timezone', 'UTC');
$defaults->set('locale', 'en');

$defaults->get('timezone'); // 'UTC'
$defaults->all();           // Illuminate\Support\Collection
$defaults->forget('locale');

Model values override defaults. Removing the model value exposes the default again:

use DragonCode\LaravelModelSettings\Storages\DefaultStorage;

app(DefaultStorage::class)->set('timezone', 'UTC');

$user->settings()->get('timezone'); // 'UTC'

$user->settings()->set('timezone', 'Europe/Paris');
$user->settings()->get('timezone'); // 'Europe/Paris'

$user->settings()->forget('timezone');
$user->settings()->get('timezone'); // 'UTC'

Methods

If you cannot use the trait, resolve SettingsService from the container with ['model' => $user].

Setting Keys

Keys can be strings or PHP enums:

enum UserSetting: string
{
    case Timezone = 'timezone';
}

$user->settings()->set(UserSetting::Timezone, 'UTC');
$user->settings()->get(UserSetting::Timezone); // 'UTC'

A blank model value is treated as missing by get(). For example: null, an empty string, or an empty array.

Configuration

After publishing, edit config/model-settings.php:

The migration stores values in one table with item_type, item_id, key, and JSON payload.

Default settings use item_type = '_default' and item_id = 0.

Each setting is unique by item_type, item_id, and key.

Contributing

Please see CONTRIBUTING for details.

Security

If you've found a bug regarding security please mail helldar@dragon-code.pro instead of using the issue tracker.

Credits

• Andrey Helldar
• All Contributors

License

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