orbiter / satellite-config
Simple config aggregator with caching.
0.2.1
2022-10-20 18:20 UTC
Requires
- php: >=8.1
Requires (Dev)
- phpunit/phpunit: ^9.5
README
- simple config aggregator with caching
Check satellite-app for a ready to use template, or install just this library:
composer require orbiter/satellite-config
- ConfigProvider implementing
Satellite\Config\ConfigProviderInterface
- ConfigInvokableProvider using
__invoke(): array
$aggregator = new \Satellite\Config\ConfigAggregator($is_prod ? __DIR__ . '/tmp/config_aggregated.php' : null); $aggregator->append( ConfigProvider::class, ConfigInvokableProvider::class, // pass down functions which return an array (when using cache: only executed on warm-up) static fn() => [ 'some_array' => [ 'a' => [], ], ], // pass down arrays: [ 'some_array' => [ 'b' => [], // functions can also be used nested (when using cache: only executed on warm-up) 'c' => static fn() => [], ] ], ); // just aggregate: $config = $aggregator->make(); // aggregate and use cache (if configured): $config = $aggregator->configure();
Dev Notices
Commands to set up and run e.g. tests:
# on windows: docker run -it --rm -v %cd%:/app composer install docker run -it --rm -v %cd%:/var/www/html php:8.1-cli-alpine sh docker run --rm -v %cd%:/var/www/html php:8.1-cli-alpine sh -c "cd /var/www/html && ./vendor/bin/phpunit --testdox -c phpunit-ci.xml --bootstrap vendor/autoload.php" # on unix: docker run -it --rm -v `pwd`:/app composer install docker run -it --rm -v `pwd`:/var/www/html php:8.1-cli-alpine sh docker run --rm -v `pwd`:/var/www/html php:8.1-cli-alpine sh -c "cd /var/www/html && ./vendor/bin/phpunit --testdox -c phpunit-ci.xml --bootstrap vendor/autoload.php"
Versions
This project adheres to semver, until 1.0.0
and beginning with 0.1.0
: all 0.x.0
releases are like MAJOR releases and all 0.0.x
like MINOR or PATCH, modules below 0.1.0
should be considered experimental.
License
This project is free software distributed under the MIT LICENSE.
Contributors
By committing your code to the code repository you agree to release the code under the MIT License attached to the repository.
Maintained by Michael Becker