https://github.com/spacetab-io/configuration-php
Configuration module for microservices written on PHP. Specially created for follow up corporate standards of application configuration.
https://github.com/spacetab-io/configuration-php
configuration microservice php standard yaml
Last synced: about 2 months ago
JSON representation
Configuration module for microservices written on PHP. Specially created for follow up corporate standards of application configuration.
- Host: GitHub
- URL: https://github.com/spacetab-io/configuration-php
- Owner: spacetab-io
- License: mit
- Created: 2020-04-05T18:06:22.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-04-11T14:29:09.000Z (almost 4 years ago)
- Last Synced: 2025-11-27T16:34:09.268Z (4 months ago)
- Topics: configuration, microservice, php, standard, yaml
- Language: PHP
- Homepage:
- Size: 66.4 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
PHP Configuration
-----------------
[](https://circleci.com/gh/spacetab-io/configuration-php/tree/master)
[](https://codecov.io/gh/spacetab-io/configuration-php)
Configuration module for PHP that supports multiple application stages like `dev`, `prod` or `something else`
and overrides the `defaults` stage.
## Installation
```bash
composer require spacetab-io/configuration
```
#### Versions map
* Package with version `4.*` requires PHP >= `8.1`
* Package with version `3.*` requires PHP >= `7.4` <= `8.0`
* Package with version `2.*` requires PHP < `7.4`
## Usage
By default, path to configuration directory and application stage
loading from `/app/configuration` with `local` stage.
1) Simple
```php
load();
var_dump($conf->all()); // get all config
echo $conf->get('foo.bar'); // get nested key use dot notation
echo $conf['foo.bar']; // the same, but use ArrayAccess interface.
```
Supported dot-notation syntax with an asterisk in `get` method.
You can read about it here: https://github.com/spacetab-io/obelix-php
2) If u would like override default values, you can pass 2 arguments to
class constructor or set up use setters.
```php
load();
$conf->get('key'); // full example on the top
```
3) If the operating system has an env variables `CONFIG_PATH` and `STAGE`,
then values for the package will be taken from there.
```bash
export CONFIG_PATH=/configuration
export STAGE=prod
```
```php
load(); // loaded files from /configuration for prod stage.
$conf->get('key'); // full example on the top
```
4) If u want to see logs and see how load process working,
pass you application logger to the following method:
```php
setLogger($monolog); // PSR compatible logger.
$conf->load();
$conf->get('key'); // full example on the top
```
If you want you can use [this package](https://github.com/spacetab-io/logger-php) for logs:
```bash
composer require spacetab-io/logger
```
That all.
## CLI utility
Also, you can install simple small cli-utility to dump total results of merged config.
It is possible with multiple ways:
1) Install to `/usr/local/bin` as global binary
```bash
L=/usr/local/bin/st-conf && sudo curl -L https://github.com/spacetab-io/configuration-php/releases/download/2.2.0/st-conf.phar -o $L && sudo chmod +x $L
```
2) Install library as global composer requirements
First step:
```bash
composer global require spacetab-io/configuration-php
```
It will be installed to `~/.composer` directory.
If you have `~/.composer/vendor/bin` in globals path, you can try run command:
```bash
st-conf help dump
```
Otherwise, you can be register that directory:
```bash
echo 'export PATH=~/.composer/vendor/bin:$PATH' >> ~/.bash_profile
source ~/.bash_profile
```
### CLI Usage
```bash
Description:
Dump loaded configuration
Usage:
dump [options] [--] [ []]
Arguments:
path Configuration directory path
stage Configuration $STAGE
Options:
-l, --inline[=INLINE] The level where you switch to inline YAML [default: 10]
-s, --indent[=INDENT] The amount of spaces to use for indentation of nested nodes [default: 2]
-d, --debug Debug
-h, --help Display this help message
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n, --no-interaction Do not ask any interactive question
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
Help:
Example of usage: `st-conf dump`. Options --inline=10 (nesting level) and --indent=2. If [path] and [stage] arguments not passed will be used global env variables CONFIG_PATH and STAGE.
```
## Depends
* \>= PHP 8.1
* Composer for install package
## License
The MIT License
Copyright © 2022 spacetab.io, Inc. https://spacetab.io
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.