PHPackages                             ruangdeveloper/laravel-settings - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. ruangdeveloper/laravel-settings

ActiveLibrary[Utility & Helpers](/categories/utility)

ruangdeveloper/laravel-settings
===============================

Manage model or application settings in database

v2.2.0(1y ago)511.5k↓14.4%3[1 issues](https://github.com/ruangdeveloper/laravel-settings/issues)[1 PRs](https://github.com/ruangdeveloper/laravel-settings/pulls)MITPHPCI passing

Since Oct 24Pushed 1y agoCompare

[ Source](https://github.com/ruangdeveloper/laravel-settings)[ Packagist](https://packagist.org/packages/ruangdeveloper/laravel-settings)[ RSS](/packages/ruangdeveloper-laravel-settings/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (6)Dependencies (3)Versions (7)Used By (0)

Laravel Settings
================

[](#laravel-settings)

Introducing "Laravel Settings" – a powerful and flexible Laravel package designed to simplify the management of application settings, both at the global and model-specific levels. With this package, developers can effortlessly store, retrieve, and customize settings within the database, enhancing the configuration and flexibility of Laravel-based projects.

Whether you need to manage site-wide configurations, user preferences, or any other form of customizable settings, "Laravel Settings" provides an elegant solution to streamline the process. It offers a clean and intuitive API, ensuring that you can get started quickly without any steep learning curve.

Key Features:
-------------

[](#key-features)

- Global and Model-Specific Settings: "Laravel Settings" allows you to define both global settings, which apply to your entire application, and model-specific settings, which are associated with specific Eloquent models.
- Easy Configuration: You can define settings in a configuration file, making it a breeze to set up and manage your application's settings.
- Customizable: The package offers the flexibility to create custom setting types, ensuring that you can handle various data types, validation rules, and display options.
- Eloquent Integration: "Laravel Settings" seamlessly integrates with Laravel's Eloquent ORM, enabling you to link settings to specific database records.

Requirements
------------

[](#requirements)

- Laravel ^11.0 || ^12.0

Installation:
-------------

[](#installation)

To get started with "Laravel Settings," follow these simple installation steps:

Install the package via Composer:

```
composer require ruangdeveloper/laravel-settings
```

**Publish the configuration file:**

```
php artisan vendor:publish --provider="RuangDeveloper\LaravelSettings\LaravelSettingsServiceProvider" --tag="config"
```

Configure the settings in `config/laravel-settings.php` according to your application's requirements.

**Publish the migration file**

```
php artisan vendor:publish --provider="RuangDeveloper\LaravelSettings\LaravelSettingsServiceProvider" --tag="migrations"
```

Usage
-----

[](#usage)

Let's take a quick look at how you can use "Laravel Settings" to manage a global setting for your application.

**Set a global setting**

```
use RuangDeveloper\LaravelSettings\Facades\Settings;

// setting the global site title
Settings::set('site_title', 'Your Awesome Website');
```

**Get a global setting**

```
use RuangDeveloper\LaravelSettings\Facades\Settings;

// retrieve the global site title
$siteTItle = Settings::get('site_title');

// you may want to add a default fallback value if the setting
// with provided key doesn't exists in the database
$siteTitle = Settings::get('site_title', 'Your Default Awesome Website');
```

**Get a setting and cast it to a specific type**

```
use RuangDeveloper\LaravelSettings\Enums\Type;
use RuangDeveloper\LaravelSettings\Facades\Settings;

// retrieve the global site title
$siteTitle = Settings::getAs('site_title', Type::String);

// you may want to add a default fallback value if the setting
// with provided key doesn't exists in the database
$siteTitle = Settings::getAs('site_title', Type::String, 'Your Default Awesome Website');
```

Available types:

- String
- Integer
- Float
- Boolean
- Array
- Object

You can also use the following methods to get a setting and cast it to a specific type:

- `Settings::getString('key', $default)`
- `Settings::getInteger('key', $default)`
- `Settings::getFloat('key', $default)`
- `Settings::getBoolean('key', $default)`
- `Settings::getArray('key', $default)`
- `Settings::getObject('key', $default)`

### Delete a global setting

[](#delete-a-global-setting)

Now, if you want to delete the setting

```
use RuangDeveloper\LaravelSettings\Facades\Settings;

Settings::delete('site_title');
```

### Forget a global setting (deprecated, use delete instead)

[](#forget-a-global-setting-deprecated-use-delete-instead)

Now, if you want to delete the setting

```
use RuangDeveloper\LaravelSettings\Facades\Settings;

Settings::forget('site_title');
```

Model Specific Setting
----------------------

[](#model-specific-setting)

This package allow you to link the setting to a specific model. For example, you may want to store user's preferences.

**Model Configuration**The first step before linking the setting to a specific model, you need to configure your model to use the `HasSettings` traits.

```
use Illuminate\Database\Eloquent\Model;
use RuangDeveloper\LaravelSettings\Traits\HasSettings;

class User extends Model
{
    use HasSettings; // use the HasSettings trait

    protected $guarded = [];
}
```

Now, you can use the setting for an user.

**Set a setting**

```
$user = App\Models\User::find(1);
$user->setSetting('subscribe_newsletter', true);
```

**Get a setting**

```
$user = App\Models\User::find(1);
$isSubscribed = $user->getSetting('subscribe_newsletter');

// you may want to add a default fallback value if the setting
// with provided key doesn't exists in the database
$isSubscribed = $user->getSetting('subscribe_newsletter', false);
//
```

**Get a setting and cast it to a specific type**

```
use RuangDeveloper\LaravelSettings\Enums\Type;
use RuangDeveloper\LaravelSettings\Facades\Settings;

$user = App\Models\User::find(1);
$isSubscribed = $user->getSettingAs('subscribe_newsletter', Type::Boolean);

// you may want to add a default fallback value if the setting
// with provided key doesn't exists in the database
$isSubscribed = $user->getSettingAs('subscribe_newsletter', Type::Boolean, false);
```

Available types:

- String
- Integer
- Float
- Boolean
- Array
- Object

You can also use the following methods to get a setting and cast it to a specific type:

- `$yourModel->getSettingString('key', $default)`
- `$yourModel->getSettingInteger('key', $default)`
- `$yourModel->getSettingFloat('key', $default)`
- `$yourModel->getSettingBoolean('key', $default)`
- `$yourModel->getSettingArray('key', $default)`
- `$yourModel->getSettingObject('key', $default)`

**Delete a setting**

```
$user = App\Models\User::find(1);
$user->deleteSetting('subscribe_newsletter');
```

**Forget a setting (deprecated, use delete instead)**

```
$user = App\Models\User::find(1);
$user->forgetSetting('subscribe_newsletter');
```

Default Settings
----------------

[](#default-settings)

You may want add default settings value for global or model specific settings. You can add these settings value in the configuration file located at `configs/laravel-settings.php`.

> Note: if you cannot find the config file, you need to publish the configuration first.

**Default global settings**

```
return [
    // others config

    'defaults' => [
        'site_title' => 'Your Awesome Site',
    ],
];
```

Now, you will always get the default site title setting if there is no setting stored in the database.

```
use RuangDeveloper\LaravelSettings\Facades\Settings;

$siteTItle = Settings::get('site_title');

echo $siteTitle; // Your Awesome Site
```

**Default model specific settings**

```
return [
    // others config

    'model_defaults' => [
        'App\Models\User' => [
            'subscribe_newsletter' => false
        ],
    ],
];
```

Now, you will always get the default subscribe newsletter setting when you try to retrieve it from an user that didn't have setting for subscribe newsletter.

```
$user = App\Models\User::find(1);
$isSubscribed = $user->getSetting('subscribe_newsletter');

echo $isSubscribed // false
```

Cache
-----

[](#cache)

As you know, this package uses a database to store setting values. Every time you retrieve a setting value, it means you are making a query to the database. This is not a problem for small-scale applications, but it can have a significant impact when used in large-scale applications. To work around this, you can enable caching to store setting values in the cache, so the query is only performed once when you first attempt to retrieve a setting value.

To enable caching, you can go to the file `config/laravel-settings.php` and change the value of `with_cache` to true. You can also set the prefix and lifetime there.

```