fastd/config

config container

Maintainers

Package info

github.com/fastdlabs/config

pkg:composer/fastd/config

Statistics

Installs: 20 427

Dependents: 8

Suggesters: 0

Stars: 4

Open Issues: 0

v8.0.0 2026-05-28 16:51 UTC

README

Build Status Latest Stable Version Total Downloads Latest Unstable Version License

FastD\Config 是一个轻量级的 PHP 配置解析器,支持多种配置文件格式(JSON、YAML、INI、PHP),并提供强大的变量替换功能。它允许您使用统一的 API 来处理不同格式的配置文件,简化了配置管理的复杂性。

环境依赖说明

PHP 版本要求

  • 最低版本: PHP 8.2
  • 推荐版本: PHP 8.2 或更高版本

依赖库

  • symfony/yaml: ^8.0 (用于解析 YAML 格式配置文件)
  • ext-json: * (PHP 内置扩展,用于解析 JSON 格式配置文件)

基础使用说明

安装

使用 Composer 进行安装:

composer require fastd/config

基本用法

<?php
require_once 'vendor/autoload.php';

use FastD\Config\FileParser;

// 创建解析器实例
$parser = new FileParser();

// 解析配置文件
$config = $parser->parse('config/app.json');

// 访问配置值
echo $config->get('database.host');

变量替换

FastD\Config 支持变量替换功能,变量使用 % 符号标记:

// 配置文件中使用变量
// database:
//   host: "%db_host%"
//   port: "%db_port%"

$variables = [
    'db_host' => 'localhost',
    'db_port' => 3306
];

$parser = new FileParser($variables);
$config = $parser->parse('config/database.yml');

// 变量会被替换
echo $config->get('database.host'); // localhost

支持的配置格式

  • JSON: 标准 JSON 格式配置文件
  • YAML: 人类可读的 YAML 格式配置文件
  • INI: 传统的 INI 格式配置文件
  • PHP: PHP 数组返回格式的配置文件

文档详细引导

详细文档请参考项目文档库,包含以下内容:

1. 项目概述

2. API 参考

3. 安装与使用

测试

phpunit

贡献

欢迎任何形式的贡献!您可以通过以下方式参与项目:

  • 🐛 报告问题
  • 💡 提交功能建议
  • 🔧 贡献代码和文档
  • ⭐ Star项目支持

请确保在提交Pull Request前:

  1. 编写相应的测试用例
  2. 确保所有测试通过
  3. 遵循项目的代码风格
  4. 更新相关文档

License

MIT