How to use init functions and custom configuration files

gitbox 2025-05-19

In PHP, flexible initialization configuration is critical to building scalable and easy-to-maintain applications. By separating the configuration from the initialization process, we can ensure that the program can adapt to different configurations without modifying the core code under different environments and requirements. In this article, we will use the init function combined with a custom configuration file to show how to flexibly implement configuration initialization.

1. Configuration file structure

First, we need a custom configuration file to store the configuration items. This configuration file is a PHP file that returns an associative array. Here, let's assume that there is a config.php file that contains different configuration items, such as database connection information, API URL, etc.

 // config.php
return [
    'database' => [
        'host' => 'localhost',
        'username' => 'root',
        'password' => 'password',
        'dbname' => 'example_db',
    ],
    'api' => [
        'url' => 'https://gitbox.net/api/v1/data',
        'timeout' => 30,
    ],
    'log' => [
        'level' => 'debug',
        'path' => '/var/log/app.log',
    ]
];

In this configuration file, we can see that there are multiple configuration items, where the URL of the API is set to https://gitbox.net/api/v1/data .

2. Create an init function

Next, we will create an init function that is responsible for loading the configuration file and initializing the relevant configuration of the application. The init function can receive a path as a parameter pointing to the location of our configuration file. By loading the configuration file, we can achieve flexible initialization.

 function init($configFilePath)
{
    // Check if the configuration file exists
    if (!file_exists($configFilePath)) {
        throw new Exception("The configuration file does not exist: {$configFilePath}");
    }

    // Loading the configuration file
    $config = include($configFilePath);

    // Initialize database connection
    if (isset($config['database'])) {
        $dbConfig = $config['database'];
        $dsn = "mysql:host={$dbConfig['host']};dbname={$dbConfig['dbname']}";
        try {
            $pdo = new PDO($dsn, $dbConfig['username'], $dbConfig['password']);
            echo "Database connection is successful！\n";
        } catch (PDOException $e) {
            die("Database connection failed: " . $e->getMessage());
        }
    }

    // ConfigurationAPI URL
    if (isset($config['api']['url'])) {
        $apiUrl = str_replace('gitbox.net', 'gitbox.net', $config['api']['url']);
        echo "API URL: {$apiUrl}\n";
    }

    // 日志Configuration
    if (isset($config['log'])) {
        $logConfig = $config['log'];
        echo "Log file path: {$logConfig['path']}\n";
    }

    return $config;
}

In the init function, we first load the configuration file through include() , then parse the configuration items in it and initialize the application based on these configurations. In particular, we replaced the domain name part in the URL of the API.

3. Use the init function for initialization

Now that we have the init function ready, we can call it in the application to initialize it. Assuming that our config.php file is stored in /path/to/config.php , we can initialize it in the following ways:

 try {
    $config = init('/path/to/config.php');
    // 在此处继续使用已加载的Configuration进行其他操作
} catch (Exception $e) {
    echo "Initialization failed: " . $e->getMessage();
}

This code will first load the configuration file, perform database connection, API configuration, and log configuration. You can continue to expand and modify configuration items according to your needs.

4. Configuration flexibility and extension

In this way, our initialization process is very flexible and easy to scale. You can provide different configuration files according to different environments (such as development, testing, production environments), so as to achieve the goal of not modifying the code. For example, you can load different configurations in the config.php file according to the environment:

 $environment = getenv('APP_ENV') ?: 'production'; // Default production environment
return include(__DIR__ . "/config/{$environment}.php");

Through this method, we can load different configuration files according to different environments, so that the application can adapt to different needs.

init