maer/config-yaml-reader

A yaml reader for the maer/config library

1.0.0 2018-04-12 14:54 UTC

Requires

• php: >=7.0.0
• maer/config: ^2.0
• phpunit/phpunit: ^6.5
• symfony/yaml: ^3.4||^4.0

Requires (Dev)

• squizlabs/php_codesniffer: ^3.2

MIT

• Magnus Eriksson

README

To keep the maer/config library small and without dependencies, it doesn't support yaml-files out of the box.

If you want to use yaml-files, you can install this reader and register it for the yaml-file extension. This extension requires you to use maer/config version 2+.

Install

composer require maer/config-yaml-reader

If maer/config wasn't installed before, it will also be installed.

Register

You need to register the reader and associate it with the yml-file extension.

# Either add the reader to an existing config instance
$config->setReader('yml', new Maer\Config\Yaml\Reader);

# or you can add the reader when you instantiate the config class as a second argument
$options = [
    'readers' => [
        'yml' => new Maer\Config\Yaml\Reader,
    ],
];

$config = new Config(['/path-to-your-config.yml'], $options);

If you go for the first option, you need to set the reader before you load the yaml-file.

Exceptions

If the yaml file couldn't be parsed, it will throw a Symfony\Component\Yaml\Exception\ParseException.