【PHP8.x】parse_ini_file関数の使い方

Copy
1<?php
2
3// このスクリプトは、PHPの parse_ini_file 関数を使ってINIファイルを読み込む方法を示します。
4// INIファイルは、設定情報をキーと値のペアで保存するテキストファイルです。
5
6// 1. サンプルとなるINIファイルの内容を定義します。
7//    [セクション名] を使うことで、設定をグループ化できます。
8$iniContent = <<<INI
9; これはINIファイル内のコメントです。セミコロン(;)でコメントを開始します。
10
11[database]
12host = "localhost"
13user = "root"
14password = "mysecretpassword"
15port = 3306 ; 数値は自動的にPHPの数値型に変換されます
16enabled = true ; 'true', 'false', 'on', 'off', 'yes', 'no' は真偽値に変換されます
17
18[api]
19key = "abcdef12345"
20endpoint = "https://api.example.com/v1"
21timeout_seconds = 10
22INI;
23
24// 2. 定義したINIファイルの内容を一時ファイルに書き込みます。
25//    parse_ini_file 関数が実際に読み込めるファイルを用意するためです。
26$tempIniFile = tempnam(sys_get_temp_dir(), 'php_ini_example_'); // 一時ファイル名を作成
27
28if ($tempIniFile === false) {
29    echo "エラー: 一時ファイルの作成に失敗しました。\n";
30    exit(1);
31}
32
33if (file_put_contents($tempIniFile, $iniContent) === false) {
34    unlink($tempIniFile); // 失敗した場合でも一時ファイルを削除
35    echo "エラー: INIファイルの書き込みに失敗しました: " . $tempIniFile . "\n";
36    exit(1);
37}
38
39echo "一時INIファイルが作成されました: " . $tempIniFile . "\n\n";
40
41// --- parse_ini_file 関数の使用例 ---
42
43// parse_ini_file 関数は、INIファイルを解析し、その設定を配列として返します。
44// 引数:
45//   $filename           : 読み込むINIファイルのパス。
46//   $process_sections   : trueの場合、セクション名も処理し、多次元配列で返します。
47//                         false (デフォルト) の場合、セクションを無視し、フラットな配列で返します。
48//   $scanner_mode       : 解析モード。INI_SCANNER_NORMAL (デフォルト) や INI_SCANNER_TYPED などがあります。
49//                         INI_SCANNER_TYPED は文字列ではない値 (true/false, 数値など) を適切なPHPの型に変換します。
50
51// 例1: セクションを処理しない場合 (process_sections = false)
52//      すべての設定が単一の配列としてフラットに返されます。
53//      異なるセクションに同じキーがある場合、最後の値が優先されます。
54echo "--- セクションを処理しない場合 (process_sections = false) ---\n";
55$configNoSections = parse_ini_file($tempIniFile, false, INI_SCANNER_TYPED);
56
57if ($configNoSections === false) {
58    echo "エラー: INIファイルの解析に失敗しました (セクションなし)。\n";
59} else {
60    echo "解析結果:\n";
61    print_r($configNoSections);
62    echo "database.host の値: " . ($configNoSections['host'] ?? 'N/A') . "\n";
63    echo "api.key の値: " . ($configNoSections['key'] ?? 'N/A') . "\n";
64    echo "database.port の型: " . gettype($configNoSections['port']) . "\n"; // INI_SCANNER_TYPEDにより整数型
65}
66echo "\n";
67
68// 例2: セクションを処理する場合 (process_sections = true)
69//      セクション名がキーとなる多次元配列として返されます。
70echo "--- セクションを処理する場合 (process_sections = true) ---\n";
71$configWithSections = parse_ini_file($tempIniFile, true, INI_SCANNER_TYPED);
72
73if ($configWithSections === false) {
74    echo "エラー: INIファイルの解析に失敗しました (セクションあり)。\n";
75} else {
76    echo "解析結果:\n";
77    print_r($configWithSections);
78
79    // 特定のセクションや値へのアクセス例
80    echo "\n[database] セクションから 'host' を取得: " . ($configWithSections['database']['host'] ?? 'N/A') . "\n";
81    echo "[api] セクションから 'key' を取得: " . ($configWithSections['api']['key'] ?? 'N/A') . "\n";
82    echo "[database] セクションから 'port' を取得: " . ($configWithSections['database']['port'] ?? 'N/A') . "\n";
83    echo "database.port の型: " . gettype($configWithSections['database']['port']) . "\n"; // INI_SCANNER_TYPEDにより整数型
84}
85echo "\n";
86
87
88// 4. 使用済みの一時ファイルを削除します。
89//    これにより、スクリプト実行後に不要なファイルが残りません。
90if (unlink($tempIniFile)) {
91    echo "一時INIファイルが削除されました: " . $tempIniFile . "\n";
92} else {
93    echo "一時INIファイルの削除に失敗しました: " . $tempIniFile . "\n";
94}
95
96?>

PHPのparse_ini_file関数は、INI形式の設定ファイルを読み込み、その内容をPHPの配列として解析する際に使用されます。INIファイルは、キーと値のペアで設定情報を保存するテキストファイルで、プログラムの設定管理によく用いられます。

この関数は、最初の引数$filenameに指定されたINIファイルのパスを解析します。2番目の引数$process_sectionsは、INIファイル内のセクション（[database]のような見出し）をどのように扱うかを制御します。false（デフォルト）を設定するとセクションを無視して設定をフラットな一次元配列として返し、trueを設定するとセクション名がキーとなる多次元配列として設定をグループ化して返します。

3番目の引数$scanner_modeには、解析モードを指定します。INI_SCANNER_TYPEDを指定すると、INIファイル内のtrue/falseや数値などの値を、PHPの適切な型（真偽値、整数など）に自動的に変換してくれます。

関数がINIファイルの解析に成功した場合、設定情報を格納した配列を返します。しかし、ファイルが見つからないなどのエラーが発生した場合は、falseを返しますので、戻り値の確認は重要です。この関数を利用することで、外部の設定ファイルをPHPスクリプトで簡単に扱えるようになります。

Copy
1<?php
2
3/**
4 * INIファイルをパースし、セクションを含む多次元配列として取得するサンプルコード。
5 *
6 * `parse_ini_file` 関数の第2引数に `true` を指定することで、
7 * INIファイルのセクションをトップレベルのキーとする多次元配列を生成します。
8 */
9function parseIniFileMultidimensionalExample(): void
10{
11    // 一時的なINIファイル名
12    $iniFilename = 'config.ini';
13
14    // INIファイルの内容を定義。
15    // [database] や [api_settings] のようなセクションが多次元配列のトップレベルのキーになります。
16    $iniContent = <<<INI
17; アプリケーションの設定例
18
19[database]
20host = localhost
21port = 3306
22username = root
23password = secure_password123
24
25[api_settings]
26base_url = https://api.example.com/v1
27api_key = abcdef123456
28timeout_seconds = 30
29INI;
30
31    // 単体で動作可能なサンプルとするため、INIファイルをスクリプト実行時に生成します。
32    if (file_put_contents($iniFilename, $iniContent) === false) {
33        echo "エラー: INIファイルの書き込みに失敗しました。\n";
34        return;
35    }
36
37    echo "INIファイル '{$iniFilename}' を作成しました。\n\n";
38
39    // `parse_ini_file` 関数を使用してINIファイルをパースします。
40    // 第2引数に `true` を指定することで、セクション名がトップレベルのキーとなる
41    // 多次元配列として結果を返します。これが `multidimensional array` の実現方法です。
42    $config = parse_ini_file($iniFilename, true);
43
44    // パースが成功したかを確認します。失敗した場合は `false` が返されます。
45    if ($config === false) {
46        echo "エラー: INIファイルのパースに失敗しました。\n";
47    } else {
48        echo "INIファイルの内容を多次元配列としてパースしました:\n";
49        // 結果の配列を読みやすい形式で出力します。
50        print_r($config);
51
52        // パースされた多次元配列から特定の設定値へアクセスする例です。
53        echo "\n--- 特定の設定値へのアクセス例 ---\n";
54        echo "データベースホスト: " . ($config['database']['host'] ?? '未設定') . "\n";
55        echo "APIベースURL: " . ($config['api_settings']['base_url'] ?? '未設定') . "\n";
56        echo "APIタイムアウト: " . ($config['api_settings']['timeout_seconds'] ?? '未設定') . "秒\n";
57    }
58
59    // サンプルの実行後、作成したINIファイルを削除します。
60    // 必要に応じてこの行をコメントアウトして、生成されたファイルを確認できます。
61    if (file_exists($iniFilename)) {
62        unlink($iniFilename);
63        echo "\nINIファイル '{$iniFilename}' を削除しました。\n";
64    }
65}
66
67// 関数を実行します。
68parseIniFileMultidimensionalExample();

PHPのparse_ini_file関数は、設定情報を記述するINI形式のファイルをPHPの配列に変換するために利用されます。INIファイルは[セクション名]とキー=値の形式で構成されるシンプルなテキストファイルで、アプリケーションの設定管理によく用いられます。

この関数は、第1引数にINIファイルのパスを受け取ります。最も重要な点として、第2引数にtrueを指定することで、INIファイル内の[セクション名]をトップレベルのキーとする**多次元配列（multidimensional array）**として設定情報を取得できます。例えば、[database]セクション内のhost=localhostという設定は、PHPの配列では['database']['host']としてアクセス可能になります。この機能は、設定を論理的なグループに分けて管理する際に大変便利です。

処理が成功した場合、パースされたINIファイルの内容が連想配列として返されます。もしファイルが見つからない、またはパースに失敗した場合はfalseが戻り値となるため、エラーハンドリングのために戻り値を確認することが推奨されます。

サンプルコードでは、一時的にconfig.iniファイルを作成し、parse_ini_fileに第2引数としてtrueを渡して実行しています。これにより、[database]や[api_settings]といったINIファイルのセクションが、PHPの配列のキーとなり、それぞれのセクション内の設定がさらにその下の階層の配列に格納される多次元配列として出力される様子が示されています。これにより、$config['database']['host']のように簡潔な記述で特定の設定値にアクセスできることを確認できます。