geeksareforlife / config
一个简单的配置库
0.1.1
2018-10-04 21:11 UTC
Requires
- php: ^5.3.3 || ^7.0
- kherge/json: ^2.0
README
一个简单的配置库
此库将配置存储在两个文件中 - 一个正常配置文件和一个默认文件。
当从配置中检索值时,首先检查正常配置,如果未找到任何内容,则使用默认文件中的值。
入门
安装 Composer 并运行以下命令以获取最新版本
composer require "geeksareforlife/config:^0.1"
基本用法
首先,创建一个配置对象并加载文件(如果文件不存在,则会创建文件)
$config = new Config();
$config->load('/path/to/config.json', '/path/to/defaultConfig.json');
然后,您可以将值设置到配置对象中。键是点分隔的。
$value = $config->getValue('key.name');
$config->setValue('key.name', $value);
完成操作后,您需要调用保存函数以将配置提交到磁盘。
$config->save();
更多信息
值可以存储在两个配置文件中。每个文件都是一个单独的JSON对象。
键使用点表示法,每个键可以有一个可选的“模块”。这允许您在系统不同区域使用相同的键。
加载配置文件
创建配置对象后,您需要加载两个配置文件。配置文件需要可写,如果文件不存在,则会创建文件。
获取值
getValue
函数返回给定键的值
getValue(string $key, [string $module]);
如果键在配置文件中找到,则返回该值。如果没有找到,则检查默认文件,如果可用,则返回该值。
如果键在两个文件中都没有找到,函数将返回 false
设置值
setValue
函数的行为与 getValue
非常相似
setValue(string $key, mixed $value, [string $module]);
值仅存储在配置中 - 默认值永远不会被更改。
此时,文件本身不会保存,值仅在内存中存储。
保存配置
save
函数将内存中的配置保存到配置文件。