Home

InitPHP Config — Wiki

Welcome to the official documentation for initphp/config — an advanced configuration manager that gives PHP applications a single, uniform API over configuration loaded from arrays, PHP files, whole directories, and class/object properties, with dotted-path access and case-insensitive keys.

It is built on top of initphp/parameterbag, which provides the underlying nested store.

The package ships three entry points that all share the same read/write contract:

Type	Purpose
Classes	Turn a class's own properties into configuration.
Library	An injectable object with the full loader API.
Config	A static facade over a shared Library singleton.

All three implement ConfigInterface, so get / set / has / remove / all behave identically wherever you use them.

composer require initphp/config

use InitPHP\Config\Config;

Config::setArray('app', [
    'name' => 'demo',
    'db'   => ['host' => 'localhost', 'user' => 'root'],
]);

Config::get('app.name');               // 'demo'
Config::get('app.db.host');            // 'localhost'
Config::get('app.db.charset', 'utf8'); // 'utf8' (default — key absent)
Config::get('APP.DB.HOST');            // 'localhost' (case-insensitive)

Start here

• New to the package? Read Installation, then Quick Start.
• Defining config as code? See Configuration Classes.
• Loading from files/dirs? See Loaders and the Environment-Aware Config recipe.
• Want global access? Read The Config Facade.
• Curious how keys are parsed? Read Keys & Dotted Paths.
• Upgrading from v1? Read the Migration Guide.
• Looking for a specific method? The full API Reference lists every class member.

At a glance — entry-point matrix

Capability	Classes	Library	Config
get / set / has / remove / all	✅	✅	✅
Dotted-path keys (db.host)	✅	✅	✅
Case-insensitive keys	✅	✅	✅
Initial data source	subclass properties	constructor / loaders	loaders
Load array — setArray()	❌	✅	✅
Load PHP file — setFile()	❌	✅	✅
Load directory — setDir()	❌	✅	✅
Load class/object — setClass()	❌	✅	✅
Replace whole tree — replace()	❌	✅	✅
Object-style access ($cfg->db->host)	❌	✅	❌
Lifetime	per instance	per instance	process-wide singleton

Package metadata

• License: MIT
• Minimum PHP: 8.1 (tested on 8.1 – 8.4)
• Runtime dependencies: initphp/parameterbag ^2.0
• Packagist: initphp/config
• Source: github.com/InitPHP/Config
• Issues: github.com/InitPHP/Config/issues
• Discussions: github.com/orgs/InitPHP/discussions
• Security: SECURITY.md

If something in this wiki is unclear, ambiguous, or wrong, please open an issue — documentation fixes are reviewed eagerly.