Download the PHP package tomkyle/configreader without Composer
On this page you can find all versions of the php package tomkyle/configreader. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tomkyle/configreader
More information about tomkyle/configreader
Files in tomkyle/configreader
Package configreader
Short Description Successor of germania-kg/configreader: Merge default and custom configuration files with Symfony YAML. Supports PSR-6 CacheItemPools.
License MIT
Homepage https://github.com/tomkyle/ConfigReader
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package configreader
tomkyle · ConfigReader
PHP 8.1+ successor of GermaniaKG/ConfigReader by its original author. Reads and merges default and custom configuration files with Symfony YAML.
Installation
This package is version v3.3 and requires PHP 8.1+ For older PHP versions 7.1 to 8.0, head over to GermaniaKG/ConfigReader or germania-kg/configreader on Packagist to install package version up to version 3.2.
Roadmap
- From v4 onwards, the namespace will change from
Germania\ConfigReadertotomkyle\ConfigReader
Interfaces
The ConfigReaderInterface requires an __invoke method which may be called with an arbitrary number of filename strings:
Usage
YamlConfigReader
The YamlConfigReader implemens ConfigReaderInterface. It internally uses array_replace_recursive. If the given config files do not exist, nothing happens. The return value is an array in any case.
PSR-6 Cache support
The CacheConfigReader also implements ConfigReaderInterface and combines a ConfigReaderInterface instance with PSR-6 Cache functionality.
YAML parsing options
The setYamlFlags method allows to set integer flags to be used by Symfony's YAML component. See official docs for a list of possible values: Symfony YAML component docs.
Ideas for using in config files:
- Yaml::PARSE_CONSTANT for evaluating constants created with
.envconfiguration - Yaml::PARSE_DATETIME to save work with string-to-DateTime conversion
Do not use Yaml::PARSE_OBJECT_FOR_MAP as it will break the internal array_replace_recursive call. This is a good topic for future releases.
Excluding results
Given a YAML map like this:
To exclude a certain elements, use setIgnoreKey to set the name of a YAML map item that contains the keys to exclude. The result in our example will not contain neither foonor _ignore. Be careful to not overuse this feature!
Exceptions
When YamlConfigReader stumbles upon a Symfony\Component\Yaml\Exception\ParseException, it will catch it and wrap it in a Germania\ConfigReader\ParseException. This class implements ConfigReaderExceptionInterface you can watch out for:
Development
Unit tests
Either copy phpunit.xml.dist to phpunit.xml and adapt to your needs, or leave as is. Run PhpUnit test or composer scripts like this:
The test results logs are in the tests/log directory.
All versions of configreader with dependencies
psr/log Version ^2.0|^3.0
psr/cache Version ^2.0|^3.0
symfony/yaml Version ^6.1|^7.0
germania-kg/cachecallable Version ^2.0