Download the PHP package borschphp/config without Composer
On this page you can find all versions of the php package borschphp/config. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download borschphp/config
More information about borschphp/config
Files in borschphp/config
Informations about the package config
Borsch Config
A lightweight and easy to use configuration library.
Features
- Simple and intuitive API
- Support for multiple file formats (JSON, YAML, INI, DOTENV)
- Aggregate multiple configuration sources
- Caching for improved performance in production
Installation
Via composer :
Usage
The Config class implements the ContainerInterface from PSR-11, therefore you have access to all its methods to
check if a key exists and to retrieve its value.
A getOrDefault() method is also available to provide a default value if the key does not exist.
Internally, readers are used to parse configuration files of different formats. The following readers are available:
Borsch\Config\Reader\Jsonfor JSON filesBorsch\Config\Reader\Yamlfor YAML files (viasymfony/yaml)Borsch\Config\Reader\Inifor INI filesBorsch\Config\Reader\DotEnvfor DOTENV files (viavlucas/phpdotenv)
The Aggregator class allows you to merge multiple configuration sources into a single Config instance. You can also
provide a cache file path to store the merged configuration for faster access in production environments.
A simple example with just one reader :
A more complete example with multiple readers :
Providers
Providers allow you to specify file paths, internally it uses the glob() function to find matching files so you can use
glob() patterns.
Because the providers are callable, configuration loading can be deferred until actually needed, this is the recommended
way to build your configuration in order to avoid unnecessary file parsing in production.
There is no interface for providers, they just need to be classes implementing the __invoke() method and returning an
array.
Therefore, it is possible to only provide the provider FQDN if there is no constructor arguments. Example :
A complete example with providers and caching enabled :
Binding Configuration to Objects
The bind() method allows you to map a configuration array directly into a typed object. It uses
cuyz/valinor under the hood, which means it supports constructor injection,
type casting, and nested objects out of the box.
The first argument is the configuration key to read from, and the second is the fully qualified class name to map the values into. The keys in the configuration array must match the property names of the target class.
License
The package is licensed under the MIT license. See License File for more information.
All versions of config with dependencies
psr/container Version ^2.0
symfony/yaml Version ^7.3
vlucas/phpdotenv Version ^5.6
dflydev/dot-access-data Version ^3.0
cuyz/valinor Version ^2.3