Config Laravel Package

Technical Evaluation

Architecture Fit

The symfony/config package is a highly modular, battle-tested solution for managing configuration in PHP/Laravel applications. It aligns well with Laravel’s dependency injection (DI) and service container architecture, particularly in scenarios where:

• Multi-source configuration is required (YAML, XML, INI, env vars, databases, etc.).
• Validation and normalization of configuration values are critical (e.g., API keys, feature flags, nested structures).
• Dynamic configuration (e.g., environment-specific overrides, runtime adjustments) is needed.
• Complex schemas (e.g., nested arrays, enums, custom types) must be enforced.

Key Laravel Synergies:

• Service Provider Integration: Can be seamlessly integrated into Laravel’s ServiceProvider bootstrapping (e.g., register() for config loading, boot() for validation).
• Environment Variables: Native support for .env placeholders (e.g., %env(APP_KEY)%) via ParameterBag or Dotenv.
• Caching: Compatible with Laravel’s cache layer (e.g., ConfigCache for compiled configs).
• Validation: Works alongside Laravel’s Validator or Pintle for runtime checks.

Anti-Patterns to Avoid:

• Overusing symfony/config for simple key-value pairs (Laravel’s native config() helper may suffice).
• Mixing fluent PHP config (deprecated in Symfony 8+) with Laravel’s config.php or config/services.php.

Integration Feasibility

Critical Dependencies:

• symfony/dependency-injection (for DI integration).
• symfony/yaml (if using YAML configs).
• symfony/filesystem (for file-based resources).

Technical Risk

Key Questions for the Team:

1. Do we need multi-source configuration (e.g., DB + YAML + env vars)? If not, Laravel’s native config may suffice.
2. Will this replace or augment existing config validation? (e.g., API contracts, feature flags).
3. How will we handle runtime configuration updates? (e.g., cache invalidation, hot-reloading).
4. What’s the PHP version baseline? (Symfony 8 requires PHP 8.4; Laravel 10+ supports this).
5. Do we have existing tools for config validation? (e.g., JSON Schema, custom validators) that could conflict?
6. How will this integrate with Laravel’s config/cache? (Avoid duplicate caching layers.)
7. What’s the rollout plan? (Canary release, feature flags, or big-bang migration?)

Integration Approach

Stack Fit

Recommended Stack:

• PHP 8.4+ (for Symfony 8 compatibility).
• Laravel 10+ (native PHP 8.4 support).
• Symfony Components:
  • symfony/config (core).
  • symfony/dependency-injection (DI integration).
  • symfony/yaml (if using YAML).
  • symfony/cache (for ConfigCache).
• Optional:
  • symfony/var-dumper (for debugging Node structures).
  • symfony/options-resolver (for simpler validation).

Migration Path

Phase 1: Validation-Only Adoption (Low Risk)

1. Add symfony/config as a dev dependency:

   composer require symfony/config --dev
   

2. Create a ConfigValidator service to validate existing config/ files:

   use Symfony\Component\Config\Definition\ConfigurationInterface;
   use Symfony\Component\Config\Definition\Builder\TreeBuilder;
   
   class AppConfigValidator implements ConfigurationInterface
   {
       public function getConfigTreeBuilder(): TreeBuilder
       {
           $tree = new TreeBuilder('app');
           $root = $tree->getRootNode();
           $root
               ->children()
                   ->scalarNode('timezone')->defaultValue('UTC')->end()
                   ->arrayNode('cache')
                       ->addDefaultsIfNotSet()
                       ->children()
                           ->scalarNode('default')->defaultValue('array')->end()
                       ->end()
                   ->end();
           return $tree;
       }
   }
   

3. Integrate with Laravel’s boot():

   public function boot(): void
   {
       $validator = new AppConfigValidator();
       $config = $this->app['config'];
       $normalized = $validator->getConfigTreeBuilder()->buildTree()->normalize($config->all());
       // Merge back or validate against normalized structure.
   }
   

Phase 2: Partial Replacement (Medium Risk)

1. Replace config/app.php with a TreeBuilder:
   • Define schema in config/Tree/app.php.
   • Load via a custom ConfigLoader service.
2. **Update config/cache to use symfony/config's ConfigCache.
3. Add runtime config sources (e.g., DB, API):

   $loader = new DatabaseConfigLoader($pdo);
   $config = $loader->load('feature_flags');
   

Phase 3: Full Migration (High Risk)

1. Replace all config/ files with TreeBuilder definitions.
2. Deprecate Laravel’s config() helper in favor of a custom facade:

   $this->app->singleton('config', fn() => new SymfonyConfigLoader());
   

3. Update tests to mock ResourceLoader and NodeValidator.

Compatibility