Skip to content
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
230 lines (190 sloc) 6.97 KB


Model Settings for your Laravel app

Latest Stable Version Total Downloads Build Status Software License
StyleCI Scrutinizer Code Quality Scrutinizer Code Coverage

The package requires PHP 7.1.3+ and follows the FIG standards PSR-1, PSR-2 and PSR-4 to ensure a high level of interoperability between shared PHP.

Bug reports, feature requests, and pull requests can be submitted by following our Contribution Guide.

Table of contents


$ composer require glorand/laravel-model-settings
    "require": {
        "glorand/laravel-model-settings": "^3.0"

Env (config) variables (.env file)

Default name for the settings field - when you use the HasSettingsField


Default name for the settings table - when you use the HasSettingsTable


Updating your Eloquent Models

Your models should use the HasSettingsField or HasSettingsTable trait.

Option 1 - HasSettingsField trait

Run the php artisan model-settings:model-settings-field in order to create a migration file for a table.
This command will create a json field (default name settings, from config) for the mentioned table.

You can choose another than default, in this case you have to specify it in you model.

public $settingsFieldName = 'user_settings';

Complete example:

use Glorand\Model\Settings\Traits\HasSettingsField;

class User extends Model
    use HasSettingsField;
    //define only if you select a different name from the default
    public $settingsFieldName = 'user_settings';  


Option 2 - HasSettingsTable trait

Run before the command php artisan model-settings:model-settings-table.
The command will copy for you the migration class to create the table where the setting values will be stored.
The default name of the table is model_settings; change the config or env value MODEL_SETTINGS_TABLE_NAME if you want to rewrite the default name (before you run the command!)

use Glorand\Model\Settings\Traits\HasSettingsTable;

class User extends Model
    use HasSettingsTable;

Option 3 - HasSettingsRedis trait

use Glorand\Model\Settings\Traits\HasSettingsRedis;

class User extends Model
    use HasSettingsRedis;

Default settings

use Glorand\Model\Settings\Traits\HasSettingsTable;

class User extends Model
    public $defaultSettings = [
        'key_1' => 'val_1',


$user = App\User::first();

Get all model's settings


Get a specific setting

$user->settings()->get('some.setting', 'default value');
	'default value'

Add / Update setting

$user->settings()->set('some.setting', 'new value');
$user->settings()->update('some.setting', 'new value');
	'some.setting_1' => 'new value 1',
	'some.setting_2' => 'new value 2',

Check if the model has a specific setting


Remove a setting from a model


Persistence for settings field

In case of field settings the auto-save is configurable.

The default value is true

  • Use an attribute on model
protected $persistSettings = true; //boolean
  • Environment (.env) variable
  • Config value - model settings config file
'settings_persistent' => env('MODEL_SETTINGS_PERSISTENT', true),

If the persistence is false you have to save the model after the operation.


Please see CHANGELOG for more information what has changed recently.


Please see CONTRIBUTING for details.


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

Related Stuff

You can’t perform that action at this time.