配置文件管理类

doitphp 2020-03

常量,私有属性配置

const PATH_FORMAT = 'path';
const GET_FORMAT  = 'get';
/*
 * 视图格式
 *
 * @var string
 */
const VIEW_EXT_HTML = '.html';
const VIEW_EXT_PHP  = '.php';
/**
 * 项目配置文件内容临时存贮数组
 *
 * @var array
 */
private static $_config = array();
/**
 * 应用配置文件内容存贮数组
 *
 * @var array
 */
private static $_data = array();
/**
 * 类方法:loadConfig()调用状态。如果调用则为true，反之为false。
 *
 * @var boolean
 */
private static $_isStart = false;

加载应用配置文件

public static function loadConfig($filePath = null)

public static function loadConfig($filePath = null) {
    //判断本方法是否被调用过，如果调用过，则直接返回。
    if (self::$_isStart == true) {
        return true;
    }
    //获取应用配置文件内容默认值
    $defaultConfig = self::_getDefaultConfig();
    $config = array();
    //当配置文件路径存在时
    if ($filePath) {
        //分析配置文件是否存在
        if (!is_file($filePath)) {
            Response::halt('The configuration file: ' . $filePath . ' is not found!');
        }
        //获取应用配置文件内容
        include_once $filePath;
        //应用配置文件内容的默认值与配置文件值进行整合
        $config['application'] = (isset($config['application']) && is_array($config['application'])) ? $config['application'] + $defaultConfig : $defaultConfig;
    } else {
        $config['application'] = $defaultConfig;
    }
    self::$_data  = $config;
    self::$_isStart = true;
    return true;
}

• 状态判断避免重复执行浪费
• 调用默认配置方法
• 加载配置文件
• 合并加载的配置数组和默认的配置数组
• 存储配置数组
• 修改已加载标志

获取参数值

public static function get($key)

public static function get($key) {
    //分析参数
    if (!$key) {
        return false;
    }
    if (strpos($key, '.') === false) {
        if (!isset(self::$_data[$key])) {
            return false;
        }
        return self::$_data[$key];
    }
    $keyArray = explode('.', $key);
    $value = false;
    if ($keyArray) {
        foreach ($keyArray as $keyId=>$keyName) {
            if ($keyId == 0) {
                if (!isset(self::$_data[$keyName])) {
                    $value = false;
                    break;
                }
                $value = self::$_data[$keyName];
            } else {
                if (!isset($value[$keyName])) {
                    $value = false;
                    break;
                }
                $value = $value[$keyName];
            }
        }
    }
    return $value;
}

• 这里的foreach用的很巧妙,配置多层参数都没有问题

获取项目配置文件内容

public static function getConfig($fileName)

public static function getConfig($fileName) {
    //参数分析.
    if (!$fileName) {
        return false;
    }
    if (!isset(self::$_config[$fileName])) {
        $filePath = BASE_PATH . '/config/' . $fileName . '.php';
        //判断文件是否存在
        if (!is_file($filePath)) {
            Response::halt('The configuration file: ' . $fileName . '.php is not exists!');
        }
        $config = array();
        include_once $filePath;
        self::$_config[$fileName] = $config;
    }
    return self::$_config[$fileName];
}

• 加载项目配置文件

获取应用配置文件的默认值

private static function _getDefaultConfig()

private static function _getDefaultConfig() {
    //定义变量$defaultConfig
    $defaultConfig = array();
    //设置应用目录(application)的路径
    $defaultConfig['basePath']            = APP_ROOT . '/application';
    //设置缓存目录的路径
    $defaultConfig['cachePath']           = APP_ROOT . '/cache';
    //设置日志目录的路径
    $defaultConfig['logPath']             = APP_ROOT . '/logs';
    //设置是否开启调试模式（开启后,程序运行出现错误时,显示错误信息,便于程序调试）
    $defaultConfig['debug']               = false;
    //设置日志写入功能是否开启
    $defaultConfig['log']                 = false;
    //设置路由网址的重写模式是否开启
    $defaultConfig['rewrite']             = false;
    //设置路由网址格式(path:为url路由格式；get:为标准普通url格式)
    $defaultConfig['urlFormat']           = self::PATH_FORMAT;
    //设置路由分割符
    $defaultConfig['urlSegmentation']     = '/';
    //设置默认controller及action名
    $defaultConfig['defaultController']   = 'Index';
    $defaultConfig['defaultAction']       = 'index';
    //设置时区，默认时区为东八区(中国)时区(Asia/ShangHai)。
    $defaultConfig['defaultTimeZone']     = 'Asia/ShangHai';
    //设置视图文件的格式(php或html, 默认为php)
    $defaultConfig['viewExt']             = self::VIEW_EXT_PHP;
    return $defaultConfig;
}

• 配置文件默认值