README

Config是一个文件配置加载器，支持PHP、INI、XML、JSON、YML、Properties和序列化文件和字符串。

要求

Config需要PHP 8.1及以上。

重要：如果您想使用YAML文件或字符串，请在您的composer.json中要求Symfony Yaml组件。

安装

Config的安装方式支持通过Composer。

$ composer require camoo/config

使用方法

Config设计得非常简单直观。您可以使用它来加载、获取和设置。

加载文件

可以通过工厂方法load()或直接实例化创建Config对象。

use Camoo\Config\Config;
use Camoo\Config\Enum\Parser;

// Load a single file
$conf = Config::load('config.json');
$conf = new Config('config.json');

// Load values from multiple files
$conf = new Config(['config.json', 'config.xml']);

// Load all supported files in a directory
$conf = new Config(__DIR__ . '/config');

// Load values from optional files
$conf = new Config(['config.dist.json', '?config.json']);

// Load a file using specified parser
$conf = new Config('configuration.config', Parser::JSON);

根据文件扩展名或指定的解析器解析和加载文件。如果指定了解析器，它将对所有文件使用。注意，当加载多个文件时，具有重复键的条目将采用最后加载的文件的值。

加载目录时，路径将通过glob进行匹配，文件按名称字母顺序加载。

警告：不要包含未信任的PHP格式的配置。它可能包含并执行恶意代码。

加载字符串

可以通过工厂方法load()或通过设置参数$string为true的直接实例化创建字符串配置。

use Camoo\Config\Config;
use Camoo\Config\Enum\Parser;
use Camoo\Config\Parser\Json;
use Camoo\Config\Parser\Yaml;

$settingsJson = <<<FOOBAR
{
  "application": {
    "name": "configuration",
    "secret": "s3cr3t"
  },
  "host": "localhost",
  "port": 80,
  "servers": [
    "host1",
    "host2",
    "host3"
  ]
}
FOOBAR;

$settingsYaml = <<<FOOBAR
application:
    name: configuration
    secret: s3cr3t
host: localhost
port: 80
servers:
- host1
- host2
- host3

FOOBAR;

$conf = Config::load($settingsJson, Parser::JSON, true);
$conf = new Config($settingsYaml, Parser::YAML, true);

警告：不要包含未信任的PHP格式的配置。它可能包含并执行恶意代码。

获取值

获取值可以通过三种方式完成。一种是通过使用get()方法

// Get value using key
$debug = $conf->get('debug');

// Get value using nested key
$secret = $conf->get('security.secret');

// Get a value with a fallback
$ttl = $conf->get('app.timeout', 3000);

第二种方法，就像使用数组一样使用它

// Get value using a simple key
$debug = $conf['debug'];

// Get value using a nested key
$secret = $conf['security.secret'];

// Get nested value like you would from a nested array
$secret = $conf['security']['secret'];

第三种方法，是使用all()方法

// Get all values
$data = $conf->all();

设置值

尽管Config支持通过set()或通过数组语法设置值，但通过这种方式进行的任何更改都不会反映到源文件中。按照设计，如果您需要更改配置文件，您必须手动进行。

$conf = Config::load('config.json');

// Sample value from our config file
assert($conf['secret'] == '123');

// Update config value to something else
$conf['secret'] = '456';

// Reload the file
$conf = Config::load('config.json');

// Same value as before
assert($conf['secret'] == '123');

// This will fail
assert($conf['secret'] == '456');

保存配置

可以将配置保存回任何支持的格式，除了PHP。

use use Camoo\Config\Enum\Writer;

$config = Config::load('config.json');

$ini = $config->toString(Writer::INI); // Encode to string if you want to save the file yourself

$config->toFile('config.yaml');
$config->toFile('config.txt', Writer::SERIALIZE); // you can also force the writer

使用默认值

有时在您的项目中，您可能想使用Config来存储应用程序设置，而不需要文件I/O。您可以通过扩展AbstractConfig类并填充getDefaults()方法来实现这一点

class MyConfig extends AbstractConfig
{
    protected function getDefaults()
    {
        return [
            'host' => 'localhost',
            'port'    => 80,
            'servers' => [
                'host1',
                'host2',
                'host3'
            ],
            'application' => [
                'name'   => 'configuration',
                'secret' => 's3cr3t'
            ]
        ];
    }
}

合并实例

您可能想要合并多个Config实例

$conf1 = Config::load('conf1.json');
$conf2 = Config::load('conf2.json');
$conf1->merge($conf2);

支持的配置文件示例

简单有效配置文件的示例可以在这里找到：这里。

测试

$ phpunit

camoo / config

维护者

详细信息