【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']のように簡潔な記述で特定の設定値にアクセスできることを確認できます。

Copy
1<?php
2
3/**
4 * parse_ini_file 関数の使用方法と、特に「not working」と
5 * 感じられる状況（エラー発生時）への対処法を示すデモンストレーション関数です。
6 *
7 * この関数は、設定ファイル (INI形式) を読み込み、その内容をパースします。
8 * ファイルが存在しない、読み取り権限がない、INI形式が不正などの場合に
9 * parse_ini_file が false を返すことを示し、その際の適切なエラーハンドリングを提示します。
10 */
11function demonstrateParseIniFile(): void
12{
13    // デモンストレーション用に一時的なINIファイルを作成します。
14    // 実際のシステムでは、このファイルは通常、手動で作成され、アプリケーションの実行前に存在しています。
15    $iniFilename = 'my_application_config.ini';
16    $iniContent = <<<INI
17; これはINI形式のコメントです。セミコロン(;)またはハッシュ(#)で始まります。
18
19[database]
20host = localhost
21port = 3306
22username = db_user
23password = "super-secret-password-with-special-chars!@#" ; 値にスペースや特殊文字が含まれる場合は、ダブルクォートで囲むことができます。
24
25[application]
26environment = development
27debug_mode = On ; "On", "Off", "True", "False", "Yes", "No" は論理値 (true/false) に変換されます。
28max_connections = 100 ; 数値は整数に変換されます。
29timeout_seconds = 30.5 ; 小数点を含む数値は浮動小数点数に変換されます。
30INI;
31
32    // INIファイルを書き込みます。
33    if (file_put_contents($iniFilename, $iniContent) === false) {
34        echo "エラー: デモンストレーション用のINIファイル '{$iniFilename}' の作成に失敗しました。パーミッションを確認してください。\n";
35        return;
36    }
37    echo "INIファイル '{$iniFilename}' を作成しました。\n\n";
38
39    // --- parse_ini_file の基本的な使用例 ---
40
41    echo "--- 1. セクションを考慮せずにINIファイルをパースする場合 (デフォルト動作) ---\n";
42    // 第2引数を省略するか false を指定すると、すべての設定が1つの連想配列に格納されます。
43    // 異なるセクションに同じキーが存在する場合、後から定義された値が優先されます。
44    $configFlat = parse_ini_file($iniFilename);
45
46    if ($configFlat === false) {
47        // parse_ini_file が false を返した場合、ファイルが見つからない、
48        // 読み取り権限がない、またはINI形式が不正である可能性があります。
49        echo "エラー: INIファイル '{$iniFilename}' のパースに失敗しました（フラットモード）。\n";
50        echo "  考えられる原因: ファイルが存在しない、読み取り権限がない、INI形式が不正。\n";
51    } else {
52        echo "パース結果 (フラット):\n";
53        print_r($configFlat);
54        // パースされた値へのアクセス例
55        echo "  データベースホスト: " . ($configFlat['host'] ?? 'N/A') . "\n";
56        echo "  デバッグモード: " . ($configFlat['debug_mode'] ? '有効' : '無効') . "\n";
57    }
58    echo "\n";
59
60    echo "--- 2. セクションを考慮してINIファイルをパースする場合 ---\n";
61    // 第2引数に true を指定すると、セクション名が最上位のキーとなる多次元連想配列としてパースされます。
62    $configSections = parse_ini_file($iniFilename, true);
63
64    if ($configSections === false) {
65        echo "エラー: INIファイル '{$iniFilename}' のパースに失敗しました（セクションモード）。\n";
66        echo "  考えられる原因: ファイルが存在しない、読み取り権限がない、INI形式が不正。\n";
67    } else {
68        echo "パース結果 (セクションあり):\n";
69        print_r($configSections);
70        // パースされた値へのアクセス例 (多次元配列)
71        echo "  データベースホスト: " . ($configSections['database']['host'] ?? 'N/A') . "\n";
72        echo "  アプリケーション環境: " . ($configSections['application']['environment'] ?? 'N/A') . "\n";
73        echo "  デバッグモード: " . ($configSections['application']['debug_mode'] ? '有効' : '無効') . "\n";
74    }
75    echo "\n";
76
77    // --- 「not working」シナリオのデモンストレーション ---
78
79    echo "--- 3. 存在しないファイルを指定した場合 ---\n";
80    $nonExistentFile = 'non_existent_config.ini';
81    $configNonExistent = parse_ini_file($nonExistentFile);
82
83    if ($configNonExistent === false) {
84        echo "期待されるエラー: '{$nonExistentFile}' の parse_ini_file は false を返しました。\n";
85        // ファイルが存在しないことを確認する追加チェック
86        if (!file_exists($nonExistentFile)) {
87            echo "  原因: ファイル '{$nonExistentFile}' が見つかりません。\n";
88        } else {
89            // ここに到達することは稀ですが、到達すれば読み取り権限の問題などが考えられます。
90            echo "  原因: ファイル '{$nonExistentFile}' は存在するものの、読み取り権限がない、または他のシステムエラーが発生しました。\n";
91        }
92    } else {
93        echo "予期せぬ結果: '{$nonExistentFile}' の parse_ini_file は値を返しました (通常は発生しません)。\n";
94        print_r($configNonExistent);
95    }
96    echo "\n";
97
98    // --- クリーンアップ ---
99    // デモンストレーション用に作成したファイルを削除します。
100    if (file_exists($iniFilename)) {
101        unlink($iniFilename);
102        echo "クリーンアップ: '{$iniFilename}' を削除しました。\n";
103    }
104}
105
106// 関数を実行してデモンストレーションを開始します。
107demonstrateParseIniFile();
108
109?>

PHPのparse_ini_file関数は、設定情報を記述するINI形式のファイルを読み込み、その内容をPHPの連想配列として解析（パース）するための関数です。

第一引数には読み込むINIファイルのパスを文字列で指定します。第二引数 $process_sections はオプションで、trueを設定するとINIファイル内のセクション（例: [database]）を最上位のキーとして扱い、多次元配列としてパースします。false（デフォルト）の場合はセクションを無視し、すべての設定項目を単一の連想配列として返します。第三引数 $scanner_mode もオプションで、構文解析のモードを指定しますが、通常はデフォルトのINI_SCANNER_NORMALを使用します。

この関数は、パースが成功した場合はINIファイルの内容を格納した連想配列を返しますが、ファイルが存在しない、読み取り権限がない、またはINIファイルの形式が不正であるなどの理由でパースに失敗した場合はfalseを返します。このfalseが返される状況が「parse_ini_file not working」と感じられる主な原因です。

サンプルコードでは、存在しないファイルを指定した場合にfalseが返される挙動と、その際にfile_existsなどでファイルの状態を確認するエラーハンドリングの方法を示しています。返り値がfalseでないか常に確認し、適切にエラーを処理することで、アプリケーションの安定性を高めることができます。INIファイル内の数値や真偽値は、PHPの対応する型に自動変換される特性も持ちます。

Copy
1<?php
2
3// INIファイルのパスを定義します。
4$iniFilePath = 'config.ini';
5
6// サンプルINIファイルの内容を定義します。
7// システム設定やアプリケーション設定によく利用されます。
8$iniContent = <<<INI
9; これはコメントです
10; 一般的な設定セクション
11[application]
12name = "My PHP App"
13version = "1.0.0"
14debug = true
15display_errors = false ; PHPの推奨コーディングスタイルに従い、小文字で記述
16
17; データベース設定セクション
18[database]
19host = "localhost"
20port = 3306
21username = "admin"
22password = "supersecretpassword"
23charset = "utf8mb4"
24
25; API設定セクション
26[api]
27endpoint = "https://api.example.com/v1"
28timeout_seconds = 15
29INI;
30
31/**
32 * parse_ini_file関数の利用例をデモンストレーションする関数です。
33 *
34 * @param string $filePath パースするINIファイルのパス。
35 * @param string $content 作成するINIファイルの内容。
36 */
37function demonstrateParseIniFile(string $filePath, string $content): void
38{
39    // 1. サンプルINIファイルを一時的に作成します。
40    // file_put_contentsはファイルへの書き込みを行い、成功した場合は書き込まれたバイト数を、
41    // 失敗した場合はfalseを返します。
42    if (file_put_contents($filePath, $content) === false) {
43        echo "エラー: INIファイル '{$filePath}' の作成に失敗しました。\n";
44        return;
45    }
46    echo "INIファイル '{$filePath}' を作成しました。\n\n";
47
48    // 2. セクションを処理せずにINIファイルをパースします。
49    // parse_ini_fileの第2引数にfalse（デフォルト値）を指定すると、
50    // セクションヘッダは無視され、すべてのキーがトップレベルの配列要素として格納されます。
51    // 同名のキーが存在する場合、最後の値が優先されます。
52    echo "--- セクションを処理しない場合のパース結果 ---\n";
53    $configFlat = parse_ini_file($filePath, false);
54
55    if ($configFlat === false) {
56        echo "エラー: セクションなしでINIファイルのパースに失敗しました。\n";
57    } else {
58        print_r($configFlat);
59    }
60    echo "\n";
61
62    // 3. セクションを処理してINIファイルをパースします。
63    // parse_ini_fileの第2引数にtrueを指定すると、
64    // 各セクションがトップレベルのキーとなり、その値としてセクション内のキーと値の配列が格納されます。
65    echo "--- セクションを処理する場合のパース結果 ---\n";
66    $configNested = parse_ini_file($filePath, true);
67
68    if ($configNested === false) {
69        echo "エラー: セクションありでINIファイルのパースに失敗しました。\n";
70    } else {
71        print_r($configNested);
72        echo "特定の値へのアクセス例 (データベースホスト): " . $configNested['database']['host'] . "\n";
73        echo "特定の値へのアクセス例 (APIエンドポイント): " . $configNested['api']['endpoint'] . "\n";
74    }
75    echo "\n";
76
77    // 4. セクションを処理し、値の型を自動判別してINIファイルをパースします。
78    // parse_ini_fileの第3引数にINI_SCANNER_TYPEDを指定すると、
79    // 'true', 'false', 'null'や数値（整数、浮動小数点数）がPHPの対応する型に変換されます。
80    // それ以外は文字列として扱われます。
81    echo "--- セクションと型スキャンを処理する場合のパース結果 ---\n";
82    $configTyped = parse_ini_file($filePath, true, INI_SCANNER_TYPED);
83
84    if ($configTyped === false) {
85        echo "エラー: セクションと型スキャンでINIファイルのパースに失敗しました。\n";
86    } else {
87        print_r($configTyped);
88        echo "型変換の例 (debug): " . (gettype($configTyped['application']['debug'])) . " (値: " . ($configTyped['application']['debug'] ? 'true' : 'false') . ")\n";
89        echo "型変換の例 (timeout_seconds): " . (gettype($configTyped['api']['timeout_seconds'])) . " (値: " . $configTyped['api']['timeout_seconds'] . ")\n";
90    }
91    echo "\n";
92
93    // 5. 使用したINIファイルを削除してクリーンアップします。
94    if (unlink($filePath)) {
95        echo "INIファイル '{$filePath}' を削除しました。\n";
96    } else {
97        echo "エラー: INIファイル '{$filePath}' の削除に失敗しました。手動で削除してください。\n";
98    }
99}
100
101// 関数の実行
102demonstrateParseIniFile($iniFilePath, $iniContent);
103
104?>

parse_ini_file関数は、システムやアプリケーションの設定を記述する際によく用いられるINIファイルを解析し、その内容をPHPの連想配列として読み込むために使用されます。この関数の第1引数には、読み込みたいINIファイルのパスを文字列で指定します。

第2引数$process_sectionsにfalse（デフォルト値）を指定した場合、INIファイル内のセクション（例: [application]）は無視され、すべての設定キーと値が単一のフラットな配列として格納されます。もしINIファイル内で同じキー名が複数回現れる場合、最後に登場した値が優先されます。一方、trueを指定すると、INIファイルの各セクションがトップレベルのキーとなり、そのセクション内の設定がさらにネストされた配列として格納されます。

第3引数$scanner_modeにINI_SCANNER_TYPEDを指定すると、INIファイル内のtrue、false、null、および数値（整数や浮動小数点数）が、PHPの対応するデータ型に自動的に変換されます。この引数を省略するか、INI_SCANNER_NORMALを指定した場合は、すべての値が文字列として読み込まれます。

この関数は、INIファイルの解析に成功した場合、その内容を表す配列を返します。しかし、ファイルが見つからない、または読み込みに失敗した場合はfalseを返しますので、エラーハンドリングを行うことが重要です。サンプルコードでは、セクションの有無や型スキャンの違いによるパース結果の具体的な例が示されており、設定ファイルから柔軟に情報を読み込む方法を理解できます。