Laravel Settings is a package that allows you to easily store and retrieve application settings in your Laravel application. This is particularly useful for managing configurable parameters such as site settings, application configurations, and any other settings that need to be easily accessible throughout your application.
Key Features
- Simple Storage and Retrieval: Store settings in the database and retrieve them easily.
- Configurable: Supports various data types and can be customized for your application’s needs.
- Caching: Efficiently cache settings for improved performance.
- Easy Migration: Comes with built-in migrations to set up your settings table.
Installation
You can install the package via Composer:
bash
1 |
composer require spatie/laravel-settings |
Configuration
After installing the package, you need to publish the configuration file if you want to customize the settings:
bash
1 |
php artisan vendor:publish --provider="Spatie\Settings\SettingsServiceProvider" |
Migration
You may need to create a migration for the settings table. You can use the built-in command:
bash
1 |
php artisan settings:table |
This command generates a migration file where you can customize the fields for your settings. Once you have reviewed the migration, run the migration to create the settings table:
bash
1 |
php artisan migrate |
Basic Usage
Storing Settings
You can store settings in your application using the Settings
facade:
php
1 2 3 4 |
use Spatie\Settings\Settings; Settings::set('site_name', 'My Awesome Site'); Settings::set('site_description', 'This is a fantastic website.'); |
Retrieving Settings
To retrieve settings, you can use the same facade:
php
1 2 |
$siteName = Settings::get('site_name'); $siteDescription = Settings::get('site_description'); |
Checking if a Setting Exists
You can check if a specific setting exists:
php
1 2 3 |
if (Settings::has('site_name')) { $siteName = Settings::get('site_name'); } |
Defining Settings with Classes
To organize your settings better, you can create a class to define your settings. This helps in type hinting and organizing settings more clearly.
- Create a settings class:
php
12345678910namespace App\Settings;use Spatie\Settings\Settings;class SiteSettings extends Settings{public string $site_name;public string $site_description;// Add more settings as needed} - Register the settings class in a service provider (e.g.,
AppServiceProvider
):php
12345678use App\Settings\SiteSettings;public function register(){$this->app->singleton(SiteSettings::class, function () {return new SiteSettings();});} - Use the settings class in your application:
php
1234use App\Settings\SiteSettings;$settings = app(SiteSettings::class);$siteName = $settings->site_name;
Caching Settings
To improve performance, you can cache your settings. You can set a cache duration in your configuration file. Here’s an example of how to cache settings:
php
1 2 3 |
$settings = Settings::cache('site_settings', 60, function () { return Settings::all(); }); |
This caches the settings for 60 minutes.
Conclusion
Laravel Settings provides an efficient way to manage application settings in your Laravel applications. With its simple interface and the ability to define settings using classes, you can easily store and retrieve configuration parameters as needed. This package also helps in keeping your settings organized and maintainable.
- Laravel Breeze – Simple authentication starter kit
- Laravel Jetstream – Scaffolding for Laravel apps
- Laravel Passport – API authentication via OAuth2
- Laravel Sanctum – Simple API authentication
- Spatie Laravel Permission – Role and permission management
- Laravel Cashier – Subscription billing with Stripe
- Laravel Scout – Full-text search using Algolia
- Laravel Socialite – OAuth authentication (Google, Facebook, etc.)
- Laravel Excel – Excel import and export for Laravel
- Laravel Horizon – Redis queues monitoring
- Laravel Nova – Admin panel for Laravel
- Laravel Fortify – Backend authentication for Laravel
- Laravel Vapor – Serverless deployment on AWS
- Laravel Telescope – Debugging assistant for Laravel
- Laravel Dusk – Browser testing
- Laravel Mix – API for compiling assets
- Spatie Laravel Backup – Backup management
- Laravel Livewire – Building dynamic UIs
- Spatie Laravel Media Library – Manage media uploads
- Laravel Excel – Excel spreadsheet handling
- Laravel Debugbar – Debug tool for Laravel
- Laravel WebSockets – Real-time communication
- Spatie Laravel Sitemap – Generate sitemaps
- Laravel Spark – SaaS scaffolding
- Laravel Envoy – Task runner for deployment
- Spatie Laravel Translatable – Multilingual model support
- Laravel Backpack – Admin panel
- Laravel AdminLTE – Admin interface template
- Laravel Collective Forms & HTML – Simplified form and HTML generation
- Spatie Laravel Analytics – Google Analytics integration
- Laravel Eloquent Sluggable – Automatically create slugs
- Laravel Charts – Chart integration
- Laravel Auditing – Track changes in models
- Laravel JWT Auth – JSON Web Token authentication
- Laravel Queue Monitor – Monitor job queues
- Spatie Laravel Query Builder – Filter, sort, and include relationships in Eloquent queries
- Laravel Datatables – jQuery Datatables API
- Laravel Localization – Multilingual support for views and routes
- Laravel Acl Manager – Access control list manager
- Laravel Activity Log – Record activity in your app
- Laravel Roles – Role-based access control
- Spatie Laravel Tags – Tagging models
- Laravel Installer – CLI installer for Laravel
- Laravel Breadcrumbs – Generate breadcrumbs in Laravel
- Laravel Mailgun – Mailgun integration for Laravel
- Laravel Trustup Model History – Store model change history
- Laravel Deployer – Deployment automation tool
- Laravel Auth – Custom authentication guards
- Laravel CORS – Cross-Origin Resource Sharing (CORS) support
- Laravel Notifications – Send notifications through multiple channels
- Spatie Laravel Http Logger – Log HTTP requests
- Laravel Permission Manager – Manage permissions easily
- Laravel Stubs – Customize default stubs in Laravel
- Laravel Fast Excel – Speed up Excel exports
- Laravel Image – Image processing
- Spatie Laravel Backup Server – Centralize backups for Laravel apps
- Laravel Forge API – Manage servers through the Forge API
- Laravel Blade SVG – Use SVGs in Blade templates
- Laravel Ban – Ban/unban users from your application
- Laravel API Response – Standardize API responses
- Laravel SEO – Manage SEO meta tags
- Laravel Settings – Store and retrieve settings
- Laravel DOMPDF – Generate PDFs
- Laravel Turbo – Full-stack framework for building modern web apps
- Spatie Laravel Event Sourcing – Event sourcing implementation
- Laravel Jetstream Inertia – Jetstream’s Inertia.js integration
- Laravel Envoy Tasks – Task automation
- Laravel Likeable – Like/dislike functionality
- Laravel GeoIP – Determine visitor’s geographic location
- Laravel Country State City – Dropdowns for country, state, and city
- Laravel Hashids – Generate short unique hashes
- Laravel Repository – Repository pattern for Laravel
- Laravel UUID – UUID generation for models
- Spatie Laravel Medialibrary Pro – Enhanced media management
- Laravel Queue Monitor – Monitor Laravel job queues
- Laravel User Activity – Monitor user activity
- Laravel DB Snapshots – Create database snapshots
- Laravel Twilio – Twilio integration
- Laravel Roles – Role-based permission handling
- Laravel Translatable – Add translations to Eloquent models
- Laravel Teamwork – Manage teams in multi-tenant apps
- Laravel Full Text Search – Add full-text search to Laravel models
- Laravel File Manager – File and media management
- Laravel User Timezones – Automatically detect user time zones
- Laravel ChartsJS – Render charts with ChartsJS
- Laravel Stripe – Stripe API integration
- Laravel PDF Generator – PDF generation
- Laravel Elasticsearch – Elasticsearch integration
- Laravel Simple Qrcode – Generate QR codes
- Laravel Timezone – Manage timezones and conversions
- Laravel Collective API – API management for Laravel
- Laravel Rest API Boilerplate – REST API starter kit
- Laravel Multi Auth – Multi-authentication functionality
- Laravel Voyager – Admin panel for Laravel
- Laravel Voyager Database – Database manager for Voyager
- Laravel Categories – Handle categories for models
- Laravel Multitenancy – Multi-tenancy implementation
- Laravel Access Control – Advanced access control for users
- Laravel Menus – Menu management
- Laravel Translatable Routes – Multilingual route handling