Laravel Settings

Typed, cached settings for Laravel 13 Eloquent models.

The package stores one JSON settings document per model, supports dot-notation reads and writes, broadcasts changes after the database transaction commits, and uses Laravel's memoized cache repository to avoid repeated reads within a request.

• PHP 8.5 or later
• Laravel 13

composer require supplycart/settings
php artisan vendor:publish --tag=settings-migrations
php artisan migrate

Publish the optional configuration when using a custom Setting subclass:

php artisan vendor:publish --tag=settings-config

Implement the contract and use the trait on a persisted Eloquent model:

<?php

declare(strict_types=1);

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Supplycart\Settings\Contracts\HasSettings as HasSettingsContract;
use Supplycart\Settings\Traits\HasSettings;

final class Company extends Model implements HasSettingsContract
{
    use HasSettings;

    public static function getDefaultSettings(): array
    {
        return [
            'timezone' => 'Asia/Kuala_Lumpur',
            'notifications' => [
                'email' => true,
            ],
        ];
    }
}

Read settings with optional dot notation and fallback values:

$company->getSetting();
$company->getSetting('timezone');
$company->getSetting('notifications.email', false);

Write one setting or merge several settings:

$company->setSetting('timezone', 'UTC');

$company->setSetting([
    'timezone' => 'UTC',
    'notifications' => ['email' => false],
]);

Array writes are merged recursively so unrelated nested settings remain intact.

Extend the package model and configure it in config/settings.php:

use App\Models\Setting;

return [
    'model' => Setting::class,
];

The configured class must extend Supplycart\Settings\Models\Setting.

• Cache::memo() provides request-local memoization backed by the configured application cache, without requiring a cache driver that supports tags.
• #[ObservedBy] invalidates cache entries whenever a setting is saved or deleted, including updates made outside setSetting().
• Settings are created through firstOrCreate() and protected by a unique (model_type, model_id) database constraint.
• SettingSaved broadcasts after commit, preventing rolled-back values from being emitted.

This release intentionally contains breaking changes:

• PHP 8.5 and Laravel 13 are required.
• HasSettings::getSettingModel() is now part of the contract. The supplied trait implements it automatically.
• Models must be persisted before settings can be read or written.
• Invalid custom model configuration and invalid cached values now throw clear exceptions.
• Setting::toArray() uses normal Eloquent serialization. Broadcast payloads continue to contain the settings values themselves.
• The settings table now requires one row per morph owner. Deduplicate existing rows before adding the unique (model_type, model_id) constraint.

composer lint:check
composer analyse
composer test
composer test:coverage

Pint enforces formatting, Larastan/PHPStan runs at level max, and CI enforces at least 85% line coverage.