README

This package provides a simple way to define model settings in Laravel applications, without anything fancy. Just simple settings.

The package comes with a HasSettings trait that can be added to any eloquent model and a migration that creates a model_settings (Name configurable) table to store the settings. The settings are stored as JSON in the database, so you can store any type of data you want.

Installation

You can install the package via composer:

composer require kaiserkiwi/model-settings

Changing the configuration

If you want to change the default configuration, you can do this via the environment variables or by publishing the config file.

Changing the configuration via environment variables

You can change the configuration via the following environment variables:

Variable	Description	Default
`MODEL_SETTINGS_TABLE`	The name of the table to store the model settings	`model_settings`
`MODEL_SETTINGS_CACHE_ENABLED`	Whether to enable caching for model settings	`false`
`MODEL_SETTINGS_CACHE_TTL`	The time to live for the model settings cache in seconds	`60 * 60 * 24 * 30` (30 days)
`MODEL_SETTINGS_CACHE_KEY_PREFIX`	The prefix for the model settings cache key	`model_settings`

Changing the configuration via the config file

You can change the configuration in the config/model_settings.php file after publishing it by running the following command:

php artisan vendor:publish --provider="Kaiserkiwi\ModelSettings\ServiceProvider" --tag="config"

Publishing the migration file

To run the migration you have to publish the migration file, you can do so by running the following command:

php artisan vendor:publish --provider="Kaiserkiwi\ModelSettings\ServiceProvider" --tag="migrations"

Running the migration

After publishing the migration file, you can run the migration to create the model_settings table in your database by running the following command:

php artisan migrate

Adding the trait to your model

To use the package, you need to add the HasSettings trait to your model. For example:

namespace App\Models;

use Kaiserkiwi\ModelSettings\HasSettings;

class User extends Model
{
	use HasSettings;

	// Your model code here
}

Usage

Once you have added the HasSettings trait to your model, you can use the following methods to manage your settings:

Setting a setting

You can set a setting by calling the setSetting method on your model instance. For example:

$user = User::find(1);
$user->setSetting('theme', 'dark');

Getting a setting

You can get a setting by calling the getSetting method on your model instance. For example:

$user = User::find(1);
$theme = $user->getSetting('theme');

If the setting does not exist, you can provide a default value that will be returned instead:

$user = User::find(1);
$theme = $user->getSetting('theme', 'light');

Push a setting

You can push a setting by calling the pushSetting method on your model instance. This will append the value to the existing setting that is an array. For example:

$user = User::find(1);
$user->pushSetting('notifications', 'email');

If the setting does not have an array value the method throws an exception. If for whatever reason you want convert the existing value to an array and append a value you can use the third $force parameter:

$user = User::find(1);
$user->pushSetting('notifications', 'email', true);

So if the setting is a string, it will be converted to an array and the value will be appended. If the setting is not set at all, it will be created as an array with the value.

Deleting a setting

You can delete a setting by calling the deleteSetting method on your model instance. For example:

$user = User::find(1);
$user->removeSetting('theme');

Getting all settings

You can get all settings by calling the getSettings method on your model instance. For example:

$user = User::find(1);
$settings = $user->getSettings();

Caching

If caching is enabled in the configuration, the settings will be cached for the duration specified in the configuration. The cache invalidates automatically when a setting is updated or deleted.

Cache keys for the whole model will be created using the following format: {cache_key_prefix}:{model_class}:{model_id}

For example:

model_settings:App\Models\User:1

Cache keys for individual settings will be created using the following format: {cache_key_prefix}:{model_class}:{model_id}:{setting_key}