【PHP8.x】INI_SCANNER_TYPED定数の使い方

Copy
1<?php
2
3/**
4 * INI_SCANNER_TYPED と INI_SCANNER_RAW の違いを比較するサンプルコードです。
5 *
6 * INI_SCANNER_TYPED は、INI ファイルの値を適切な PHP の型（整数、浮動小数点数、ブール値など）に変換します。
7 * INI_SCANNER_RAW は、INI ファイルの値をすべて文字列として扱います。
8 *
9 * システムエンジニアを目指す初心者向けに、それぞれの定数を使った際の結果の違いを具体的に示します。
10 */
11
12// 比較のために使用するINIファイルの内容を文字列として定義します。
13// 様々な型の値を含めることで、型変換の違いを明確にします。
14$iniContent = <<<INI
15; 設定項目
16[database]
17host = "localhost" ; 文字列
18port = 3306 ; 整数
19enabled = true ; ブール値 (true/on/yes/1)
20
21[application]
22name = "MyApplication" ; 文字列
23version = 1.0 ; 浮動小数点数
24debug_mode = Off ; ブール値 (false/off/no/0)
25zero_value = 0 ; 整数 (文字列 '0' も含む)
26one_value = 1 ; 整数 (文字列 '1' も含む)
27string_numeric = "123" ; 文字列として定義された数値
28INI;
29
30echo "--- INI_SCANNER_TYPED を使用した場合の解析結果 ---" . PHP_EOL;
31echo "  値がPHPの適切な型（整数、浮動小数点数、ブール値）に変換されます。" . PHP_EOL;
32
33// parse_ini_string 関数で INI_SCANNER_TYPED を指定して解析します。
34// 第2引数の true は、セクションを多次元配列として処理することを意味します。
35$typedConfig = parse_ini_string($iniContent, true, INI_SCANNER_TYPED);
36
37// 結果を表示し、各値の型を確認します。
38var_dump($typedConfig);
39echo PHP_EOL;
40
41echo "--- INI_SCANNER_RAW を使用した場合の解析結果 ---" . PHP_EOL;
42echo "  すべての値が文字列として扱われます。型変換は行われません。" . PHP_EOL;
43
44// parse_ini_string 関数で INI_SCANNER_RAW を指定して解析します。
45$rawConfig = parse_ini_string($iniContent, true, INI_SCANNER_RAW);
46
47// 結果を表示し、すべての値が文字列型になっていることを確認します。
48var_dump($rawConfig);
49

PHPのINI_SCANNER_TYPEDは、INI形式の設定ファイルを解析する際に、値をPHPの適切なデータ型（整数、浮動小数点数、ブール値など）に自動的に変換するための特別な定数です。この定数自体には引数や戻り値はありませんが、parse_ini_stringのような関数に指定することで、その関数の動作を制御します。

サンプルコードでは、まずINIファイルの内容を模した文字列を定義し、異なるデータ型の値を含めています。INI_SCANNER_TYPEDを指定してparse_ini_string関数を使用すると、例えばport = 3306は整数型に、enabled = trueは真偽値のtrueに変換されて取得されます。これにより、プログラム内でこれらの値を直接数値や真偽値として利用できるため、型変換の手間が省け、コードが簡潔になります。

一方、INI_SCANNER_RAWを指定した場合は、すべての値が文字列として解析されます。3306は"3306"という文字列に、trueは"true"という文字列として扱われます。サンプルコードのvar_dump出力で、それぞれの解析結果がどのように異なるか、特に値の型に注目して比較することで、これらの定数の役割を具体的に理解できます。設定値の型を自動で判断させたい場合にINI_SCANNER_TYPEDが非常に役立ちます。

Copy
1<?php
2
3/**
4 * INIファイル形式の文字列をパースし、
5 * INI_SCANNER_TYPEDとINI_SCANNER_RAWの動作の違いを示します。
6 *
7 * システムエンジニアを目指す初心者の方へ:
8 * このコードは、PHPが設定ファイル（INIファイル）を読み込む際に、
9 * 値の型（数値、真偽値、文字列など）をどのように扱うかを理解するのに役立ちます。
10 * INI_SCANNER_TYPEDはPHPが自動的に型を推測して変換しますが、
11 * INI_SCANNER_RAWは値をすべて文字列として扱います。
12 */
13function demonstrateIniScanningModes(): void
14{
15    // INIファイル形式の文字列を定義します。
16    // 数値、真偽値、引用符付きの文字列など、型変換で差が出る値を混ぜています。
17    $iniString = <<<'INI'
18database.host = "localhost"
19database.port = 3306
20feature.enabled = true
21feature.limit = 100
22app.debug_mode = "Off"
23app.version = 1.0.0
24INI;
25
26    echo "--- INI_SCANNER_TYPED (デフォルト: 型変換あり) ---" . PHP_EOL;
27    // INI_SCANNER_TYPED を使用して文字列をパースします。
28    // PHPは値の型を自動的に判断し、適切な型（boolean, integer, stringなど）に変換します。
29    // parse_ini_string() の第2引数は false に設定し、セクションを無効にしています。
30    // (このINI文字列にはセクションがないため、よりシンプルな結果になります)
31    $typedConfig = parse_ini_string($iniString, false, INI_SCANNER_TYPED);
32    var_dump($typedConfig);
33    echo PHP_EOL;
34
35    echo "--- INI_SCANNER_RAW (型変換なし、すべて文字列として扱う) ---" . PHP_EOL;
36    // INI_SCANNER_RAW を使用して文字列をパースします。
37    // PHPは値の型変換を行わず、すべてを文字列として扱います。
38    // 例えば "true" や "3306" も文字列として保持されます。
39    // これは、INIファイルの値を厳密に文字列として取得したい場合に便利です。
40    $rawConfig = parse_ini_string($iniString, false, INI_SCANNER_RAW);
41    var_dump($rawConfig);
42    echo PHP_EOL;
43
44    // INI_SCANNER_TYPED は parse_ini_string() のデフォルト動作なので、
45    // 第3引数を省略した場合も INI_SCANNER_TYPED と同じ結果になります。
46    echo "--- デフォルト動作 (INI_SCANNER_TYPED と同じ) ---" . PHP_EOL;
47    $defaultConfig = parse_ini_string($iniString, false);
48    var_dump($defaultConfig);
49    echo PHP_EOL;
50}
51
52// 関数を実行して動作を確認します。
53demonstrateIniScanningModes();
54

PHP 8で利用可能な定数INI_SCANNER_TYPEDは、INIファイル形式の文字列やファイルをパースする際に使用されるオプションの一つです。この定数は、parse_ini_string()関数やparse_ini_file()関数の第3引数に指定することで、INIファイルの値の型を自動的に推測し、適切なPHPのデータ型に変換する「型付きスキャン」を有効にします。

例えば、INIファイル内のtrueやfalseはPHPの真偽値に、数字は整数や浮動小数点数に、引用符付きの文字列は文字列として変換されます。これにより、読み込んだ設定値をPHPコード内でより直接的に利用できるようになります。対照的に、INI_SCANNER_RAWを指定すると、すべての値は型変換されずに文字列として扱われます。

INI_SCANNER_TYPEDはこれらのパース関数のデフォルトの挙動であり、多くの場合、明示的に指定しなくてもこの動作が適用されます。この定数自体は引数を取らず、特定の値を返すものではなく、関数の動作を制御するためのフラグとして機能します。INIファイルをより便利に、そして直感的に扱うために役立つ重要な定数です。