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.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

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.

Packagist PHP version Tests

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

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:

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

PHP Build Version
Package Version
Requires php Version ^8.1
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
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package tomkyle/configreader contains the following files

Loading the files please wait ....