comphp/config-yaml

Configuration Driver for CommonPHP which encodes/decodes the YAML

Maintainers

Package info

github.com/commonphp/config-yaml

pkg:composer/comphp/config-yaml

Statistics

Installs: 1

Dependents: 0

Suggesters: 0

Stars: 1

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

0.3 2026-05-20 17:45 UTC

Requires

Requires (Dev)

MIT 20103b2d7a78153721cb6f548782f8c8b8959d84

This package is auto-updated.

Last update: 2026-05-20 17:50:19 UTC

README

Configuration driver for CommonPHP that encodes and decodes YAML configuration data.

Requirements

  • PHP ^8.5
  • comphp/config:^0.3
  • symfony/yaml:^8.0

Installation

Once this package is available through your Composer repositories, install it with:

composer require comphp/config-yaml

Usage

<?php

use CommonPHP\Drivers\Config\YAML\YamlConfigurationDriver;

$driver = new YamlConfigurationDriver();

$config = [
    'app' => 'demo',
    'debug' => true,
    'database' => [
        'host' => 'localhost',
    ],
];

$yaml = $driver->encode($config);
$decoded = $driver->decode($yaml);

$driver->write(__DIR__ . '/config.yaml', $config);
$fromFile = $driver->read(__DIR__ . '/config.yaml');

Format Notes

This driver uses Symfony YAML. YAML mappings decode to arrays, empty YAML decodes to an empty array, and scalar-only YAML is rejected as configuration data.

Error Handling

Read, write, parse, validation, and unsupported value failures throw CommonPHP config exceptions such as ConfigReadException, ConfigWriteException, ConfigValidationException, or ConfigException.

Documentation

License

MIT. See LICENSE.md.