PHPackages                             justustheis/registry - 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. [Caching](/categories/caching)
4. /
5. justustheis/registry

ActiveLibrary[Caching](/categories/caching)

justustheis/registry
====================

Flexible key–value store for Laravel with model scoping, encryption, caching, and runtime config overrides.

v0.0.3-alpha(2mo ago)0107MITPHP

Since Aug 26Pushed 2mo agoCompare

[ Source](https://github.com/justustheis/registry)[ Packagist](https://packagist.org/packages/justustheis/registry)[ RSS](/packages/justustheis-registry/feed)WikiDiscussions main Synced today

READMEChangelog (3)Dependencies (17)Versions (4)Used By (0)

Laravel Registry
================

[](#laravel-registry)

Laravel Registry is a powerful and flexible key–value store designed for managing application settings in Laravel. It offers a unified API with support for per-model scoping, optional encryption, caching, and a modern web interface. The package also supports overriding Laravel configuration values at runtime using registry entries — enabling dynamic, environment-specific configuration.

[![Laravel Registry](https://camo.githubusercontent.com/78e5b9a8967336b3ce0abcaa3d1a67e41db045aa2ddcd62f9ebb4a03ed306384/68747470733a2f2f6a2d74686569732e64652f72656769737472792e706e67)](https://camo.githubusercontent.com/78e5b9a8967336b3ce0abcaa3d1a67e41db045aa2ddcd62f9ebb4a03ed306384/68747470733a2f2f6a2d74686569732e64652f72656769737472792e706e67)

✨ Features
----------

[](#-features)

- 🔑 **Flexible Key-Value Storage** - Store any serializable data with dot-notation keys
- 🎯 **Model Scoping** - Scope registry entries to specific Eloquent models
- 🔐 **Encryption Support** - Encrypt sensitive values with Laravel's encryption
- ⚡ **Intelligent Caching** - Built-in Redis/Memcached caching with configurable TTL
- 🎨 **Modern Web Interface** - Vue 3 + Inertia.js frontend with Windows Registry Editor-like UI
- 🔧 **Runtime Config Overrides** - Override Laravel config values dynamically
- 📊 **Type Casting** - Automatic type detection and casting (string, int, float, bool, array, object)
- 🌳 **Hierarchical Keys** - Organize settings in tree structures with parent/child relationships
- 🔍 **Fluent API** - Chainable, expressive syntax for all operations
- 🧪 **Comprehensive Testing** - Full test coverage with PHPUnit
- 🚀 **Performance Optimized** - Efficient queries with proper indexing and caching

📋 Requirements
--------------

[](#-requirements)

- PHP 8.1+
- Laravel 12+
- Inertia.js 2.0+ (for frontend interface)

📦 Installation
--------------

[](#-installation)

### 1. Install via Composer

[](#1-install-via-composer)

```
composer require justustheis/registry
```

### 2. Publish Configuration

[](#2-publish-configuration)

```
php artisan vendor:publish --provider="JustusTheis\Registry\RegistryServiceProvider" --tag="config"
```

### 3. Run Migrations

[](#3-run-migrations)

```
php artisan migrate
```

### 4. Configure Authorization (Required)

[](#4-configure-authorization-required)

Add the authorization gate to your `AppServiceProvider`:

```
use Illuminate\Support\Facades\Gate;

public function boot()
{
    Gate::define('access-registry', function ($user) {
        return $user->isAdmin(); // Customize this logic
    });
}
```

🔐 Frontend Access Control
-------------------------

[](#-frontend-access-control)

**Important:** Before accessing the registry frontend, you must configure authorization using Laravel Gates. By default, the registry requires users to pass the `access-registry` gate to access the web interface.

### Setting Up Authorization

[](#setting-up-authorization)

Add this to your `AppServiceProvider` boot method:

```
use Illuminate\Support\Facades\Gate;

public function boot()
{
    // Define who can access the registry frontend
    Gate::define('access-registry', function ($user) {
        return $user->isAdmin(); // Adjust this logic as needed
    });
}
```

You can customize the gate name in the configuration:

```
// config/registry.php
'authorization' => [
    'enabled' => true,
    'gate' => 'access-registry', // Change this to your preferred gate name
],
```

To disable authorization entirely (not recommended for production):

```
'authorization' => [
    'enabled' => false,
],
```

⚙️ Configuration
----------------

[](#️-configuration)

The configuration file `config/registry.php` provides extensive customization options:

### Cache Configuration

[](#cache-configuration)

```
'cache' => [
    'driver' => env('REGISTRY_CACHE_DRIVER', 'redis'),
    'ttl'    => env('REGISTRY_CACHE_TTL', 86400), // 24 hours
],
```

### User Model Configuration

[](#user-model-configuration)

```
'user_model'       => App\Models\User::class,
'user_name_column' => 'name', // For "updated by" tracking
```

### Model Mappings for Route Binding

[](#model-mappings-for-route-binding)

```
'models' => [
    'User' => App\Models\User::class,
    'Product' => App\Models\Product::class,
    // Add your models here for hierarchical key parsing
],
```

### Type Casting Rules

[](#type-casting-rules)

```
'auto_cast_types' => env('REGISTRY_AUTO_CAST_TYPES', true),
'cast_rules' => [
    'boolean_true_values'  => ['true', 'yes', 'on'],
    'boolean_false_values' => ['false', 'no', 'off'],
    'null_values'          => ['null'],
    'numeric_detection'    => true,
    'array_detection'      => true,
    'object_detection'     => true,
],
```

### Runtime Config Overrides

[](#runtime-config-overrides)

```
'override' => [
    'production' => [
        'app.name' => 'app.name', // Maps config('app.name') to registry('app.name')
    ],
    'local' => [
        'mail.default' => 'mail.driver',
    ],
],
```

🚀 Basic Usage
-------------

[](#-basic-usage)

### Using the Facade

[](#using-the-facade)

```
use JustusTheis\Registry\Facades\Registry;

// Store a value
Registry::key('app.theme')->value('dark')->set();

// Retrieve a value
$theme = Registry::key('app.theme')->default('light')->get();

// Fluent API
$value = Registry::key('user.preferences')
    ->default(['notifications' => true])
    ->encrypt()
    ->set(['notifications' => false, 'theme' => 'dark']);
```

### Using Helper Functions

[](#using-helper-functions)

```
// Simple get/set operations
registry_set('app.debug', true);
$debug = registry_get('app.debug', false);

// Delete a key
registry_delete('app.debug');

// Flexible registry() helper
$value = registry('app.name', 'Default App Name');
$registry = registry(); // Returns Registry instance
```

### Working with Different Data Types

[](#working-with-different-data-types)

```
// String values
Registry::key('app.name')->value('My Application')->set();

// Numeric values
Registry::key('app.version')->value(1.5)->set();

// Boolean values
Registry::key('app.debug')->value(true)->set();

// Arrays and Objects
Registry::key('user.preferences')->value([
    'theme' => 'dark',
    'notifications' => true,
    'sidebar_collapsed' => false
])->set();
```

🎯 Model Scoping
---------------

[](#-model-scoping)

Use the `HasRegistry` trait to scope registry entries to specific models:

### Adding the Trait

[](#adding-the-trait)

```
use JustusTheis\Registry\Traits\HasRegistry;

class User extends Model
{
    use HasRegistry;
}
```

### Scoped Operations

[](#scoped-operations)

```
$user = User::find(1);

// Set user-specific settings
$user->registry()->key('preferences.theme')->value('dark')->set();

// Get user-specific settings
$theme = $user->registry()->key('preferences.theme')->default('light')->get();

// Using helper functions with model scoping
registry_set('notifications.email', true, $user);
$emailNotifications = registry_get('notifications.email', false, $user);
```

### Relationship Access

[](#relationship-access)

```
// Access all registry entries for a model
$entries = $user->registryEntries;

// Check if user has specific settings
if ($user->registry()->key('preferences.theme')->exists()) {
    // User has custom theme
}
```

🎨 Frontend Web Interface
------------------------

[](#-frontend-web-interface)

The package includes a complete Vue 3 + Inertia.js frontend that provides a Windows Registry Editor-like interface.

### Features

[](#features)

- 🌳 **Two-pane layout** - Tree view on left, details on right
- 🔍 **Real-time search** - Filter keys as you type
- ✏️ **In-place editing** - Create, update, delete entries via modals
- 🔐 **Encryption toggle** - Visual indication and control of encrypted entries
- 📱 **Responsive design** - Works on desktop and mobile
- 🎨 **Tailwind CSS** - Modern, clean interface

### Setup

[](#setup)

#### 1. Install Frontend Dependencies

[](#1-install-frontend-dependencies)

```
npm install
```

#### 2. Publish Assets (Optional)

[](#2-publish-assets-optional)

```
php artisan vendor:publish --provider="JustusTheis\Registry\RegistryServiceProvider" --tag="registry-assets"
```

#### 3. Configure Inertia.js

[](#3-configure-inertiajs)

Ensure you have an Inertia.js app template. The package includes one you can copy:

```
cp vendor/justustheis/registry/resources/views/app.blade.php resources/views/app.blade.php
```

#### 4. Build Assets

[](#4-build-assets)

```
# Development
npm run dev

# Production
npm run build
```

### Accessing the Interface

[](#accessing-the-interface)

Visit `/registry` in your browser (after setting up the authorization gate).

🔐 Encryption
------------

[](#-encryption)

Encrypt sensitive data automatically:

```
// Encrypt a single value
Registry::key('api.secret')->value('sensitive-data')->encrypt()->set();

// Retrieve encrypted value (automatically decrypted)
$secret = Registry::key('api.secret')->get();

// Using helpers
registry_set('database.password', 'secret123', null, true); // true = encrypt
$password = registry_get('database.password', null, null, true);
```

🌳 Hierarchical Keys
-------------------

[](#-hierarchical-keys)

Organize settings in tree structures:

```
// Create hierarchical structure
Registry::key('app.mail.driver')->value('smtp')->set();
Registry::key('app.mail.host')->value('smtp.gmail.com')->set();
Registry::key('app.mail.port')->value(587)->set();

// Work with parent/child relationships
$mailConfig = Registry::key('app.mail.driver');
$parent = $mailConfig->parent(); // Returns 'app.mail' registry
$children = $mailConfig->children(); // Collection of child registries

// Get hierarchical key for display
echo $mailConfig->getHierarchicalKey(); // "app.mail.driver"
```

⚡ Advanced Features
-------------------

[](#-advanced-features)

### Caching

[](#caching)

Registry entries are automatically cached for performance:

```
// Cache configuration in config/registry.php
'cache' => [
    'driver' => 'redis', // or 'memcached', 'file', etc.
    'ttl'    => 86400,   // 24 hours
],
```

### Runtime Configuration Overrides

[](#runtime-configuration-overrides)

Override Laravel config values dynamically:

```
// In config/registry.php
'override' => [
    'production' => [
        'app.name' => 'app.name', // config('app.name') will check registry first
    ],
],

// Set override value
Registry::key('app.name')->value('Production App')->set();

// Now config('app.name') returns 'Production App'
echo config('app.name'); // "Production App"
```

### Cascade Deletion

[](#cascade-deletion)

Automatically delete registry entries when parent models are deleted:

```
// In config/registry.php
'cascade_on_delete' => true,
'cascade_on_soft_delete' => false,
```

### Type Validation and Casting

[](#type-validation-and-casting)

```
// Explicit type setting
Registry::key('count')->value(42)->type('integer')->set();
Registry::key('data')->value($array)->type('array')->set();

// Automatic type detection (default)
Registry::key('auto')->value('123')->set(); // Stored as integer 123
Registry::key('auto')->value('true')->set(); // Stored as boolean true
```

📚 API Reference
---------------

[](#-api-reference)

### Core Methods

[](#core-methods)

#### `Registry::key(string $key): self`

[](#registrykeystring-key-self)

Set the registry key for the operation.

#### `Registry::value(mixed $value): self`

[](#registryvaluemixed-value-self)

Set the value to be stored.

#### `Registry::default(mixed $default): self`

[](#registrydefaultmixed-default-self)

Set the default value if key doesn't exist.

#### `Registry::for(Model $model): self`

[](#registryformodel-model-self)

Scope the registry to a specific model.

#### `Registry::encrypt(): self`

[](#registryencrypt-self)

Mark the value for encryption.

#### `Registry::type(string $type): self`

[](#registrytypestring-type-self)

Explicitly set the value type.

### CRUD Operations

[](#crud-operations)

#### `get(?string $key = null, mixed $default = null): mixed`

[](#getstring-key--null-mixed-default--null-mixed)

Retrieve a value from the registry.

#### `set(?string $key = null, mixed $value = null): mixed`

[](#setstring-key--null-mixed-value--null-mixed)

Store a value in the registry.

#### `delete(?string $key = null): bool`

[](#deletestring-key--null-bool)

Delete a key from the registry.

#### `exists(?string $key = null): bool`

[](#existsstring-key--null-bool)

Check if a key exists in the registry.

#### `rename(string $newKey, bool $renameChildren = true): self`

[](#renamestring-newkey-bool-renamechildren--true-self)

Rename a registry key and optionally its children.

### Relationship Methods

[](#relationship-methods)

#### `parent(): ?self`

[](#parent-self)

Get the parent registry instance.

#### `children(): Collection`

[](#children-collection)

Get all direct child registry instances.

💡 Usage Examples
----------------

[](#-usage-examples)

### User Preferences System

[](#user-preferences-system)

```
class User extends Model
{
    use HasRegistry;
}

// Set user preferences
$user = User::find(1);
$user->registry()->key('preferences')->value([
    'theme' => 'dark',
    'language' => 'en',
    'notifications' => [
        'email' => true,
        'push' => false,
        'sms' => false
    ]
])->set();

// Get specific preference
$theme = $user->registry()->key('preferences.theme')->default('light')->get();

// Update single preference
$user->registry()->key('preferences.language')->value('es')->set();
```

### Application Configuration

[](#application-configuration)

```
// Environment-specific settings
if (app()->environment('production')) {
    Registry::key('app.debug')->value(false)->set();
    Registry::key('cache.default')->value('redis')->set();
} else {
    Registry::key('app.debug')->value(true)->set();
    Registry::key('cache.default')->value('file')->set();
}

// API configuration with encryption
Registry::key('services.stripe.secret')
    ->value('sk_test_...')
    ->encrypt()
    ->set();
```

### Feature Flags

[](#feature-flags)

```
// Global feature flags
Registry::key('features.new_dashboard')->value(true)->set();
Registry::key('features.beta_search')->value(false)->set();

// User-specific feature overrides
$user->registry()->key('features.beta_search')->value(true)->set();

// Check feature availability
function hasFeature($feature, $user = null) {
    if ($user && $user->registry()->key("features.{$feature}")->exists()) {
        return $user->registry()->key("features.{$feature}")->get();
    }

    return registry_get("features.{$feature}", false);
}
```

🧪 Testing
---------

[](#-testing)

Run the test suite:

```
# Run all tests
vendor/bin/phpunit

# Run with coverage
vendor/bin/phpunit --coverage-html coverage/

# Run specific test categories
vendor/bin/phpunit --filter RegistryCache
vendor/bin/phpunit --filter RegistryEncryption
vendor/bin/phpunit --filter RegistryScope
```

🔧 Artisan Commands
------------------

[](#-artisan-commands)

The package doesn't include specific Artisan commands, but you can interact with it using Tinker:

```
php artisan tinker

# Try some commands
Registry::key('test')->value('Hello World')->set()
Registry::key('test')->get()
registry('test', 'Default Value')
```

📄 License
---------

[](#-license)

This package is open-sourced software licensed under the [MIT license](LICENSE.md).

🤝 Contributing
--------------

[](#-contributing)

Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.

🐛 Issues
--------

[](#-issues)

If you discover any security vulnerabilities or bugs, please report them via [GitHub Issues](https://github.com/justustheis/registry/issues).

📞 Support
---------

[](#-support)

For support, please create an issue on GitHub or contact the maintainer at .

###  Health Score

33

—

LowBetter than 72% of packages

Maintenance86

Actively maintained with recent releases

Popularity11

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity24

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 ~118 days

Total

3

Last Release

75d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/7760415?v=4)[Justus Theis](/maintainers/justustheis)[@justustheis](https://github.com/justustheis)

---

Top Contributors

[![justustheis](https://avatars.githubusercontent.com/u/7760415?v=4)](https://github.com/justustheis "justustheis (13 commits)")

---

Tags

laravelconfigurationSettingsdot-accessencryptioncachinginertiaregistryvuedynamic-configkey value storescopingfrontend-settingssettings-uitenant-settingsconfig-management

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StyleLaravel Pint

Type Coverage Yes

### Embed Badge

![Health badge](/badges/justustheis-registry/health.svg)

```
[![Health](https://phpackages.com/badges/justustheis-registry/health.svg)](https://phpackages.com/packages/justustheis-registry)
```

###  Alternatives

[psalm/plugin-laravel

Psalm plugin for Laravel

3355.3M346](/packages/psalm-plugin-laravel)[mike-bronner/laravel-model-caching

Automatic caching for Eloquent models.

2.4k91.0k1](/packages/mike-bronner-laravel-model-caching)[laravel/ai

The official AI SDK for Laravel.

1.0k3.2M194](/packages/laravel-ai)[yajra/laravel-oci8

Oracle DB driver for Laravel via OCI8

8793.2M25](/packages/yajra-laravel-oci8)[erag/laravel-lang-sync-inertia

A powerful Laravel package for syncing and managing language translations across backend and Inertia.js (Vue/React/Svelte) frontends, offering effortless localization, auto-sync features, and smooth multi-language support for modern Laravel applications.

4925.3k](/packages/erag-laravel-lang-sync-inertia)[emargareten/inertia-modal

Inertia Modal is a Laravel package that lets you implement backend-driven modal dialogs for Inertia apps.

90142.9k](/packages/emargareten-inertia-modal)

PHPackages © 2026

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