1.0_SimplifiedChinese.md

CodeMommy ConfigPHP 1.0 开发手册

CodeMommy ConfigPHP（以下简称ConfigPHP）是开源项目组织CodeMommy为PHP语言开发的配置文件加载库，可以直接读取各种类型的配置文件。

本开发手册适用于版本在0.0.1（包含）以上，2.0.0（不包含）以下的ConfigPHP。如果需要其他版本或语言的开发手册，请访问README文件。

目录

• 环境要求
• 安装
• 使用
  • 添加配置文件目录
  • 清除缓存
  • 读取配置文件

环境要求

• PHP >= 5.3.0

安装

ConfigPHP使用Composer进行包管理，我们推荐您使用此方法进行安装，您只需要在安装有Composer的环境下执行下面的命令并在入口文件引用Composer生成的autoload.php文件即可。

$ composer require codemommy/configphp 0.0.*

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

当然，您也可以使用传统的安装方式。直接访问此链接下载相应版本的压缩包，然后解压缩到您的项目目录。在需要使用ConfigPHP的地方，请引用autoload.php文件即可。

<?php
require_once '/path/CodeMommy/ConfigPHP/autoload.php';

另外，如果您需要读取除PHP之外的配置文件类型，您需要引用其他库，如下：

文件类型	常用扩展名	引用库
YAML	*.yaml *.yml	symfony/yaml

使用

在使用ConfigPHP之前都需要引用ConfigPHP的命名空间。

<?php
use CodeMommy\ConfigPHP\Config;

添加配置文件目录

通过Config类的静态方法addDirectory即可实现，此方法没有返回值。

参数：

参数名	类型	说明	默认值	其他
directory	String	配置文件所在的目录	'.'

例如：

<?php
Config::addDirectory('/path/config');

声明：

<?php
/**
 * Add Directory
 * @param string $directory
 * @return mixed
 */
public static function addDirectory($directory = '.');

清除缓存

为了提升运行效率，默认情况下，ConfigPHP会把读取的数据缓存。如果您需要清除缓存，您可以通过Config类的静态方法clearCache即可实现，此方法没有返回值和任何参数。

例如：

<?php
Config::clearCache();

声明：

<?php
/**
 * Clear Cache
 * @return mixed
 */
public static function clearCache();

读取配置文件

通过Config类的静态方法get即可实现，此方法将返回读取配置文件的内容。

参数：

参数名	类型	说明	默认值	其他
key	String	配置文件KEY	''	格式：不带扩展名的文件名.一级KEY.二级KEY...
default	Mixed	默认值	null	如果无法获取到配置文件内容，默认返回值

PHP配置文件示例：

<?php
// File /path/config/mysql.php
return array(
    'port' => 3306
);

读取配置文件内容示例：

<?php
Config::addDirectory('/path/config');
$port = Config::get('mysql.port', 3306);

声明：

<?php
/**
 * Get
 * @param string $key
 * @param mixed $default
 * @return mixed
 */
public static function get($key = '', $default = null);