PHPackages ghostwriter/config - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. ghostwriter/config ActiveLibrary[Utility & Helpers](/categories/utility) ghostwriter/config ================== Provides an object that maps configuration keys to values. 2.0.2(5mo ago)04.1M—4.1%12BSD-4-ClausePHPPHP ~8.4.0 || ~8.5.0 Since Jan 2Pushed 1mo ago1 watchersCompare [ Source](https://github.com/ghostwriter/config)[ Packagist](https://packagist.org/packages/ghostwriter/config)[ Docs](https://github.com/ghostwriter/config)[ GitHub Sponsors](https://github.com/sponsors/ghostwriter)[ RSS](/packages/ghostwriter-config/feed)WikiDiscussions 2.0.x Synced 1mo ago READMEChangelog (9)Dependencies (5)Versions (21)Used By (12) Config ====== [](#config) [![GitHub Sponsors](https://camo.githubusercontent.com/772d7f4f0f2d5c2f18f3e0f79ad866b148c0b7f8621039d628224c7d3254299e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73706f6e736f72732f67686f73747772697465723f6c6162656c3d53706f6e736f722b4067686f73747772697465722f636f6e666967266c6f676f3d4769744875622b53706f6e736f7273)](https://github.com/sponsors/ghostwriter)[![Automation](https://github.com/ghostwriter/config/actions/workflows/automation.yml/badge.svg)](https://github.com/ghostwriter/config/actions/workflows/automation.yml)[![Supported PHP Version](https://camo.githubusercontent.com/ebd5dc5163388a8652f0d8badb6f0df1ebfbe9ccc8d9417ae8338be519ee0b05/68747470733a2f2f62616467656e2e6e65742f7061636b61676973742f7068702f67686f73747772697465722f636f6e6669673f636f6c6f723d383839326266)](https://www.php.net/supported-versions)[![Downloads](https://camo.githubusercontent.com/037e94f19c82a986f8cea23c4c7fddf05fd55eff29d87d50f7d822c382859142/68747470733a2f2f62616467656e2e6e65742f7061636b61676973742f64742f67686f73747772697465722f636f6e6669673f636f6c6f723d626c7565)](https://packagist.org/packages/ghostwriter/config) Provides an object that maps configuration keys to values. Installation ------------ [](#installation) You can install the package via composer: ``` composer require ghostwriter/config ``` ### Star ⭐️ this repo if you find it useful [](#star-️-this-repo-if-you-find-it-useful) You can also star (🌟) this repo to find it easier later. Features -------- [](#features) - 🔑 **Dot Notation**: Access nested configuration using dot, forward slash, or backslash separators - 🔄 **Flexible Merging**: Merge arrays, files, or directories - 🔧 **Array Operations**: Append and prepend values to configuration arrays - 🎯 **Scoped Configuration**: Wrap nested configuration into isolated instances API --- [](#api) ``` /** * @template T of (array|bool|float|int|null|string) */ interface ConfigurationInterface { /** @throws ConfigurationExceptionInterface */ public function append(string $key, mixed $value): void; /** @throws ConfigurationExceptionInterface */ public function get(string $key, mixed $default = null): mixed; /** @throws ConfigurationExceptionInterface */ public function has(string $key): bool; /** * @param array $options * @throws ConfigurationExceptionInterface */ public function merge(array $options): void; /** @throws ConfigurationExceptionInterface */ public function mergeDirectory(string $directory): void; /** @throws ConfigurationExceptionInterface */ public function mergeFile(string $file, ?string $key = null): void; /** @throws ConfigurationExceptionInterface */ public function prepend(string $key, mixed $value): void; public function reset(): void; /** @throws ConfigurationExceptionInterface */ public function set(string $key, mixed $value): void; /** @return array */ public function toArray(): array; /** @throws ConfigurationExceptionInterface */ public function unset(string $key): void; /** * @param array $default * @throws ConfigurationExceptionInterface */ public function wrap(string $key, array $default = []): self; } ``` Usage ----- [](#usage) Given the following configuration directory structure - `path/to/config/directory/app.php` - `path/to/config/directory/database.php` - `path/to/config/directory/file.php` ``` $directory = 'path/to/config/directory'; $file = 'path/to/config/directory/file.php'; $options = [ 'settings' => [ 'enable' => true, ], ]; $configuration = Configuration::new($options); $configuration->has('settings.disabled'); // false $configuration->get('settings.disabled'); // null $configuration->get('settings.disabled', 'default'); // 'default' $configuration->set('settings.disabled', false); $configuration->has('settings.disabled'); // true $configuration->get('settings.disabled'); // false $configuration->toArray(); // ['settings' => ['enable'=>true,'disabled'=>false]] $configuration->unset('settings.disabled'); $configuration->get('settings.disabled'); // null $configuration->get('settings.disabled', 'default'); // 'default' $configuration->toArray(); // ['settings' => ['enable'=>true]] ``` ``` // from an array $configuration = Configuration::new($options); $configuration->toArray(); // ['settings' => ['enable'=>true]] ``` ``` // merge additional config options $additionalOptions = [ 'settings' => [ 'disabled' => false, ], ]; $configuration = Configuration::new($options); $configuration->merge($additionalOptions); $configuration->toArray(); // ['settings' => ['enable'=>true,'disabled'=>false]] ``` ``` // from an array with dot notation $configuration = Configuration::new($options); $configuration->toArray(); // ['settings' => ['enable'=>true]] $configuration->has('settings'); // true $configuration->has('settings.enable'); // true $configuration->get('settings.enable'); // true ``` ``` // from a directory $configuration = Configuration::new(); $configuration->mergeDirectory($directory); $configuration->toArray(); // output below // [ // 'app' => ['name'=>'App','version'=>'1.0.0'], // 'database' => ['host'=>'localhost','port'=>3306], // 'file' => ['path'=>'/path/to/file'] // ] ``` ``` // from a file $configuration = Configuration::new(); $configuration->mergeFile($file); $configuration->toArray(); // ['path'=>'/path/to/file'] // from a file with a namespace key $configuration = Configuration::new(); $configuration->mergeFile($file, 'custom'); $configuration->toArray(); // ['custom' => ['path'=>'/path/to/file']] ``` ``` // append values $configuration = Configuration::new($options); $configuration->append('settings', ['key' => 'value']); $configuration->toArray(); // ['settings' => ['enable'=>true,'key'=>'value']] ``` ``` // prepend values $configuration = Configuration::new($options); $configuration->prepend('settings', ['key' => 'value']); $configuration->toArray(); // ['settings' => ['key'=>'value','enable'=>true]] ``` ``` // wrap configuration into a new scoped instance $configuration = Configuration::new([ 'database' => [ 'host' => 'localhost', 'port' => 3306, ], ]); $dbConfig = $configuration->wrap('database'); $dbConfig->get('host'); // 'localhost' $dbConfig->toArray(); // ['host' => 'localhost', 'port' => 3306] // wrap with default values when key doesn't exist $cacheConfig = $configuration->wrap('cache', ['driver' => 'redis']); $cacheConfig->toArray(); // ['driver' => 'redis'] ``` ``` // reset configuration $configuration = Configuration::new(['key' => 'value']); $configuration->toArray(); // ['key' => 'value'] $configuration->reset(); $configuration->toArray(); // [] ``` ``` // mixed separators support (dot, forward slash, backslash) $configuration = Configuration::new(); $configuration->set('app.name', 'MyApp'); $configuration->get('app.name'); // 'MyApp' $configuration->get('app/name'); // 'MyApp' (forward slash) $configuration->get('app\name'); // 'MyApp' (backslash) $configuration->has('app.name'); // true $configuration->has('app/name'); // true $configuration->has('app\name'); // true ``` ``` // append/prepend to nested keys $configuration = Configuration::new(); $configuration->append('list.items', 'first'); $configuration->append('list.items', 'second'); $configuration->toArray(); // ['list' => ['items' => ['first', 'second']]] $configuration->prepend('list.items', 'zero'); $configuration->toArray(); // ['list' => ['items' => ['zero', 'first', 'second']]] ``` ``` // automatic array promotion $configuration = Configuration::new(); $configuration->set('parent', 'scalar'); $configuration->set('parent.child', 'value'); // 'parent' is promoted to array $configuration->toArray(); // ['parent' => ['child' => 'value']] ``` ### Changelog [](#changelog) Please see [CHANGELOG.md](./CHANGELOG.md) for more information on what has changed recently. ### Credits [](#credits) - [Nathanael Esayeas](https://github.com/ghostwriter) - [All Contributors](https://github.com/ghostwriter/config/contributors) ### License [](#license) Please see [LICENSE](./LICENSE) for more information on the license that applies to this project. ### Security [](#security) Please see [SECURITY.md](./SECURITY.md) for more information on security disclosure process. ### Health Score 57 — FairBetter than 98% of packages Maintenance82 Actively maintained with recent releases Popularity42 Moderate usage in the ecosystem Community16 Small or concentrated contributor base Maturity72 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~84 days Recently: every ~31 days Total 15 Last Release 54d ago Major Versions 0.4.x-dev → 1.0.02025-01-07 1.1.x-dev → 2.0.02025-11-01 1.0.x-dev → 2.0.12025-11-19 2.1.x-dev → 3.0.x-dev2026-03-25 PHP version history (6 changes)0.1.0PHP >=8.1,<8.3 0.4.0PHP >=8.1 <8.3 0.4.1PHP >=8.1 <8.4 1.0.0PHP >=8.4 1.1.x-devPHP ^8.4 2.0.0PHP ~8.4.0 || ~8.5.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/1dbb0131801cc451dad9917ab29aa823b25d7eebc9f3875a9d481d109bdb44ee?d=identicon)[ghostwriter](/maintainers/ghostwriter) --- Top Contributors [![ghostwriter](https://avatars.githubusercontent.com/u/9754361?v=4)](https://github.com/ghostwriter "ghostwriter (1097 commits)") --- Tags configconfigurationghostwriterconfigghostwriter ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/ghostwriter-config/health.svg) ``` [![Health](https://phpackages.com/badges/ghostwriter-config/health.svg)](https://phpackages.com/packages/ghostwriter-config) ``` ### Alternatives [symfony/options-resolver Provides an improved replacement for the array\_replace PHP function 3.2k493.9M1.6k](/packages/symfony-options-resolver)[league/config Define configuration arrays with strict schemas and access values with dot notation 564302.2M24](/packages/league-config)[m1/env Env is a lightweight library bringing .env file parser compatibility to PHP. In short - it enables you to read .env files with PHP. 6412.0M21](/packages/m1-env) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)