README

This is a basic and minimalist implementation of PSR-11 for config management and dependency injection.

Features

• PSR-11 Compatible: Implements PSR-11 Container Interface for standardized dependency injection
• Auto-Initialization: Automatically loads configuration from a bootstrap file with zero setup
• Static Facade: Clean, Laravel-style static API for accessing configuration anywhere
• Environment-Based Configuration: Easily switch between development, production, and custom environments
• Multiple Configuration Formats: Support for both PHP arrays and .env files
• Dependency Injection: Simple API for defining and resolving dependencies
• Type Conversion: Built-in parsers for converting configuration values to specific types
• Caching Support: Optional caching of configuration values for improved performance
• Environment Inheritance: Environments can inherit from one another to reduce configuration duplication
• Abstract & Final Environments: Design flexible environment hierarchies with constraints
• Performance Optimizations: Configure caching modes for different use cases

Quick Start with Auto-Initialization

The fastest way to get started is using the auto-initialization feature:

<?php
// 1. Create config/ConfigBootstrap.php
use ByJG\Config\ConfigInitializeInterface;
use ByJG\Config\Definition;
use ByJG\Config\Environment;

return new class implements ConfigInitializeInterface {
    public function loadDefinition(?string $env = null): Definition {
        $dev = new Environment('dev');
        $prod = new Environment('prod', [$dev]);

        return (new Definition())
            ->addEnvironment($dev)
            ->addEnvironment($prod);
    }
};

<?php
// 2. Create your config file (config/config-dev.php)
return [
    'database' => [
        'host' => 'localhost',
        'port' => 3306
    ],
    'app_name' => 'My Application',
    'debug' => true
];

<?php
// 3. Use Config anywhere in your app - no initialization needed!
use ByJG\Config\Config;

$appName = Config::get('app_name'); // "My Application"
$dbHost = Config::get('database')['host']; // "localhost"

Traditional Example

You can also use the traditional approach without auto-initialization:

<?php
// 1. Create a config file (config/config-dev.php)
return [
    'database' => [
        'host' => 'localhost',
        'port' => 3306
    ],
    'app_name' => 'My Application',
    'debug' => true
];

// 2. Set up and load the configuration
use ByJG\Config\Definition;
use ByJG\Config\Environment;

// Define the environments
$dev = new Environment('dev');
$prod = new Environment('prod', [$dev]); // prod inherits from dev

// Create and build the definition
$definition = (new Definition())
    ->addEnvironment($dev)
    ->addEnvironment($prod);

// Build with the current environment (using APP_ENV environment variable)
$container = $definition->build();

// 3. Use the configuration values
$appName = $container->get('app_name'); // "My Application"
$dbHost = $container->get('database')['host']; // "localhost"

Dependency Injection Example

<?php
// 1. Define your classes
namespace MyApp;

class DatabaseService 
{
    private $host;
    private $port;
    
    public function __construct($host, $port) 
    {
        $this->host = $host;
        $this->port = $port;
    }
}

class UserRepository 
{
    private $db;
    
    public function __construct(DatabaseService $db) 
    {
        $this->db = $db;
    }
}

// 2. Register them in your config file
use ByJG\Config\DependencyInjection as DI;
use ByJG\Config\Param;

return [
    'database' => [
        'host' => 'localhost',
        'port' => 3306
    ],
    
    // Register the database service
    \MyApp\DatabaseService::class => DI::bind(\MyApp\DatabaseService::class)
        ->withConstructorArgs([
            Param::get('database')['host'],
            Param::get('database')['port']
        ])
        ->toSingleton(),
    
    // Register the repository with auto-injection
    \MyApp\UserRepository::class => DI::bind(\MyApp\UserRepository::class)
        ->withInjectedConstructor()
        ->toInstance(),

    // For mixed injection (auto-inject classes, manually provide scalars)
    \MyApp\UserService::class => DI::bind(\MyApp\UserService::class)
        ->withInjectedConstructorOverrides([
            'apiKey' => 'my-secret-key'  // Manually provide scalar values
        ])
        ->toInstance()
];

// 3. Use the services from the container
$userRepo = $container->get(\MyApp\UserRepository::class);

Documentation Index

Start with the fundamentals and move toward the advanced features following this order:

• Set up the configuration files – Define environments, file naming, and directory structure;
• Load the configuration – Build Definition instances and work with the PSR-11 container;
• Using the Config Facade – Access container values through the static API;
• Auto-Initialization – Let Config bootstrap itself from config/ConfigBootstrap.php;
• Define dependency injection – Bind services, constructor parameters, and factories;
• Work with special types – Parse .env values through built-in or custom parsers;
• Configure your webserver – Expose environment variables in different runtimes;
• Follow good practices – Apply conventions that keep configuration manageable;
• Explore advanced features – Use caching, inheritance constraints, and container helpers;

Installation

composer require "byjg/config"

Tests

./vendor/bin/phpunit

Dependencies

flowchart TD
    byjg/config --> byjg/cache-engine

Open source ByJG