README

PHP库，用于简单的配置管理 -- 由Chris Kankiewicz (@PHLAK)创建

简介

Config是一个简单的PHP配置管理库，支持多种配置文件格式和丰富的API。

支持的文件格式

PHP
INI
JSON
TOML
YAML
XML

需求

PHP >= 7.1

使用Composer安装

composer require phlak/config

初始化客户端

首先，导入Config

use PHLAK\Config\Config;

然后实例化类

$config = new Config($context, $prefix = null);

其中$context可以是以下之一

支持文件类型的路径
包含一个或多个支持文件类型的目录路径
配置选项的数组

$prefix是用于此Config对象选项的键前缀的字符串。

配置文件格式

PHP

PHP配置文件必须有.php文件扩展名，是有效的PHP文件，并返回有效的PHP数组。

示例PHP文件

<?php

return [
    'driver' => 'mysql',
    'drivers' => [
        'sqlite' => [
            'database' => 'database.sqlite',
            'prefix' => ''
        ],
        'mysql' => [
            'host' => 'localhost',
            'database' => 'blog',
            'username' => 'blogger',
            'password' => 'hunter2',
            'charset' => 'utf8',
            'prefix' => ''
        ]
    ]
];

INI

INI配置文件必须有.ini文件扩展名，是有效的INI文件。

示例INI文件

driver = mysql

[drivers]

sqlite[database] =  database.sqlite
sqlite[prefix] =

mysql[host] = localhost
mysql[database] = blog
mysql[username] = blogger
mysql[password] = hunter2
mysql[charset] = utf8
mysql[prefix] =

JSON

JSON配置文件必须有.json文件扩展名，包含有效的JSON对象。

示例JSON文件

{
    "driver": "mysql",
    "drivers": {
        "sqlite": {
            "database": "database.sqlite",
            "prefix": ""
        },
        "mysql": {
            "host": "localhost",
            "database": "blog",
            "username": "blogger",
            "password": "hunter2",
            "charset": "utf8",
            "prefix": ""
        }
    }
}

TOML

TOML配置文件必须有.toml文件扩展名，是有效的TOML文件。

示例TOML文件

driver = 'mysql'

[drivers.sqlite]
database = 'database.sqlite'
prefix = ''

[drivers.mysql]
host = 'localhost'
database = 'blog'
username = 'blogger'
password = 'hunter2'
charset = 'utf8'
prefix = ''

YAML

YAML配置文件必须有.yaml文件扩展名，是有效的YAML文件。

示例YAML文件

driver: mysql

drivers:

  sqlite:
    database: database.sqlite
    prefix:

  mysql:
    host: localhost
    database: blog
    username: blogger
    password: hunter2
    charset: utf8
    prefix:

XML

XML配置文件必须有.xml文件扩展名，包含有效的XML。

示例XML文件

<?xml version='1.0'?>

<database>
    <driver>mysql</driver>
    <drivers>
        <sqlite>
            <database>database.sqlite</database>
            <prefix></prefix>
        </sqlite>
        <mysql>
            <host>localhost</host>
            <database>blog</database>
            <username>blogger</username>
            <password>hunter2</password>
            <charset>utf8</charset>
            <prefix></prefix>
        </mysql>
    </drivers>
</database>

用法

__construct

创建一个新的Config对象。

Config::__construct( mixed $context [, string $prefix = null ] ) : Config

$context: 配置选项的原始数组或配置文件或包含一个或多个配置文件的目录的路径
$prefix: 加载的配置将嵌套的键

示例

从YAML文件创建一个新的Config对象。

$config = new Config('path/to/conifg.yaml');

从配置文件目录创建一个新的Config对象。

$config = new Config('path/to/conifgs/');

从数组创建一个新的Config对象。

$config = new Config([
    'hostname' => 'localhost',
    'port' => 12345
]);

set

使用指定的键存储配置值。

Config::set( string $key, mixed $value ) : bool

$key: 唯一的配置选项键
$value: 配置项值

示例

$config->set('hostname', 'localhost');
$config->set('port', 12345);

get

通过提供的键检索配置选项。

Config::get( string $key [, mixed $default = null ] ) : mixed

$key: 唯一的配置选项键
$value: 配置项值

示例

// Return the hostname option value or null if not found.
$config->get('hostname');

定义在未设置选项时返回的默认值。

// Returns 'localhost' if hostname option is not set
$config->get('hostname', 'localhost');

has

检查配置项是否存在。

Config::has( string $key ) : bool

$key: 唯一的配置选项键

示例

$config = new Config([
    'hostname' => 'localhost'
]);

$config->has('hostname'); // Returns true
$config->has('port');     // Returns false

append

将值附加到现有的数组配置选项。

Config::append( string $key, mixed $value ) : bool

$key: 唯一的配置选项键
$value: 配置项值

示例

将baz附加到tags配置项数组。

$config->set('tags', ['foo', 'bar'])
$config->append('tags', 'baz'); // ['foo', 'bar', 'baz']

prepend

将值预先附加到现有的数组配置选项。

Config::append( string $key, mixed $value ) : bool

$key: 唯一的配置选项键
$value: 配置项值

示例

将baz预先附加到tags配置项数组。

$config->set('tags', ['foo', 'bar'])
$config->append('tags', 'baz'); // ['baz', 'foo', 'bar']

unset

通过提供的键删除配置选项。

Config::unset( string $key ) : bool

$key: 唯一的配置选项键

示例

$config->unset('hostname');

load

从文件或目录加载配置选项。

Config::load( string $path [, string $prefix = null [, bool $override = true ]] ) : self

$path: 配置文件或目录的路径
$prefix: 加载的配置将嵌套的键
$override: 是否用加载文件中的值覆盖现有选项

示例

加载单个附加文件。

$conifg->load('path/to/config.php');

加载具有前缀的附加文件。

$config->load('databaes.php', 'database');

加载附加文件，不覆盖现有值。

$config->load('additional-options.php', null, false);

合并

将另一个 Config 对象合并到此对象中。

Config::merge( Config $config [, bool $override = true ] ) : self

$config: Config 实例
$override: 是否使用合并的配置对象的值覆盖现有选项

示例

将 $anotherConfig 合并到 $config，并用 $anotherConfig 的值覆盖 $config 中的值。

$anotherConfig = new Config('some/config.php');

$config->merge($anotherConfig);

将 $anotherConfig 合并到 $config，不覆盖任何值。在 $anotherConfig 中的重复值将被丢失。

$anotherConfig = new Config('some/config.php');

$config->merge($anotherConfig, false);

分割

将配置选项的子数组分割成它自己的 Config 对象。

Config::split( string $key ) : Config

$key: 唯一的配置选项键

示例

$config = new Config([
    'foo' => 'foo',
    'bar' => [
        'baz' => 'barbaz'
    ],
]);

$barConfig = $config->split('bar');

$barConfig->get('baz');  // Returns 'barbaz'

toArray

以数组形式返回整个配置。

Config::toArray( void ) : array

示例

$config = new Config(['foo' => 'foo']);

$config->toArray(); // Returns ['foo' => 'foo']

故障排除

有关一般帮助和支持，请加入我们的 GitHub 讨论区或在 Twitter 上联系我们。

请向 GitHub 问题跟踪器报告错误。

版权

本项目受 MIT 许可证许可。

phlak / config

维护者

详细信息