shopapps/laravel-settings

config style settings but stored in a DB

1.0.23 2025-02-06 10:11 UTC

Requires

• php: ^8.1|^8.2
• filament/filament: ^3.0
• illuminate/support: ^9|^10|^11

Requires (Dev)

• laravel/pint: ^1.10
• orchestra/testbench: ^7.0|^9.0
• phpunit/phpunit: ^9.0|^10.5

MIT

• Paul Robbins

• laravel-settings
• shopapps

README

Laravel Settings is a simple way to store and retrieve settings from the database, with built-in caching. It also ships with an optional FilamentPHP plugin for quick admin management.

Installation

You can install the package via Composer:

composer require shopapps/laravel-settings

Publish Migrations and Config

Publish the migration and run it:

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

run the migration:

php artisan migrate

Optionally publish the config file:

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

A file named laravel-settings.php will appear in your config folder. Tweak it as needed.

Filament Admin Integration

If you're using Filament, you can optionally load the plugin:

    // typically in App\Providers\Filament\AdminPanelProvider

    use Shopapps\LaravelSettings\LaravelSettingsPlugin; // put this near top of file

    public function panel(Panel $panel): Panel
    {
        return $panel
            ->plugins([
                // ... existing plugins ...
                LaravelSettingsPlugin::make(), // <-- add this line
            ]);
    }

Usage

Helper Functions

Retrieve a setting:

$value = setting({key}, {value}, {user_id}, {save});
$value = setting('my.key', 'default_value');
# or...
$value = setting('my.key');

For the currently authenticated user:

$value = setting('my.key', null, true);
# or ...
$value = setting('my.key', 'default_value', true);

For a specific user ID:

$user_id = 1; // id of user you want the setting for

$value = setting('my.key', 'default_value', $user_id);

Add or update a setting:

add_setting('my.key', 'some value');

User-specific:

add_setting({key}, {value}, {type}, {user_id});
add_setting('my.key', 'some value', 'string', 123);

Or via setting helper (pass true to save):

setting('my.key', 'some new value', true, true);

Delete a setting:

delete_setting('my.key');
delete_setting('my.key', 123);

Clear cached settings:

clear_settings();

This flushes all cached settings from Redis or your default cache store.

Service Class

Under the hood, these helpers call methods on Shopapps\LaravelSettings\Services\SettingService. You can also use it directly:

    use Shopapps\LaravelSettings\Services\SettingService;

    // get
    $value = SettingService::make()->get('my.key');

    // add/update
    SettingService::make()->add('my.key', 'some value');

    // delete
    SettingService::make()->delete('my.key');

    // clear all caches
    SettingService::make()->clearAll();

Access Control

To restrict access to the Resource and Page publish the config and edit the config file or add the following to your .env file:

# enable access control
LARAVEL_SETTINGS_ACCESS_CONTROL_ENABLED=true
# using Spaties - Roles & Permissions - set the permission name default = 'laravel_settings.view'
LARAVEL_SETTINGS_SPATIE_PERMISSIONS_ACTIVE=true
LARAVEL_SETTINGS_SPATIE_PERMISSION="laravel_settings.view"
# alternatively restrict access only to a list of specific emails
LARAVEL_SETTINGS_ALLOWED_EMAILS="[e-mail], [e-mail]"
# or optional user_ids...
LARAVEL_SETTINGS_ALLOWED_USER_IDS="1,2,3,4"

Contributing

Feel free to submit pull requests or create issues for bug fixes and new features.

License

This package is open-sourced software licensed under the MIT license.