Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomwright/phpconfig
A quick and easy Config package designed to pass around a set of values, accessible anywhere in an application.
https://github.com/tomwright/phpconfig
config php php-7
Last synced: about 1 month ago
JSON representation
A quick and easy Config package designed to pass around a set of values, accessible anywhere in an application.
- Host: GitHub
- URL: https://github.com/tomwright/phpconfig
- Owner: TomWright
- Created: 2016-11-10T21:12:05.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-22T22:54:51.000Z (almost 7 years ago)
- Last Synced: 2024-10-12T12:21:53.412Z (about 1 month ago)
- Topics: config, php, php-7
- Language: PHP
- Homepage:
- Size: 40 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Config
[](https://travis-ci.org/TomWright/PHPConfig)
[](https://codeclimate.com/github/TomWright/PHPConfig/coverage)
[](https://packagist.org/packages/tomwright/php-config)
[](https://packagist.org/packages/tomwright/php-config)
[](https://packagist.org/packages/tomwright/php-config)
[](https://packagist.org/packages/tomwright/php-config)
[](https://packagist.org/packages/tomwright/php-config)
## Installation
```
composer require tomwright/php-config
```
## General Usage
Create an instance of `Config` to get going:
```php
$config = new Config();
```
### Add values to the config as follows
```php
$config->put('key', 'value');
```
### Get values from the config as follows
```php
$value = $config->get('key');
```
## Storing Data
You can add separators to the `key` string in order to have the data stored slightly differently.
For example, let's say we have a contact name and email address. You can set this in any of the following ways:
```php
$config->put('contact', [
'name' => 'Tom',
'email' => '[email protected]',
]);
$config->put('contact.name', 'Tom');
$config->put('contact.email', '[email protected]');
```
You can even mix and match between the above:
```php
$config->put('contact', [
'name' => 'Tom',
]);
$config->put('contact.email', '[email protected]');
```
## Fetching Data
You can use the dot separators in a similar way to the above when fetching data too.
Assuming we have the same contact details stored, let's look at the following:
```php
$config->get('contact'); // [ 'name' => 'Tom', 'email' => '[email protected]' ]
$config->get('contact.name'); // Tom
$config->get('contact.email'); // [email protected]
```
## Separators
You can use as many separators in the key as you would like. The following will end up working in the same way as the above, just with a deeper level of storage.
```
$config->put('company.person.tom.email', '[email protected]');
$config->put('company.person.jim.email', '[email protected]');
$config->get('company');
/*
[
'person' => [
'tom' => [ 'email' => '[email protected]' ],
'jim' => [ 'email' => '[email protected]' ],
]
]
*/
```
If you would like to use a separator other than the `.` character, you may set one using the `setSeparator()` method, or by passing it in in the Config constructor.
```php
$config = new Config([
'separator' => '|', // Equal
]);
$config->setSeparator('|'); // Equal
$config->put('contact', [
'contact' => [
'name' => 'Tom',
'email' => '[email protected]',
],
]);
$config->get('contact|name'); // Tom
$config->get('contact.email'); // NULL
```
## Config Readers
Config readers are classes to help you auto-populate the config object with values.
To use a Config Reader, simply pass it into `$config->read()`.
```
$config = new Config();
$config->read(new SomeConfigReader());
$config->get('some.value.from.my.reader');
```
You can also pass an array of Config Readers into the Config constructor:
```
$config = new Config([
'readers' => [
new SomeConfigReader(),
],
]);
$config->get('some.value.from.my.reader');
```
### Existing Config Readers
If you would like to create a Config Reader please feel free. The only requirement is that you implement the `ConfigReader` interface.
If you have already created a Config Reader and would like it to appear here, please submit a pull request.
- [PHPFileReader](/docs/PHPFileReader.md)
- [JSONFileReader](/docs/JSONFileReader.md)