comphp/config-php

提供与PHP配置文件工作所需的功能

v0.1 2024-02-18 14:53 UTC

This package is auto-updated.

Last update: 2024-09-18 16:35:59 UTC


README

此库引入了PHP配置驱动程序 PhpConfigurationDriver,作为CommonPHP配置管理生态系统中的一部分。它通过允许应用程序无缝地使用PHP文件加载和保存配置,扩展了CommonPHP的功能。

特性

  • 加载PHP配置:简化了读取PHP文件并将其转换为关联数组以在PHP应用程序中轻松访问的过程。
  • 将配置保存为PHP:能够将PHP关联数组反序列化为PHP格式,保留结构和层次。
  • 结构化错误处理:通过详细的异常处理来有效地管理潜在的解析和文件操作错误。
  • 支持嵌套结构:通过自定义实现,支持在PHP文件中表示嵌套结构,为配置管理提供更大的灵活性。

安装

使用Composer将配置管理器和PHP驱动程序集成到您的项目中

composer require comphp/config
composer require comphp/config-php

使用方法

要使用配置管理器与PHP驱动程序,首先确保 DriverManager 已配置以识别PHP驱动程序

use CommonPHP\Drivers\DriverManager;
use CommonPHP\Configuration\Drivers\PhpConfigurationDriver\PhpConfigurationDriver;

$driverManager = new DriverManager();
$driverManager->enable(PhpConfigurationDriver::class);

配置完成后,由于有 #[ConfigurationDriverAttribute('php')] 注解,PhpConfigurationDriver 将自动用于 .php 文件扩展名。

加载配置文件

$configManager->loadDriver(PhpConfigurationDriver::class);
$config = $configManager->get('path/to/configuration.php');

保存配置文件

按照上述方法加载驱动程序后,可以修改并将其保存回PHP文件

$config->data['newSection'] = ['newKey' => 'newValue'];
$config->save(); // Persists the changes to 'path/to/configuration.php'

异常处理

驱动程序包括针对常见问题的特定异常处理,例如

  • ConfigurationException:在PHP文件解析错误或文件格式不符合预期结构时抛出。
  • 通用异常:对于文件读写操作或解析失败。