Easily manage app settings stored in DB or JSON file
teknyo/laravel-settings-manager is a Laravel package for easily manage app settings stored in db or json file.
It currently has 0 GitHub stars and 0 downloads on Packagist.
Install it with composer require teknyo/laravel-settings-manager.
Discover more Laravel packages by teknyo
or browse all Laravel packages to compare alternatives.
Last updated
A simple, elegant, and powerful settings manager for Laravel applications. Store and retrieve application settings from database or JSON file with built-in caching support.
Setting::get() and Setting::set() methodsInstall the package via Composer:
composer require yourvendor/laravel-settings
Publish the configuration file:
php artisan vendor:publish --tag=settings-config
If using the database driver, publish and run migrations:
php artisan vendor:publish --tag=settings-migrations
php artisan migrate
The configuration file will be published to config/settings.php:
return [
// Storage driver: 'database' or 'json'
'driver' => env('SETTINGS_DRIVER', 'database'),
// Database driver settings
'database' => [
'connection' => env('DB_CONNECTION', 'mysql'),
'table' => 'settings',
],
// JSON driver settings
'json' => [
'path' => 'app/settings.json',
],
// Cache settings
'cache' => [
'enabled' => true,
'store' => env('CACHE_DRIVER', 'file'),
'prefix' => 'settings',
],
];
Add to your .env file:
SETTINGS_DRIVER=database # or 'json'
use YourVendor\Settings\Facades\Setting;
// Set a setting
Setting::set('site_name', 'My Awesome Website');
Setting::set('timezone', 'Asia/Colombo');
Setting::set('maintenance_mode', false);
// Get a setting
$siteName = Setting::get('site_name');
// Returns: 'My Awesome Website'
// Get with default value
$theme = Setting::get('theme', 'light');
// Returns: 'light' if 'theme' doesn't exist
// Check if setting exists
if (Setting::has('site_name')) {
echo 'Site name is configured';
}
// Delete a setting
Setting::forget('old_setting');
The package automatically serializes complex data types:
// Store arrays
Setting::set('features', [
'dark_mode' => true,
'api_enabled' => false,
'max_upload_size' => 10,
]);
// Retrieve arrays
$features = Setting::get('features');
// Returns: ['dark_mode' => true, 'api_enabled' => false, 'max_upload_size' => 10]
// Store objects
Setting::set('email_config', [
'driver' => 'smtp',
'host' => 'smtp.mailtrap.io',
'port' => 587,
]);
// Set multiple settings at once
Setting::setMany([
'app_name' => 'MyApp',
'app_version' => '1.0.0',
'maintenance_mode' => false,
'items_per_page' => 20,
]);
// Delete multiple settings
Setting::forgetMany(['temp_key1', 'temp_key2', 'cache_key']);
// Get all settings
$allSettings = Setting::all();
// Returns: ['site_name' => 'My Site', 'timezone' => 'UTC', ...]
// Clear all settings (use with caution!)
Setting::clear();
Manage settings from the command line:
php artisan setting:get site_name
# Output: Value for 'site_name': "My Awesome Website"
# With default value
php artisan setting:get theme --default=light
# Simple value
php artisan setting:set site_name "My New Site Name"
# Boolean
php artisan setting:set maintenance_mode false
# JSON value
php artisan setting:set features '{"dark_mode":true,"notifications":false}'
# Number
php artisan setting:set max_users 1000
php artisan setting:list
Output:
+-------------------+--------------------------------+
| Key | Value |
+-------------------+--------------------------------+
| site_name | "My Awesome Website" |
| timezone | "Asia/Colombo" |
| maintenance_mode | false |
| features | {"dark_mode":true} |
+-------------------+--------------------------------+
php artisan setting:clear
# Skip confirmation
php artisan setting:clear --force
// In your AppServiceProvider
public function boot()
{
config(['app.timezone' => Setting::get('timezone', 'UTC')]);
config(['app.name' => Setting::get('site_name', 'Laravel')]);
}
if (Setting::get('features.new_dashboard', false)) {
return view('dashboard.new');
}
return view('dashboard.old');
// Middleware
public function handle($request, Closure $next)
{
if (Setting::get('maintenance_mode', false)) {
return response()->view('maintenance', [], 503);
}
return $next($request);
}
class UserSettingsController
{
public function update(Request $request)
{
$userId = auth()->id();
Setting::setMany([
"user.{$userId}.theme" => $request->theme,
"user.{$userId}.language" => $request->language,
"user.{$userId}.notifications" => $request->notifications,
]);
return back()->with('success', 'Settings updated!');
}
}
$rateLimit = Setting::get('api.rate_limit', 60);
$rateLimitWindow = Setting::get('api.rate_limit_window', 1);
RateLimiter::for('api', function (Request $request) use ($rateLimit, $rateLimitWindow) {
return Limit::perMinutes($rateLimitWindow, $rateLimit);
});
// config/settings.php
'json' => [
'path' => 'custom/path/settings.json',
],
// config/settings.php
'cache' => [
'enabled' => false,
],
// config/settings.php
'cache' => [
'enabled' => true,
'store' => 'redis', // Use Redis for caching
'prefix' => 'app_settings',
],
// config/settings.php
'database' => [
'connection' => 'settings_db', // Use separate connection
'table' => 'app_settings',
],
Database Driver: Stores settings in a database table with automatic JSON serialization.
JSON Driver: Stores settings in a JSON file with file locking for concurrent access.
The CachedRepository wraps any storage driver and provides transparent caching:
setMany() for multiple settings (single transaction)This package is open-sourced software licensed under the MIT license.
If you discover any security vulnerabilities or bugs, please email [email protected].
For general questions and support, please open an issue on GitHub.
Please see CHANGELOG for more information on what has changed recently.
