PHPackages                             framesnpictures/el-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. framesnpictures/el-settings

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

framesnpictures/el-settings
===========================

Laravel Settings Module

0.2(1mo ago)028↓100%PHPPHP >=8.2

Since Apr 10Pushed 3w agoCompare

[ Source](https://github.com/FramesNPictures/el-settings)[ Packagist](https://packagist.org/packages/framesnpictures/el-settings)[ RSS](/packages/framesnpictures-el-settings/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (2)Dependencies (5)Versions (3)Used By (0)

el-settings
===========

[](#el-settings)

A Laravel package for storing and retrieving typed application settings backed by a database, with transparent cache layering and Laravel config fallback.

Why
---

[](#why)

Laravel config values are read from files at boot time and cannot be changed at runtime. This package solves the problem by letting you override any config value with a value stored in the database — without a deployment or server restart. An admin panel, artisan command, or any other runtime code can call `set()` and the new value is live immediately across the application.

How it works
------------

[](#how-it-works)

Settings are defined on a class that extends `SettingsDefiniton` using `#[UseSetting]` PHP attributes. Each setting has a key ( matching a Laravel config path), a type, and an optional description.

When a value is read with `get()`, it is resolved through a three-level chain:

1. **Cache** — served from the cache if present
2. **Database** — read from the `app_settings` table if not cached
3. **Config** — falls back to `config($key, $default)` if no DB record exists, and caches the result

When a value is written with `set()`, it is persisted to the database and the cache is updated immediately.

Installation
------------

[](#installation)

```
composer require framesnpictures/el-settings
```

The package auto-discovers its service provider. Publish the config file and migration, then run the migration:

```
php artisan vendor:publish --provider="Fnp\Settings\ElSettingsModule" --tag=config
php artisan vendor:publish --provider="Fnp\Settings\ElSettingsModule" --tag=migrations
php artisan migrate
```

Configuration
-------------

[](#configuration)

The published config file is `config/el-settings.php`:

```
return [
    'table' => 'app_settings',
];
```

Change `table` to use a different database table name.

Usage
-----

[](#usage)

### 1. Define a settings class

[](#1-define-a-settings-class)

Create a class extending `SettingsDefiniton` and annotate it with one `#[UseSetting]` attribute per setting:

```
use Fnp\Settings\Base\SettingsDefinition;
use Fnp\Settings\Attributes\UseSetting;
use Fnp\Settings\Enums\ESettingType;

#[UseSetting(config: 'app.name',     type: ESettingType::String,          description: 'Application name')]
#[UseSetting(config: 'app.debug',    type: ESettingType::Bool,            description: 'Debug mode')]
#[UseSetting(config: 'app.url',      type: ESettingType::EncryptedString,  description: 'Application URL')]
#[UseSetting(config: 'mail.port',    type: ESettingType::Number,           description: 'Mail port')]
#[UseSetting(config: 'app.options',  type: ESettingType::Array,            description: 'Feature flags')]
class AppSettings extends SettingsDefinition {}
```

The `config` parameter doubles as both the setting key and the Laravel config path used as a default value. The `description` parameter is stored alongside the value in the database, making it easy to identify and manage settings directly in a database client without needing to cross-reference the source code.

### 2. Initialize settings

[](#2-initialize-settings)

`init()` syncs the settings class with the database:

- **New keys** are inserted with the current value from Laravel config as their initial value.
- **Existing keys** are left untouched — their stored value is never overwritten — but their `description` is updated to reflect any changes made in the attribute.

```
AppSettings::init();
```

Call `init()` from a database migration every time a `#[UseSetting]` attribute is added or its description is changed. This keeps the database in sync with the code automatically on each deployment:

```
public function up(): void
{
    AppSettings::init();
}
```

### 3. Read a value

[](#3-read-a-value)

```
$name = AppSettings::get('app.name');

// With a fallback default
$timeout = AppSettings::get('app.timeout', 30);
```

### 4. Write a value

[](#4-write-a-value)

```
AppSettings::set('app.name', 'My App');
AppSettings::set('app.url',  'https://example.com'); // encrypted at rest
AppSettings::set('mail.port', 587);
AppSettings::set('app.options', ['feature_x' => true]);
```

`set()` validates that the value matches the declared type and throws `InvalidArgumentException` otherwise.

### 5. Setting types

[](#5-setting-types)

TypeConstantStoragePlain string`ESettingType::String``s` columnBoolean`ESettingType::Bool``n` columnInteger / float`ESettingType::Number``n` columnArray`ESettingType::Array``e` column (JSON)Object`ESettingType::Object``e` column (serialized, base64)Encrypted string`ESettingType::EncryptedString``e` column (encrypted, base64)### 6. Registering settings classes

[](#6-registering-settings-classes)

Add `ModuleSettingsClasses` to your module and implement `defineSettingsClasses()`. This lets the artisan commands discover available settings classes automatically without requiring a class name argument.

```
use Fnp\Settings\Features\ModuleSettingsClasses;

class AppModule extends ElModule
{
    use ModuleSettingsClasses;

    public function defineSettingsClasses(): array
    {
        return [AppSettings::class];
    }
}
```

Treat the above module as a normal Laravel service provider and register it in `config/app.php`.

See the [el-module](https://github.com/framesnpictures/el-module) package for more details.

### 7. Artisan commands

[](#7-artisan-commands)

The `class` argument is optional when settings classes are registered via `ModuleSettingsClasses`. If multiple classes are registered, the command will prompt you to choose one.

**Get a value**

```
# Class resolved from registry
php artisan settings:get app.name

# With explicit class
php artisan settings:get app.name --class="App\Settings\AppSettings"
```

**Set a value**

Pass the value directly on the command line:

```
php artisan settings:set app.name "My App"
php artisan settings:set mail.port 587
php artisan settings:set app.options '{"feature_x":true}'
```

Or read the value from a file (useful for long strings, certificates, or secrets):

```
php artisan settings:set app.url --file=/run/secrets/app_url
```

With an explicit class:

```
php artisan settings:set app.name "My App" --class="App\Settings\AppSettings"
```

**Initialize settings**

When called without `--class`, `settings:init` initializes every registered settings class:

```
# Init all registered classes
php artisan settings:init

# Init a specific class
php artisan settings:init --class="App\Settings\AppSettings"
```

### 7. Low-level access

[](#7-low-level-access)

```
// Read/write directly from cache (bypasses DB)
AppSettings::getCacheValue('app.name');
AppSettings::setCacheValue('app.name', 'value', ttl: 60);

// Read/write directly from the database (bypasses cache)
AppSettings::getDBValue('app.name');
AppSettings::setDBValue('app.name', 'value');

// Read from Laravel config
AppSettings::getConfigValue('app.name', 'default');
```

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE) for more information.

###  Health Score

38

—

LowBetter than 83% of packages

Maintenance92

Actively maintained with recent releases

Popularity10

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity37

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~2 days

Total

2

Last Release

57d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1183990?v=4)[Chris Cynarski](/maintainers/chris97pl)[@chris97pl](https://github.com/chris97pl)

---

Top Contributors

[![chris97pl](https://avatars.githubusercontent.com/u/1183990?v=4)](https://github.com/chris97pl "chris97pl (6 commits)")

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/framesnpictures-el-settings/health.svg)

```
[![Health](https://phpackages.com/badges/framesnpictures-el-settings/health.svg)](https://phpackages.com/packages/framesnpictures-el-settings)
```

###  Alternatives

[friendsoftypo3/frontend-editing

Enable editors to work with the content in the most intuitive way possible

103124.5k2](/packages/friendsoftypo3-frontend-editing)[jbboehr/dnsbl

DNSBL lookup

10369.1k1](/packages/jbboehr-dnsbl)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)