Laravel Settings – Store and retrieve settings

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:

Configuration

After installing the package, you need to publish the configuration file if you want to customize the settings:

Migration

You may need to create a migration for the settings table. You can use the built-in command:

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:

Basic Usage

Storing Settings

You can store settings in your application using the Settings facade:

Retrieving Settings

To retrieve settings, you can use the same facade:

Checking if a Setting Exists

You can check if a specific setting exists:

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.

1. Create a settings class:
   php
   

   namespace App\Settings; use Spatie\Settings\Settings; class SiteSettings extends Settings { public string $site_name; public string $site_description; // Add more settings as needed }

   1 2 3 4 5 6 7 8 9 10

   namespace App\Settings;   use Spatie\Settings\Settings;   class SiteSettings extends Settings {     public string $site_name;     public string $site_description;     // Add more settings as needed }
2. Register the settings class in a service provider (e.g., AppServiceProvider):
   php
   

   use App\Settings\SiteSettings; public function register() { $this->app->singleton(SiteSettings::class, function () { return new SiteSettings(); }); }

   1 2 3 4 5 6 7 8

   use App\Settings\SiteSettings;   public function register() {     $this->app->singleton(SiteSettings::class, function () {         return new SiteSettings();     }); }
3. Use the settings class in your application:
   php
   

   use App\Settings\SiteSettings; $settings = app(SiteSettings::class); $siteName = $settings->site_name;

   1 2 3 4

   use 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:

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.