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

INI_SCANNER_NORMAL定数は、PHPのini設定ファイルを解析する際の標準的な動作モードを指定するために使用される定数です。iniファイルとは、アプリケーションの設定情報を記述するためによく用いられるシンプルなテキスト形式のファイルで、セクション名とキーと値のペアで構成されます。この定数は、主にparse_ini_file関数やparse_ini_string関数など、PHPでini形式のファイルを読み込む際に、その解析方法を制御するために第2引数として用いられます。

具体的にINI_SCANNER_NORMALモードが指定されると、PHPはiniファイルの内容を「セクション名」（例：[database]）と「キーと値のペア」（例：host = localhost）として正確に認識し、それらを連想配列の形式で返します。例えば、[database]セクション内のhost = localhostという記述は、最終的に['database']['host'] = 'localhost'のような形でPHPの配列としてアクセスできるようになります。これにより、開発者はアプリケーションの設定情報を構造化された形式でPHPスクリプト内に簡単に取り込むことができます。

この定数の特徴として、iniファイル内に記述された変数展開（例：${DATABASE_HOST}のような記述）は行われず、そのような記述は単なる文字列として扱われる点が挙げられます。そのため、ファイルに書かれたそのままの内容を忠実に読み込みたい場合に適しています。

INI_SCANNER_NORMALは、iniファイルを解析する関数のデフォルトのモードでもあり、特別な設定変更が必要ない限り、このモードでiniファイルが読み込まれます。アプリケーションの一般的な設定ファイルや構成ファイルを読み込む際に、最も頻繁に利用される標準的な解析モードとして機能します。この定数を使用することで、PHPアプリケーションが外部設定ファイルから情報を取得し、その動作を柔軟に設定することが可能になります。

Copy
1<?php
2$ini_string = "setting = value";
3$config = parse_ini_string($ini_string, false, INI_SCANNER_NORMAL);
4?>

引数なし

引数はありません

int

INI_SCANNER_NORMAL は、PHPの parse_ini_file() 関数などで使用される整数定数です。この定数は、INIファイルを通常の形式で解析することを指示するために使用され、その戻り値は整数 1 です。