DB Config

https://github.com/inerba/filament-db-config
Admin
DB Config is a Filament plugin that provides a simple, database-backed key/value store for managing...
Tokens:27,625
Snippets:433
Trust Score:5.8
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Artisan generator examples

Source: https://github.com/inerba/filament-db-config/blob/main/README.md

Examples of using the make:db-config command with different arguments.

```bash
php artisan make:db-config website            # default panel
php artisan make:db-config website admin      # specific panel (e.g. Admin)
```

--------------------------------

### Install Package

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/index.md

Install the package via Composer.

```bash
composer require inerba/filament-db-config
```

--------------------------------

### Example Settings Array Structure

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/types.md

An example of an associative array representing configuration values.

```php
[
    'site_name' => 'My Awesome Site',
    'tagline' => 'The best site',
    'maintenance_mode' => false,
    'contact' => [
        'email' => 'info@example.com',
        'phone' => '555-1234',
    ],
    'features' => null,
]
```

--------------------------------

### Configuration Key Examples

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/types.md

Examples of dotted notation strings used for accessing configuration values.

```text
'website.site_name'
'contact.details.email'
'app.settings.dark_mode'
'blog.categories.0.name'
```

--------------------------------

### Install development dependencies

Source: https://github.com/inerba/filament-db-config/blob/main/README.md

Run this command to install the necessary dependencies for running the test suite.

```bash
composer install
```

--------------------------------

### Define created_at column example values

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/database-schema.md

Example timestamp values for record creation.

```text
2024-09-03 14:30:00
2024-08-15 08:45:30
```

--------------------------------

### Usage examples for db_config

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-helpers.md

Examples showing how to retrieve simple and nested settings, as well as usage within Blade templates.

```php
$siteName = db_config('website.site_name', 'My Website');
```

```php
$email = db_config('contact.details.email', 'no-reply@example.com');
```

```blade
<!-- In Blade templates -->
<h1>{{ db_config('website.site_name') }}</h1>
```

--------------------------------

### Timestamp Format Examples

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/types.md

Examples of formatted date strings returned by the system.

```php
'September 3, 2024, 2:30 pm'
'2024-09-03'
'2024-09-03 14:30:00'
'03/09/2024'
```

--------------------------------

### Define key column example values

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/database-schema.md

Example values for the setting key within a group.

```text
'site_name'
'contact_email'
'maintenance_mode'
'posts_per_page'
'theme'
```

--------------------------------

### Define updated_at column example values

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/database-schema.md

Example timestamp values for record modification.

```text
2024-09-03 14:35:45
2024-09-01 10:20:15
```

--------------------------------

### Define group column example values

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/database-schema.md

Example values for the configuration group identifier.

```text
'website'
'blog'
'email'
'contact'
'app'
```

--------------------------------

### Define settings column example values

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/database-schema.md

Example JSON-encoded values for the settings column.

```json
"My Awesome Site"
123
true
null
["value1", "value2"]
{"email": "info@example.com", "phone": "555-1234"}
```

--------------------------------

### Complete Widget Implementation

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-abstractwidgetsettings.md

A full example of an AbstractWidgetSettings class including default data and form schema.

```php
<?php

namespace App\Filament\Resources\Post\Widgets;

use Filament\Schemas\Components;
use Filament\Schemas\Schema;
use Inerba\DbConfig\AbstractWidgetSettings;

class BlogSettings extends AbstractWidgetSettings
{
    protected int | string | array $columnSpan = 'full';

    protected function settingName(): string
    {
        return 'blog-settings';
    }

    public function getDefaultData(): array
    {
        return [
            'posts_per_page' => 10,
            'allow_comments' => true,
            'moderation_enabled' => false,
        ];
    }

    public function form(Schema $schema): Schema
    {
        return $schema
            ->components([
                Components\TextInput::make('posts_per_page')
                    ->required()
                    ->numeric()
                    ->label('Posts Per Page'),
                Components\Toggle::make('allow_comments')
                    ->label('Allow Comments'),
                Components\Toggle::make('moderation_enabled')
                    ->label('Enable Comment Moderation'),
            ])
            ->statePath('data');
    }
}
```

--------------------------------

### Usage examples for safe_db_config

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-helpers.md

Examples demonstrating safe configuration retrieval in service providers, middleware, and Blade templates to prevent errors during database unavailability.

```php
// In a service provider where the database might not be ready
$maintenanceMode = safe_db_config('app.maintenance_mode', false);
if ($maintenanceMode) {
    // Enable maintenance mode
}
```

```php
class SetConfigFromDatabase
{
    public function handle($request, $next)
    {
        // Gracefully fall back if the config table doesn't exist yet
        $theme = safe_db_config('ui.theme', 'light');
        config(['app.theme' => $theme]);
        
        return $next($request);
    }
}
```

```blade
<!-- Prevents errors if db_config table doesn't exist yet -->
<body class="{{ safe_db_config('ui.theme', 'light') }}">
    ...
</body>
```

--------------------------------

### Configure Table Name

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/configuration.md

Example of setting the database table name in the configuration file.

```php
'table_name' => 'application_config',
```

--------------------------------

### Cache Key Prefix Configuration

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/configuration.md

Example of setting the cache prefix in the configuration file.

```php
'cache' => [
    'prefix' => 'my-app-settings',
    // ...
],
```

--------------------------------

### Define id column example values

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/database-schema.md

Example values for the auto-incrementing primary key.

```text
1, 2, 3, ...
```

--------------------------------

### Incorrect Configuration Example

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/errors.md

An example of a configuration class missing the required form schema definition, which will trigger the exception.

```php
class BrokenSettings extends AbstractPageSettings
{
    // ✗ Missing form() method
    public function settingName(): string
    {
        return 'broken';
    }
    // Calling save() will throw RuntimeException
}
```

--------------------------------

### Generate Settings Page by Name

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-command.md

Example of generating a settings page using only the name argument.

```bash
php artisan make:db-config website
# Generates: App/Filament/Admin/Pages/WebsiteSettings.php
# Group name: website
```

--------------------------------

### Retrieve configuration values with DbConfig::get()

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-dbconfig.md

Use these examples to fetch configuration values, including support for nested keys via dot notation.

```php
$siteName = DbConfig::get('website.site_name', 'Default Site');
// Retrieves value from group 'website', setting 'site_name'
```

```php
// After storing: DbConfig::set('contact.details', ['email' => 'info@example.com'])
$email = DbConfig::get('contact.details.email', 'noemail@example.com');
// => 'info@example.com'
```

--------------------------------

### Migration Table Creation

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/configuration.md

Example of using the configured table name within a migration file.

```php
$tableName = config('db-config.table_name', 'db_config');
Schema::create($tableName, function (Blueprint $table) {
    // ...
});
```

--------------------------------

### Cache TTL Configuration

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/configuration.md

Examples of configuring the cache Time To Live (TTL) in minutes.

```php
'cache' => [
    'prefix' => 'db-config',
    'ttl' => null, // or 0, both cache forever
],
```

```php
'cache' => [
    'prefix' => 'db-config',
    'ttl' => 60, // Minutes
],
```

```php
'cache' => [
    'prefix' => 'db-config',
    'ttl' => 30,
],
```

--------------------------------

### Store and Retrieve String Values

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/database-schema.md

Example of storing and retrieving string data.

```text
group: 'website'
key: 'site_name'
settings: "\"My Awesome Site\""
```

--------------------------------

### Generate Settings Page by Name and Panel

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-command.md

Example of generating a settings page specifying both the name and the target Filament panel.

```bash
php artisan make:db-config website admin
# Generates: App/Filament/Admin/Pages/WebsiteSettings.php
```

--------------------------------

### Publish Plugin Assets via Artisan

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/service-provider.md

Commands to publish configuration, migrations, stubs, or perform a full installation.

```bash
php artisan vendor:publish --tag="db-config-config"
```

```bash
php artisan vendor:publish --tag="db-config-migrations"
```

```bash
php artisan vendor:publish --tag="db-config-stubs"
```

```bash
php artisan db-config:install
```

--------------------------------

### Blade Directive Usage Examples

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-helpers.md

Demonstrates simple echoing, variable defaults, and nested configuration access.

```blade
<h1>{{ db_config('website.site_name', 'My Site') }}</h1>

<!-- Alternative Blade directive syntax -->
@db_config('website.site_name', 'My Site')
```

```blade
@php
$fallbackSiteName = 'Default Site Name';
@endphp

<h1>@db_config('website.site_name', $fallbackSiteName)</h1>
```

```blade
<p>Email: @db_config('contact.details.email', 'no-reply@example.com')</p>
```

--------------------------------

### Example Form State Array

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/types.md

An example of an associative array representing Filament form field values.

```php
[
    'site_name' => 'New Value',
    'contact_email' => 'newemail@example.com',
    'maintenance_mode' => true,
]
```

--------------------------------

### Store and Retrieve Numeric Values

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/database-schema.md

Example of storing and retrieving integer data.

```text
group: 'blog'
key: 'posts_per_page'
settings: "10"
```

--------------------------------

### Store and Retrieve Null Values

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/database-schema.md

Example of storing and retrieving null data.

```text
group: 'settings'
key: 'feature_flag'
settings: "null"
```

--------------------------------

### Define page content schema

Source: https://github.com/inerba/filament-db-config/blob/main/README.md

Example implementation of the content method for a settings page.

```php
use Filament\Forms\Components\TextInput;
use Filament\Schemas\Schema;

public function content(Schema $schema): Schema
{
    return $schema
        ->components([
            TextInput::make('site_name')->required(),
            // ... other inputs
        ])
        ->statePath('data');
}
```

--------------------------------

### Store and Retrieve Boolean Values

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/database-schema.md

Example of storing and retrieving boolean data.

```text
group: 'app'
key: 'maintenance_mode'
settings: "true"
```

--------------------------------

### Configure Package Lifecycle

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/service-provider.md

Defines the configurePackage method for package installation, command registration, and asset publishing.

```php
public function configurePackage(Package $package): void
```

```php
public function configurePackage(Package $package): void
{
    $package->name(static::$name)
        ->hasCommands($this->getCommands())
        ->hasInstallCommand(function (InstallCommand $command) {
            $command
                ->publishConfigFile()
                ->publishMigrations()
                ->askToRunMigrations()
                ->askToStarRepoOnGitHub('inerba/db-config');
        });

    $configFileName = $package->shortName();

    if (file_exists($package->basePath("/../config/{$configFileName}.php"))) {
        $package->hasConfigFile();
    }

    if (file_exists($package->basePath('/../database/migrations'))) {
        $package->hasMigrations($this->getMigrations());
    }

    if (file_exists($package->basePath('/../resources/lang'))) {
        $package->hasTranslations();
    }

    if (file_exists($package->basePath('/../resources/views'))) {
        $package->hasViews();
    }
}
```

--------------------------------

### Retrieve configuration groups with DbConfig::getGroup()

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-dbconfig.md

Use these examples to fetch all settings within a specific group as an associative array. Note that this method bypasses the cache.

```php
// Assume DB has: 
//   group='website', key='site_name', settings='"My Site"'
//   group='website', key='tagline', settings='"Best Ever"'
$all = DbConfig::getGroup('website');
// => ['site_name' => 'My Site', 'tagline' => 'Best Ever']
```

```php
$empty = DbConfig::getGroup('nonexistent');
// => []
```

--------------------------------

### Catching RuntimeException

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/errors.md

Example of wrapping the parent save method in a try-catch block to handle configuration save failures.

```php
class MySettings extends AbstractPageSettings
{
    public function save(): void
    {
        try {
            parent::save();
        } catch (\RuntimeException $e) {
            \Log::error('Save failed: ' . $e->getMessage());
            throw $e; // Or handle gracefully
        }
    }
}
```

--------------------------------

### Store and Retrieve Array/Object Values

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/database-schema.md

Example of storing and retrieving complex JSON objects.

```text
group: 'contact'
key: 'details'
settings: "{\"email\":\"info@example.com\",\"phone\":\"555-1234\"}"
```

```json
{"email": "info@example.com", "phone": "555-1234"}
```

```php
DbConfig::get('contact.details')
// Returns: ['email' => 'info@example.com', 'phone' => '555-1234']

DbConfig::get('contact.details.email')
// Returns: 'info@example.com'
```

--------------------------------

### Simulating Database Connection Exceptions

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/errors.md

Examples of common database exceptions triggered by missing tables or connection issues.

```php
// Database table not created yet
DbConfig::get('group.key');
// → PDOException: Table 'database.db_config' doesn't exist

// Database connection refused
DbConfig::set('group.key', 'value');
// → PDOException: SQLSTATE[HY000]: General error: Connection refused

// Database server down
DbConfig::getGroup('website');
// → QueryException: SQLSTATE[HY000]: General error: Lost connection...
```

--------------------------------

### Simulating Cache Access Failures

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/errors.md

Examples of exceptions thrown when the underlying cache driver is unavailable or misconfigured.

```php
// Redis cache unavailable
DbConfig::get('group.key');
// → RedisException: Connection refused

// File cache not writable
DbConfig::get('group.key');
// → RuntimeException: Unable to create cache directory
```

--------------------------------

### Usage Examples for getGroupLastUpdatedAt

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-dbconfig.md

Demonstrates retrieving the last update timestamp using default settings versus custom formatting and timezone parameters.

```php
$updated = DbConfig::getGroupLastUpdatedAt('website');
// => "September 3, 2024, 2:30 pm"
```

```php
$updated = DbConfig::getGroupLastUpdatedAt(
    'website',
    'Y-m-d H:i:s',
    'Europe/Rome'
);
// => "2024-09-03 14:30:00"
```

--------------------------------

### Store configuration values with DbConfig::set()

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-dbconfig.md

Use these examples to persist configuration values to the database, which automatically triggers cache invalidation.

```php
DbConfig::set('website.site_name', 'Acme Inc.');
// Creates or updates row: group='website', key='site_name', settings='"Acme Inc."'
```

```php
DbConfig::set('contact.details', [
    'email' => 'info@acme.test',
    'phone' => '555-1234',
]);
// Stores as JSON array: {"email":"info@acme.test","phone":"555-1234"}
```

--------------------------------

### PHP Type Union Implementations

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/types.md

Examples of using union types and mixed types for flexible method signatures.

```php
// Multiple possible return types
public function example(): string|null
{
    // Returns either a string or null
}

// Multiple parameter types
public function store(string|int|array $value): void
{
    // Accepts string, int, or array
}

// Mixed type (any type)
public function getValue(mixed $default = null): mixed
{
    // Can accept or return any type
}
```

--------------------------------

### Compare Facade and Class Usage

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-facades.md

Demonstrates the equivalence between using the DbConfig facade and the underlying class directly.

```php
use Inerba\DbConfig\Facades\DbConfig;

// Using the facade
DbConfig::get('website.site_name', 'Default');
DbConfig::set('website.site_name', 'New Value');
DbConfig::getGroup('website');
DbConfig::getGroupLastUpdatedAt('website');
```

```php
use Inerba\DbConfig\DbConfig;

// Using the class directly
DbConfig::get('website.site_name', 'Default');
DbConfig::set('website.site_name', 'New Value');
DbConfig::getGroup('website');
DbConfig::getGroupLastUpdatedAt('website');
```

--------------------------------

### Usage Example for Last Updated Timestamp

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-abstractwidgetsettings.md

Demonstrates how to display the last updated timestamp within a form component.

```php
class BlogSettings extends AbstractWidgetSettings
{
    public function form(Schema $schema): Schema
    {
        return $schema->components([
            TextInput::make('posts_per_page'),
            Placeholder::make('updated_at')
                ->content('Last updated: ' . ($this->lastUpdatedAt() ?? 'Never')),
        ]);
    }
}
```

--------------------------------

### Retrieve configuration values using different access methods

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-facades.md

Demonstrates the three equivalent ways to fetch a configuration value from the database.

```php
use Inerba\DbConfig\Facades\DbConfig;

DbConfig::get('website.site_name');
```

```php
use Inerba\DbConfig\DbConfig;

DbConfig::get('website.site_name');
```

```php
db_config('website.site_name');
```

--------------------------------

### Run Database Migrations

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/database-schema.md

Execute the migration command to create the necessary database table.

```bash
php artisan migrate
```

--------------------------------

### Boot Plugin

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/service-provider.md

Lifecycle method called after all plugins are registered.

```php
public function boot(Panel $panel): void
{
    // Currently empty - no plugin-level booting needed
}
```

--------------------------------

### Publish and Run Migrations

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/configuration.md

Commands to publish the package migration file and apply it to the database.

```bash
php artisan vendor:publish --tag="db-config-migrations"
```

```bash
php artisan migrate
```

--------------------------------

### DbConfigTrait::mount() Method Signature

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/types.md

Initializes the component data by merging defaults with database values.

```php
public function mount(): void
```

--------------------------------

### Import AbstractWidgetSettings

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-abstractwidgetsettings.md

Include this namespace to extend the base class for custom settings widgets.

```php
use Inerba\DbConfig\AbstractWidgetSettings;
```

--------------------------------

### DbConfig::getGroupLastUpdatedAt()

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-facades.md

Get the last-updated timestamp for a group.

```APIDOC
## DbConfig::getGroupLastUpdatedAt()

### Description
Get the last-updated timestamp for a group.

### Signature
`DbConfig::getGroupLastUpdatedAt(string $group, string $format = 'F j, Y, g:i a', string $timezone = 'UTC'): ?string`

### Parameters
- **$group** (string) - Required - The configuration group name.
- **$format** (string) - Optional - The date format string.
- **$timezone** (string) - Optional - The timezone for the timestamp.

### Example
```php
$updated = DbConfig::getGroupLastUpdatedAt('website', 'Y-m-d', 'America/New_York');
```
```

--------------------------------

### Importing the Facade

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-facades.md

Shows how to import the Facade class for use in your application files.

```php
use Inerba\DbConfig\Facades\DbConfig;

// Or use without importing (if aliased globally)
DbConfig::get('website.site_name');
```

--------------------------------

### Get Plugin Identifier

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/service-provider.md

Returns the unique identifier for the Filament plugin.

```php
public function getId(): string
{
    return 'db-config';
}
```

--------------------------------

### Import and Use Facade

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-facades.md

Methods for importing or accessing the facade after registration.

```php
use Inerba\DbConfig\Facades\DbConfig;
```

```php
DbConfig::get('website.site_name');
```

--------------------------------

### Validate JSON-serializable values

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/errors.md

Examples of values that will succeed or fail when passed to DbConfig::set().

```php
// ✗ Will fail (circular reference)
$array = [];
$array['self'] = &$array;
DbConfig::set('group.key', $array);

// ✓ Will succeed (simple types)
DbConfig::set('group.key', 'string value');
DbConfig::set('group.key', 123);
DbConfig::set('group.key', true);
DbConfig::set('group.key', ['array', 'of', 'values']);
DbConfig::set('group.key', null);

// ✓ Will succeed (nested structures)
DbConfig::set('group.key', [
    'nested' => [
        'values' => 'work fine',
        'count' => 42,
    ],
]);

// ✗ Will fail (resource)
$handle = fopen('file.txt', 'r');
DbConfig::set('group.key', $handle);

// ✗ Will fail (object without JSON serialization)
$object = new SomeClass();
DbConfig::set('group.key', $object);
```

--------------------------------

### Command Signature

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-command.md

The basic syntax for executing the make:db-config command.

```bash
php artisan make:db-config [name] [panel]
```

--------------------------------

### Package Configuration

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/index.md

Define the database table name and cache settings in the configuration file.

```php
return [
    'table_name' => 'db_config',
    'cache' => [
        'prefix' => 'db-config',
        'ttl' => null, // Cache forever
    ],
];
```

--------------------------------

### Write a Setting

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/index.md

Update or create a configuration value in the database.

```php
DbConfig::set('group.key', 'value');
```

--------------------------------

### Use Facade for configuration

Source: https://github.com/inerba/filament-db-config/blob/main/README.md

Access configuration values using the provided Facade.

```php
\Inerba\DbConfig\Facades\DbConfig::get('website.site_name');
```

--------------------------------

### Run Package Migrations

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/index.md

Execute these commands to update assets and database schema when upgrading or resolving table not found errors.

```bash
php artisan vendor:publish --tag="db-config-migrations" --force
php artisan migrate
```

```bash
php artisan migrate
```

--------------------------------

### Define View Namespace

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/service-provider.md

Sets the namespace for Blade views and provides examples of usage in templates.

```php
public static string $viewNamespace = 'db-config';
```

```blade
@include('db-config::filament.pages.settings-help')
@extends('db-config::filament.pages.default')
```

--------------------------------

### Read a Setting

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/index.md

Retrieve a configuration value using the facade or the helper function.

```php
use Inerba\DbConfig\DbConfig;

$value = DbConfig::get('group.key', 'default');
// or
$value = db_config('group.key', 'default');
```

--------------------------------

### Using DbConfig in Service Providers

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-facades.md

Retrieve configuration values during the application boot process.

```php
<?php

namespace App\Providers;

use Inerba\DbConfig\Facades\DbConfig;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $maintenanceMode = DbConfig::get('app.maintenance_mode', false);
        if ($maintenanceMode) {
            // Enable maintenance mode
        }
    }
}
```

--------------------------------

### Use Configuration in Code

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/index.md

Read and write configuration values using helper functions or the Facade.

```php
// Read values anywhere
$siteName = db_config('website.site_name', 'Default');

// In templates
<h1>{{ db_config('website.site_name') }}</h1>

// Write values programmatically
DbConfig::set('website.site_name', 'New Value');
```

--------------------------------

### Get last update time for a group

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/database-schema.md

Determines the most recent update timestamp for all records within a specific group.

```sql
SELECT MAX(updated_at) FROM db_config
WHERE group = 'website';
```

--------------------------------

### Get Group Last Updated Timestamp

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-facades.md

Signature and usage for retrieving the last update time of a configuration group.

```php
DbConfig::getGroupLastUpdatedAt(
    string $group,
    string $format = 'F j, Y, g:i a',
    string $timezone = 'UTC'
): ?string
```

```php
$updated = DbConfig::getGroupLastUpdatedAt('website', 'Y-m-d', 'America/New_York');
```

--------------------------------

### Publish Configuration File

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/configuration.md

Command to publish the package configuration file to the application's config directory.

```bash
php artisan vendor:publish --tag="db-config-config"
```

--------------------------------

### Provide Default Data

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-command.md

Sets the initial values for the configuration form.

```php
public function getDefaultData(): array
{
    return [
        'site_name' => 'My Site',
        'maintenance_mode' => false,
    ];
}
```

--------------------------------

### Create Plugin Instance

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/service-provider.md

Static factory method for creating plugin instances, typically used in panel configuration.

```php
public static function make(): static
{
    return app(static::class);
}
```

```php
// In panel configuration
use Inerba\DbConfig\DbConfigPlugin;

public function getPlugins(): array
{
    return [
        DbConfigPlugin::make(),
    ];
}
```

--------------------------------

### Create a Settings Widget

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/index.md

Define a custom settings widget by extending AbstractWidgetSettings.

```php
<?php

namespace App\Filament\Resources\Post\Widgets;

use Filament\Schemas\Schema;
use Inerba\DbConfig\AbstractWidgetSettings;

class BlogSettings extends AbstractWidgetSettings
{
    protected function settingName(): string
    {
        return 'blog-settings';
    }

    public function form(Schema $schema): Schema
    {
        return $schema->components([
            // Components here
        ])->statePath('data');
    }
}
```

--------------------------------

### Publish Assets

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/index.md

Publish the package migrations.

```bash
php artisan vendor:publish --tag="db-config-migrations"
```

--------------------------------

### View and Translation Publishing Paths

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/service-provider.md

Displays the directory paths where views and translations are automatically published upon package boot.

```bash
# Views published to: resources/views/vendor/db-config/
# Translations published to: resources/lang/vendor/db-config/
```

--------------------------------

### Demonstrate getDefaultData() merge behavior

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-abstractpagesettings.md

Illustrates how database values override default values during the merge process.

```php
// In getDefaultData():
return [
    'theme' => 'light',
    'notifications' => ['email' => true, 'sms' => false],
];

// In database (from a previous save):
// group='website', settings={ "theme": "dark" }

// Result in $data:
[
    'theme' => 'dark',  // Database wins
    'notifications' => ['email' => true, 'sms' => false], // Defaults persist
]
```

--------------------------------

### Defining BackedEnum for Navigation Icons

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/types.md

Illustrates using either a string or a BackedEnum for navigation icon configuration.

```php
string | BackedEnum | null
```

```php
// Using a string
protected static string | BackedEnum | null $navigationIcon = 'heroicon-o-globe-alt';

// Using a BackedEnum (custom icons)
enum Icons: string {
    case Settings = 'heroicon-o-wrench-screwdriver';
    case Website = 'heroicon-o-globe-alt';
}

protected static string | BackedEnum | null $navigationIcon = Icons::Settings;
```

--------------------------------

### mount()

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-abstractwidgetsettings.md

Lifecycle method called when the widget is loaded to initialize form data from the database.

```APIDOC
## mount()

### Description
Lifecycle method called when the widget is loaded. It merges default values with database settings and populates the form.

### Signature
`public function mount(): void`

### Behavior
1. Calls `DbConfig::getGroup($this->settingName())`
2. Calls `$this->getDefaultData()`
3. Merges defaults with database values via `array_replace_recursive()`
4. Assigns result to `$this->data`
5. Calls `$this->form->fill($this->data)` to populate the form
```

--------------------------------

### Complete Configuration File

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/configuration.md

The primary configuration file for defining the database table name and cache settings.

```php
<?php

// config for Inerba/DbConfig
return [

    /*
    |--------------------------------------------------------------------------
    | Table Name
    |--------------------------------------------------------------------------
    |
    | The name of the database table used to store the settings.
    |
    */
    'table_name' => 'db_config',

    /*
    |--------------------------------------------------------------------------
    | Cache Configuration
    |--------------------------------------------------------------------------
    |
    | Configure the cache behavior for the package. You can set a custom
    | prefix for all cache keys and define a Time To Live (TTL) in minutes.
    |
    | Setting 'ttl' to null or 0 will cache the settings forever.
    |
    */
    'cache' => [
        'prefix' => 'db-config',
        'ttl' => null, // Cache forever by default
    ],

];
```

--------------------------------

### Handling Errors in Service Providers

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/errors.md

Pattern for safely loading configuration values during the application boot process.

```php
use Inerba\DbConfig\DbConfig;

public function boot()
{
    try {
        config(['app.debug' => DbConfig::get('app.debug', true)]);
    } catch (\Exception $e) {
        // Database might not be ready yet; silently fall back
        config(['app.debug' => true]);
    }
}
```

--------------------------------

### Registering the Command in Service Provider

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-command.md

The command is registered within the package's service provider using the configurePackage method.

```php
// src/DbConfigServiceProvider.php
public function configurePackage(Package $package): void
{
    $package->hasCommands($this->getCommands());
}

protected function getCommands(): array
{
    return [
        DbConfigCommand::class,
    ];
}
```

--------------------------------

### Scaffold DB Config Page

Source: https://github.com/inerba/filament-db-config/blob/main/resources/boost/skills/filament-db-config/SKILL.md

Use this command to scaffold a new settings page. Always pass only the Name argument. The command automatically adds the 'Settings' suffix.

```bash
php artisan make:db-config HomeSeo --no-interaction
```

--------------------------------

### Generate Settings Page

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/index.md

Scaffold a new settings page using the artisan command.

```bash
php artisan make:db-config website
```

--------------------------------

### Import AbstractPageSettings

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-abstractpagesettings.md

Required namespace import for extending the base settings page class.

```php
use Inerba\DbConfig\AbstractPageSettings;
```

--------------------------------

### Create Migration Table

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/database-schema.md

Full migration schema definition for the configuration table.

```php
<?php

use IlluminateDatabase\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    public function up()
    {
        $tableName = config('db-config.table_name', 'db_config');

        Schema::create($tableName, function (Blueprint $table) {
            $table->id();

            $table->string('group');

            $table->string('key');

            $table->json('settings')->nullable();

            $table->unique(['group', 'key']);

            $table->timestamps();
        });
    }
};
```

--------------------------------

### Project File Structure

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/MANIFEST.md

Displays the directory layout of the documentation workspace.

```text
/workspace/home/output/
├── README.md                              [This guide]
├── MANIFEST.md                            [This file]
├── index.md                               [Master navigation hub]
├── api-reference-dbconfig.md              [DbConfig class]
├── api-reference-helpers.md               [Global helper functions]
├── api-reference-abstractpagesettings.md  [Page class]
├── api-reference-abstractwidgetsettings.md [Widget class]
├── api-reference-facades.md               [Facade reference]
├── api-reference-command.md               [Artisan command]
├── configuration.md                       [Config options]
├── database-schema.md                     [Table schema]
├── service-provider.md                    [Provider & plugin]
├── types.md                               [Type definitions]
└── errors.md                              [Error handling]
```

--------------------------------

### Configure Production Cache Strategy

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/configuration.md

Set a cache prefix and TTL to reduce database load in production environments.

```php
// config/db-config.php
return [
    'table_name' => 'db_config',

    'cache' => [
        'prefix' => 'prod-config',
        'ttl' => 60, // Refresh every hour
    ],
];
```

--------------------------------

### Global Helper Usage

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-helpers.md

Demonstrates usage of global helper functions and the Blade directive without explicit imports.

```php
// No import needed - automatically registered
$value = db_config('group.key');
$safeValue = safe_db_config('group.key');

// Blade directive
@db_config('group.key')
```

--------------------------------

### Package Registration Method

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/service-provider.md

Empty lifecycle method called during the container binding phase.

```php
public function packageRegistered(): void {}
```

--------------------------------

### Read configuration safely

Source: https://github.com/inerba/filament-db-config/blob/main/README.md

Use this helper to prevent application crashes during database unavailability by catching exceptions and returning a default value.

```php
safe_db_config('website.site_name', 'Default Name');
```

--------------------------------

### Accessing Configuration Values

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/configuration.md

Retrieve configuration settings using the config helper, optionally providing default values.

```php
// Get the configured table name
$tableName = config('db-config.table_name');

// Get the configured cache prefix
$prefix = config('db-config.cache.prefix');

// Get the configured TTL
$ttl = config('db-config.cache.ttl');

// With defaults
$table = config('db-config.table_name', 'db_config');
$prefix = config('db-config.cache.prefix', 'db-config');
$ttl = config('db-config.cache.ttl', null);
```

--------------------------------

### Generate settings page

Source: https://github.com/inerba/filament-db-config/blob/main/README.md

Creates a new Filament settings page using the artisan command.

```bash
php artisan make:db-config Website
```

--------------------------------

### Implement settingName() in PHP

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-abstractwidgetsettings.md

Define the configuration group name for a settings widget by extending the abstract method.

```php
abstract protected function settingName(): string
```

```php
class BlogSettings extends AbstractWidgetSettings
{
    protected function settingName(): string
    {
        return 'blog-settings';
    }
}
```

--------------------------------

### Customize UI Properties

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-command.md

Configures the page title, navigation icon, and URL slug.

```php
protected static ?string $title = 'Website Configuration';
protected static string | BackedEnum | null $navigationIcon = 'heroicon-o-globe-alt';
protected static ?string $slug = 'website-config';
```

--------------------------------

### Define Asset Package Name

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/service-provider.md

Returns the npm package name for asset discovery by Spatie's package tools.

```php
protected function getAssetPackageName(): ?string
{
    return 'inerba/db-config';
}
```

--------------------------------

### Wrap manual DbConfig calls in try-catch blocks

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/errors.md

Implement robust error handling for manual configuration updates to catch RuntimeExceptions and general database errors.

```php
use Inerba\DbConfig\DbConfig;

try {
    DbConfig::set('group.key', $value);
} catch (\RuntimeException $e) {
    \Log::error('Failed to save config: ' . $e->getMessage());
    throw $e; // or handle gracefully
} catch (\Exception $e) {
    \Log::error('Database error: ' . $e->getMessage());
}
```

--------------------------------

### Application Testing

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/index.md

Verify that settings are correctly persisted and retrieved using the DbConfig facade.

```php
use Inerba\DbConfig\DbConfig;

test('settings are persisted', function () {
    DbConfig::set('website.site_name', 'Test Site');
    
    expect(DbConfig::get('website.site_name'))
        ->toBe('Test Site');
});
```

--------------------------------

### Configure cache settings

Source: https://github.com/inerba/filament-db-config/blob/main/README.md

Defines cache prefix and TTL for settings.

```php
'cache' => [
    'prefix' => 'my-app-settings',
    'ttl' => 60, // Cache for 1 hour
],
```

--------------------------------

### Implement a Settings Page

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-abstractpagesettings.md

Extends AbstractPageSettings to define a custom settings page with a schema and default data.

```php
<?php

namespace App\Filament\Admin\Pages;

use Filament\Schemas\Components;
use Filament\Schemas\Schema;
use Inerba\DbConfig\AbstractPageSettings;

class WebsiteSettings extends AbstractPageSettings
{
    protected static ?string $title = 'Website Settings';
    
    protected static ?string $navigationIcon = 'heroicon-o-globe-alt';

    protected function settingName(): string
    {
        return 'website';
    }

    public function getDefaultData(): array
    {
        return [
            'site_name' => 'My Site',
            'site_tagline' => 'A great site',
            'maintenance_mode' => false,
        ];
    }

    public function form(Schema $schema): Schema
    {
        return $schema
            ->components([
                Components\TextInput::make('site_name')
                    ->required()
                    ->label('Site Name'),
                Components\TextInput::make('site_tagline')
                    ->label('Site Tagline'),
                Components\Toggle::make('maintenance_mode')
                    ->label('Maintenance Mode'),
            ])
            ->statePath('data');
    }

    public static function getNavigationGroup(): ?string
    {
        return 'Site Configuration';
    }
}
```

--------------------------------

### Running Tests

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/index.md

Execute the package test suite using the Pest test runner.

```bash
./vendor/bin/pest
```

--------------------------------

### Fetch a specific configuration value

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/database-schema.md

Retrieves the settings column for a specific group and key combination.

```sql
SELECT settings FROM db_config
WHERE group = 'website' AND key = 'site_name';
```

--------------------------------

### Environment-Specific Configuration

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/configuration.md

Use environment variables to override default configuration settings.

```php
// config/db-config.php
return [
    'table_name' => env('DB_CONFIG_TABLE', 'db_config'),

    'cache' => [
        'prefix' => env('DB_CONFIG_PREFIX', 'db-config'),
        'ttl' => env('DB_CONFIG_TTL', null),
    ],
];
```

```bash
DB_CONFIG_TABLE=app_settings
DB_CONFIG_PREFIX=my-app-config
DB_CONFIG_TTL=60
```

--------------------------------

### Catching Configuration Exceptions

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/errors.md

Standard try-catch block for handling cache or database errors during configuration retrieval.

```php
use Inerba\DbConfig\DbConfig;

try {
    $value = DbConfig::get('group.key', 'default');
} catch (\Exception $e) {
    \Log::error('Cache or database error: ' . $e->getMessage());
    $value = 'default';
}
```

--------------------------------

### Read configuration values

Source: https://github.com/inerba/filament-db-config/blob/main/README.md

Use the helper function or class method to retrieve configuration values with an optional default.

```php
db_config('website.site_name', 'Default Name');
```

```php
\Inerba\DbConfig\DbConfig::get('website.site_name', 'Default Name');
```

--------------------------------

### Run Command with Arguments

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-command.md

Provides arguments directly to the command to bypass interactive prompts.

```bash
php artisan make:db-config website admin
```

```bash
php artisan make:db-config blog
```

--------------------------------

### Generated File Path Structure

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-command.md

The default directory structure for generated configuration pages.

```text
app/Filament/{Panel}/Pages/{ClassName}Settings.php
```

--------------------------------

### Retrieve Configuration Value

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-facades.md

Signature and usage for fetching a configuration value from the database.

```php
DbConfig::get(string $key, mixed $default = null): mixed
```

```php
$siteName = DbConfig::get('website.site_name', 'My Site');
```

--------------------------------

### DbConfig::get(string $key, mixed $default)

Source: https://github.com/inerba/filament-db-config/blob/main/README.md

Static method to retrieve a configuration value.

```APIDOC
## \Inerba\DbConfig\DbConfig::get(string $key, mixed $default)

### Description
Static access to retrieve a configuration value from the database.

### Parameters
- **key** (string) - Required - The configuration key.
- **default** (mixed) - Optional - The value to return if not found.

### Example
```php
\Inerba\DbConfig\DbConfig::get('website.site_name', 'Default Name');
```
```

--------------------------------

### Global Helper Functions

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-helpers.md

Globally available PHP helper functions for retrieving configuration values in application code.

```APIDOC
## db_config($key, $default = null)

### Description
Retrieves a configuration value from the database. Throws exceptions if the retrieval fails.

## safe_db_config($key, $default = null)

### Description
Retrieves a configuration value from the database with built-in exception handling for safer access.
```

--------------------------------

### Fetch all values in a group

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/database-schema.md

Retrieves all key-value pairs associated with a specific configuration group.

```sql
SELECT key, settings FROM db_config
WHERE group = 'website';
```

--------------------------------

### Read configuration groups

Source: https://github.com/inerba/filament-db-config/blob/main/README.md

Retrieve all settings within a specific group as an associative array.

```php
\Inerba\DbConfig\DbConfig::getGroup('website');
// => [ 'site_name' => 'Acme Inc.', 'contact' => ['email' => 'info@acme.test'] ]
```

--------------------------------

### Fetch configuration from database

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-dbconfig.md

Retrieves and decodes a JSON configuration value from the database.

```php
protected static function fetchConfig(string $group, string $setting): array
```

--------------------------------

### DbConfig::get() Method Signature

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/types.md

Retrieves a configuration value using dotted notation.

```php
public static function get(string $key, mixed $default = null): mixed
```

--------------------------------

### Handling Timestamps with Carbon

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/types.md

Shows how to parse database timestamp strings into Carbon instances for formatting.

```php
use Carbon\Carbon;

$timestamp = DB::table('db_config')->max('updated_at');
// Returns: '2024-09-03 14:30:00' (string) or Carbon instance

$carbon = Carbon::parse($timestamp);
$formatted = $carbon->translatedFormat('F j, Y, g:i a');
```

--------------------------------

### Define Package Name

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/service-provider.md

Sets the package's short name identifier used for cache keys, translations, and configuration.

```php
public static string $name = 'db-config';
```

--------------------------------

### Implementing Graceful Error Handling

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/errors.md

Methods for handling configuration retrieval errors using the safe helper or manual try-catch blocks.

```php
// Safe version: returns default on any error
$value = safe_db_config('group.key', 'default');

// Manual try-catch
try {
    $value = db_config('group.key');
} catch (\Exception $e) {
    \Log::error('Config fetch failed: ' . $e->getMessage());
    $value = 'default';
}
```

--------------------------------

### Import DbConfig Class

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-dbconfig.md

Include this statement to access the DbConfig class in your PHP files.

```php
use Inerba\DbConfig\DbConfig;
```

--------------------------------

### DbConfig::get()

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-facades.md

Retrieve a configuration value from the database.

```APIDOC
## DbConfig::get()

### Description
Retrieve a configuration value from the database.

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

### Parameters
- **$key** (string) - Required - The configuration key to retrieve.
- **$default** (mixed) - Optional - The default value to return if the key is not found.

### Example
```php
$siteName = DbConfig::get('website.site_name', 'My Site');
```
```

--------------------------------

### Define db_config helper

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-helpers.md

The function signature for retrieving configuration values from the database.

```php
function db_config(string $key, mixed $default = null): mixed
```

--------------------------------

### Configure Development Cache Strategy

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/configuration.md

Disable caching by setting TTL to zero to ensure immediate reflection of configuration changes.

```php
// config/db-config.php (or .env override)
return [
    'table_name' => 'db_config',

    'cache' => [
        'prefix' => 'db-config',
        'ttl' => 0, // No caching in development
    ],
];
```

--------------------------------

### Manage nested configuration values

Source: https://github.com/inerba/filament-db-config/blob/main/README.md

Store and retrieve complex structures using dot notation for nested keys.

```php
// Store a nested structure
\Inerba\DbConfig\DbConfig::set('profile.preferences', [
    'theme' => 'dark',
    'notifications' => ['email' => true, 'sms' => false],
]);

// Read a nested value with default
db_config('profile.preferences.theme', 'light'); // 'dark'

// Read a missing nested value
db_config('profile.preferences.timezone', 'UTC'); // 'UTC'
```

--------------------------------

### Using DbConfig in Tests

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-facades.md

Set and verify configuration values within Pest or PHPUnit test cases.

```php
<?php

use Inerba\DbConfig\Facades\DbConfig;

test('website settings are applied', function () {
    DbConfig::set('website.site_name', 'Test Site');
    
    $response = $this->get('/');
    $response->assertSee('Test Site');
});
```

--------------------------------

### Command Description

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-command.md

Sets the description for the artisan command.

```php
public $description = 'Create a new Filament settings Page class';
```

--------------------------------

### Package File Structure

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/index.md

The directory layout of the package, including core classes, Filament integration components, and configuration files.

```text
src/
├── DbConfig.php                 # Core API class
├── DbConfigPlugin.php           # Filament plugin
├── DbConfigServiceProvider.php  # Service provider
├── DbConfigTrait.php            # Shared page/widget logic
├── AbstractPageSettings.php     # Page base class
├── AbstractWidgetSettings.php   # Widget base class
├── Commands/
│   └── DbConfigCommand.php      # make:db-config command
├── Facades/
│   └── DbConfig.php             # Facade for DbConfig
├── Testing/
│   └── TestsDbConfig.php        # Testing utilities
└── helpers.php                  # Global helper functions

config/
└── db-config.php               # Configuration file

database/
└── migrations/
    └── create_db_config_table.php.stub  # Migration

stubs/
└── page.stub                   # Page generation template
```

--------------------------------

### Define Widget Form Schema

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-abstractwidgetsettings.md

Implement the form method to define widget settings fields, ensuring the statePath is set to 'data'.

```php
class BlogSettings extends AbstractWidgetSettings
{
    public function form(Schema $schema): Schema
    {
        return $schema
            ->components([
                TextInput::make('posts_per_page'),
                Toggle::make('show_comments'),
            ])
            ->statePath('data');
    }
}
```

--------------------------------

### Register Migrations

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/service-provider.md

Returns an array of migration names to be registered for the package.

```php
protected function getMigrations(): array
{
    return [
        'create_db_config_table',
    ];
}
```

--------------------------------

### Catch RuntimeException during config storage

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/errors.md

Use this pattern to catch serialization errors when setting configuration values.

```php
use Inerba\DbConfig\DbConfig;

try {
    DbConfig::set('group.key', $problematicValue);
} catch (\RuntimeException $e) {
    \Log::error('Failed to save config: ' . $e->getMessage());
    // Handle the error: notify user, revert to previous value, etc.
}
```

--------------------------------

### Read DB Config Values

Source: https://github.com/inerba/filament-db-config/blob/main/resources/boost/skills/filament-db-config/SKILL.md

Access configuration values using the `db_config()` helper for standard access or `safe_db_config()` for early boot scenarios. Never use the standard `config()` helper.

```php
// Standard helper
$siteName = db_config('website.site_name', 'Default');

// Safe helper (for early boot, migrations, service providers)
$siteName = safe_db_config('website.site_name', 'Default');
```

--------------------------------

### Write configuration values

Source: https://github.com/inerba/filament-db-config/blob/main/README.md

Update a configuration value in the database.

```php
\Inerba\DbConfig\DbConfig::set('website.site_name', 'Acme Inc.');
```

--------------------------------

### Run Interactive Command

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-command.md

Executes the command in interactive mode to prompt for settings page name and panel selection.

```bash
php artisan make:db-config
```

--------------------------------

### Handle Database Errors Gracefully

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/index.md

Use the safe helper to return a default value if the database connection fails.

```php
$value = safe_db_config('group.key', 'default');
// Returns default if database is unavailable
```

--------------------------------

### Class Property Definitions

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-abstractpagesettings.md

Standard property definitions for data storage, view templates, and navigation icons.

```php
public ?array $data = [];
```

```php
protected string $view = 'db-config::filament.pages.default';
```

```php
protected static string | BackedEnum | null $navigationIcon = 'heroicon-o-wrench-screwdriver';
```

--------------------------------

### db_config(string $key, mixed $default)

Source: https://github.com/inerba/filament-db-config/blob/main/README.md

Helper function to retrieve a configuration value from the database.

```APIDOC
## db_config(string $key, mixed $default)

### Description
Retrieves a configuration value by its key. Supports dot notation for nested values.

### Parameters
- **key** (string) - Required - The configuration key in 'group.setting' format.
- **default** (mixed) - Optional - The value to return if the key is not found.

### Example
```php
db_config('website.site_name', 'Default Name');
```
```

--------------------------------

### Detect Available Panels

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/api-reference-command.md

Retrieves all registered Filament panels.

```php
$availablePanels = Filament::getPanels();
```

--------------------------------

### AbstractPageSettings::getDefaultData() Method Signature

Source: https://github.com/inerba/filament-db-config/blob/main/_autodocs/types.md

Returns the default key-value pairs for page settings.

```php
public function getDefaultData(): array
```
Tokens:
Raw