Getting Started

Install the package

Install via Composer — that's all you need.

composer require hpwebdeveloper/laravel-env-settings

Publish the config file

This creates config/env-settings.php where you register your settings classes and configure the environment map.

php artisan vendor:publish --tag="env-settings-config"

Generate a settings class

Use the artisan command to scaffold a new settings class with typed properties. Each class defines what the values should be in each environment.

php artisan env-settings:make AiSettings \
  --properties="provider:string,text_model:string,max_tokens:int,temperature:float"

Settings class created: app/Settings/AiSettings.php
  → Registered \App\Settings\AiSettings::class in config/env-settings.php

This creates app/Settings/AiSettings.php:

class AiSettings extends EnvironmentSettings
{
    public function __construct(
        public string $provider,
        public string $text_model,
        public int $max_tokens,
        public float $temperature,
    ) {}

    public static function development(): static
    {
        return new static(
            provider: 'ollama',        // free, local
            text_model: 'llama3.2',
            max_tokens: 1000,
            temperature: 0.9,
        );
    }

    public static function production(): static
    {
        return new static(
            provider: 'openai',       // paid, best quality
            text_model: 'gpt-4o',
            max_tokens: 8000,
            temperature: 0.2,
        );
    }
}

Register the settings class

A settings class stays inert until it is listed in the register array of config/env-settings.php — so env-settings:make appends that line for you. If it can't, because the config isn't published or has no register array, it says so and tells you what to add. Everything listed here is resolved once and bound as a singleton.

// config/env-settings.php
'register' => [
    \App\Settings\AiSettings::class,
],

Use it anywhere in your app

Access your settings via the global helper, the container, or type-hinted dependency injection — all three resolve the same singleton instance.

// Option A: Global helper (works everywhere)
$provider = envSettings(AiSettings::class)->provider;

// Option B: Container resolution
$ai = app(AiSettings::class);
$ai->text_model;  // 'gpt-4o' in production, 'llama3.2' in development

// Option C: Type-hinted injection (recommended in controllers/services)
public function __invoke(AiSettings $ai): View
{
    return view('dashboard', ['model' => $ai->text_model]);
}

Inspect with artisan commands

View the resolved values for the current environment or compare two environments side by side.

# Show resolved values for the current environment
php artisan env-settings:show "App\Settings\AiSettings"

# Show all registered settings classes
php artisan env-settings:show

# Compare development vs production
php artisan env-settings:diff "App\Settings\AiSettings" development production