Skip to content

README.md

Latest commit

 

History

History
59 lines (38 loc) · 1.32 KB

README.md

File metadata and controls

59 lines (38 loc) · 1.32 KB

CommonPHP JSON Config Driver

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

Requirements

  • PHP ^8.5
  • comphp/config:^0.3

Installation

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

composer require comphp/config-json

Usage

<?php

use CommonPHP\Drivers\Config\JSON\JsonConfigurationDriver;

$driver = new JsonConfigurationDriver();

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

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

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

Format Notes

JSON data must decode to a PHP array. JSON objects and arrays can be configuration containers; scalar JSON values such as true or "hello" are rejected by decode() and validate().

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.