Download the PHP package glorand/laravel-model-settings without Composer

Model Settings for your Laravel app

The package requires PHP 8.1+ and follows the FIG standards PSR-1, PSR-2, PSR-4 and PSR-12 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

• Installation
• Updating your Eloquent Models
  • Option 1 - HasSettingsField trait
  • Option 2 - HasSettingsTable trait
  • Option 3 - HasSettingsRedis trait
• Default Settings
• Usage
  • Check if the settings for the entity is empty (exist)
  • Check settings (exist)
  • Get all model's settings
  • Get a specific setting
  • Add / Update setting
  • Check if the model has a specific setting
  • Remove a setting from a model
  • Persistence
  • Using another method name other than settings()
  • Validation system for settings data
  • Changelog
  • Contributing
• License

Installation

Env (config) variables (.env file)

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

MODEL_SETTINGS_FIELD_NAME=settings

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

MODEL_SETTINGS_TABLE_NAME=model_settings

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.

Complete example:

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!)

Option 3 - HasSettingsRedis trait

Default settings

You can set default configs for a table in model_settings.php config file

Or in your model itself:

Please note that if you define settings in the model, the settings from configs will have no effect, they will just be ignored.

Usage

Check if the settings for the entity is empty

Check settings (exist)

Get all model's settings

Get a specific setting

Add / Update setting

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

• Environment (.env) variable

• Config value - model settings config file

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

Using another method name other than settings()

If you prefer to use another name other than settings , you can do so by defining a $invokeSettingsBy property. This forward calls (such as configurations()) to the settings() method.

Validation system for settings data <a name="validation>

When you're using the set() or apply()|update() methods thrown an exception when you break a rule. You can define rules on model using $settingsRules public property, and the rules array definition is identical with the Laravel default validation rules. (see Laravel rules)

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

License

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

Related Stuff

• LaraNews - Laravel Model Settings
• made with Laravel - Laravel Model Settings