Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yosymfony/config-loader
An agnostics configuration loader with built-in loaders for YAML, TOML and JSON.
https://github.com/yosymfony/config-loader
config configuration json php toml yaml
Last synced: about 1 month ago
JSON representation
An agnostics configuration loader with built-in loaders for YAML, TOML and JSON.
- Host: GitHub
- URL: https://github.com/yosymfony/config-loader
- Owner: yosymfony
- License: mit
- Created: 2014-07-19T17:21:43.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2019-04-15T09:26:10.000Z (over 5 years ago)
- Last Synced: 2024-10-07T10:56:50.460Z (3 months ago)
- Topics: config, configuration, json, php, toml, yaml
- Language: PHP
- Homepage:
- Size: 66.4 KB
- Stars: 10
- Watchers: 3
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Config loader for PHP
=====================
An agnostics configuration loader with built-in loaders for YAML, TOML and JSON.
[](https://travis-ci.org/yosymfony/config-loader)
[](https://packagist.org/packages/yosymfony/config-loader)
[](https://scrutinizer-ci.com/g/yosymfony/Config-loader/?branch=master)
Installation
------------
**Requires PHP >= 7.2.**
Use [Composer](http://getcomposer.org/) to install this package:
```bash
composer require yosymfony/config-loader
```
Usage
-----
### Initialization
The class `ConfigLoader` let you load your configuration resources. It expects a list of
loaders in the constructor so you can pass to it only those ones you need:
```php
use Yosymfony\ConfigLoader\FileLocator;
use Yosymfony\ConfigLoader\ConfigLoader;
// The file locator uses an array of pre-defined paths to find files:
$locator = new FileLocator(['/path1', '/path2']);
// Set up the ConfigLoader to work with YAML and TOML configuration files:
$config = new ConfigLoader([
new YamlLoader($locator),
new TomlLoader($locator),
]);
```
### Available loaders
#### Yaml loader
**Requires**: [Symfony YAML](https://github.com/symfony/yaml) component:
```bash
composer require symfony/yaml
```
Initialization:
```php
$config = new ConfigLoader([
new YamlLoader($locator),
]);
```
#### Toml loader
**Requires**: [Toml](https://github.com/yosymfony/toml) component:
```bash
composer require yosymfony/toml
```
Initialization:
```php
$config = new ConfigLoader([
new TomlLoader($locator),
]);
```
#### Json loader
Initialization:
```php
$config = new ConfigLoader([
new JsonLoader($locator),
]);
```
### Loading configuration files:
```php
// Search this file in "path1" and "path2":
$config->load('user.yml');
// or load a file using its absolute path:
$config->load('/var/config/user1.yml');
```
#### *.dist* files
This library has support for `.dist` files. The filename is resolved following the next hierarchy:
1. filename.ext
2. filename.ext.dist (if `filename.ext` does not exist)
### Loading inline configuration:
To parse inline configurations you just need to set the configuration text as first argument instead of the filename
and set the format type as second one:
```php
$repository = $config->load('server: "your-name.com"', YamlLoader::TYPE);
```
### Importing files
This library has support for importing files.
The example below shows a YAML file importing three files:
```yaml
---
imports:
- config-imported.yml
- config-imported.toml
- config-imported.json
```
Similar example using JSON syntax:
```json
{
"imports": [
"config.json"
]
}
```
An example using TOML syntax:
```
imports = [
"config.toml"
]
```
Repository
----------
A configuration file is loaded into a repository. A repository is a wrapper
that implements the [ArrayAccess interface](http://php.net/manual/en/class.arrayaccess.php) and exposes methods for working
with configuration values.
```php
// Returns the value associeted with key "name" or the default value in case not found
$repository->get('name', 'default');
// Do the same that the previous sentence but using array notation
$repository['name'];
```
### Operations
#### Unions
You can performs the union of a repository A with another B into C as result:
```php
$resultC = $repositoryA->union($repositoryB);
```
The values of `$repositoryB` have less priority than values in `$repositoryA`.
#### Intersections
You can performs the intersection of a repository A with another B into C as result:
```php
$resultC = $repositoryA->intersection($repositoryB);
```
The values of `$repositoryB` have less priority than values in `$repositoryA`.
### Creating a blank repository
Creating a blank repository is too easy. You just need to create a instance of
a `Repository` class:
```php
use Yosymfony\Config-loader\Repository;
//...
$repository = new Repository([
'name' => 'Yo! Symfony',
]);
$repository->set('server', 'your-name.com');
```
Unit tests
----------
You can run the unit tests with the following command:
```bash
$ cd toml
$ composer test
```
License
-------
This library is open-sourced software licensed under the
[MIT license](http://opensource.org/licenses/MIT).