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

Copy
1<?php
2
3/**
4 * parse_ini_string関数の基本的な使い方を示すサンプルコードです。
5 * この関数は、INI形式の文字列をPHPの連想配列に変換するために使用されます。
6 * システムエンジニアを目指す初心者向けに、設定ファイルをメモリ上で扱う方法を解説します。
7 */
8
9// INI形式の文字列を定義します。
10// 実際には、この文字列はファイルから読み込まれることが多いですが、ここでは直接記述します。
11$iniString = <<<INI
12; これはコメントです。INIパーサーによって無視されます。
13
14[database]
15host = "localhost"
16port = 3306
17user = "root"
18password = "mysecretpassword"
19; キー 'port' は整数として、'password' は文字列として解釈されます。
20
21[app_settings]
22debug_mode = On
23max_items = 100
24app_name = "My Awesome App"
25base_url = "https://example.com"
26; 'On' はブール値の true に、'max_items' は整数に、'app_name' と 'base_url' は文字列として解釈されます。
27INI;
28
29echo "--- 元のINI文字列 ---" . PHP_EOL;
30echo $iniString . PHP_EOL . PHP_EOL;
31
32// 1. セクションを処理する場合（第二引数に true を指定）
33// これが最も一般的な使用方法で、INIファイルのセクション（例: [database]）を
34// 配列のトップレベルのキーとして扱います。
35echo "--- パース結果 (セクションを処理する場合: 第二引数 'true') ---" . PHP_EOL;
36$configWithSections = parse_ini_string($iniString, true);
37
38// パース結果が正常に配列として返されたかを確認します。
39// エラーが発生した場合（INI文字列の形式が不正など）は false が返されます。
40if ($configWithSections !== false) {
41    // 結果の配列を分かりやすく整形して表示します。
42    print_r($configWithSections);
43
44    echo PHP_EOL;
45
46    // パースされた設定値にアクセスする例:
47    echo "データベースホスト: " . $configWithSections['database']['host'] . PHP_EOL;
48    echo "アプリケーション名: " . $configWithSections['app_settings']['app_name'] . PHP_EOL;
49    echo "デバッグモード有効? " . ($configWithSections['app_settings']['debug_mode'] ? 'はい' : 'いいえ') . PHP_EOL;
50} else {
51    echo "INI文字列のパースに失敗しました。(セクション処理あり)" . PHP_EOL;
52}
53
54echo PHP_EOL . "--- パース結果 (セクションを処理しない場合: 第二引数 'false') ---" . PHP_EOL;
55// 2. セクションを処理しない場合（第二引数に false を指定）
56// この場合、セクションは無視され、すべてのキーと値が一次元の連想配列としてパースされます。
57// 同じキー名が複数のセクションに存在する場合、後から出現した値で上書きされます。
58// 今回の例ではキーが重複していないため、すべてのキーがフラットに並びます。
59$configWithoutSections = parse_ini_string($iniString, false);
60
61if ($configWithoutSections !== false) {
62    print_r($configWithoutSections);
63    echo PHP_EOL;
64    // セクションなしでアクセスする例:
65    // セクションが無視されるため、直接キー名でアクセスします。
66    echo "データベースユーザー: " . $configWithoutSections['user'] . PHP_EOL; // 'database' セクションの 'user'
67    echo "最大アイテム数: " . $configWithoutSections['max_items'] . PHP_EOL; // 'app_settings' セクションの 'max_items'
68} else {
69    echo "INI文字列のパースに失敗しました。(セクション処理なし)" . PHP_EOL;
70}
71
72?>

PHPのparse_ini_string関数は、INI形式の文字列をPHPの連想配列に変換するために使用されます。この関数を活用することで、システムの設定情報やアプリケーションの構成などを、メモリ上で手軽に扱い、動的に変更することが可能になります。

関数には、まずINI形式のテキストを$string引数として渡します。2番目の引数$process_sectionsはブール値で、trueを指定すると、INIファイル内の[database]のようなセクションが連想配列のトップレベルのキーとして処理され、そのセクション内のキーと値がさらにサブ配列として格納されます。これにより、設定情報をグループごとに整理して扱うことができます。一方、falseを指定するとセクションは無視され、すべてのキーと値がフラットな一次元の連想配列として変換されます。

関数が正常に処理を完了すると、変換された連想配列が戻り値として返されます。しかし、渡されたINI文字列の形式が不正であるなど、パースに失敗した場合にはfalseが返されるため、戻り値がfalseでないかを確認する処理は重要です。サンプルコードでは、$process_sectionsをtrueにした場合とfalseにした場合のそれぞれのパース結果と、それらの配列から設定値にアクセスする方法を具体的に示しています。