parse_ini_string
(PHP 5 >= 5.3.0, PHP 7)
parse_ini_string — 設定文字列をパースする
説明
parse_ini_string
( string $ini
[, bool $process_sections
= false
[, int $scanner_mode
= INI_SCANNER_NORMAL
]] ) : array
parse_ini_string() は、文字列
ini
の設定を連想配列で返します。
文字列の構造は、php.ini
の構造と同じです。
パラメータ
ini
パースしたい ini ファイルの内容。
process_sections
process_sections
をtrue
に設定すると、セクション名と設定を含む多次元配列を返します。process_sections
のデフォルトはfalse
です。scanner_mode
INI_SCANNER_NORMAL
(デフォルト) あるいはINI_SCANNER_RAW
。INI_SCANNER_RAW
を指定すると、オプションの値はパースされません。PHP 5.6.1 以降では
INI_SCANNER_TYPED
も指定できるようになりました。 このモードでは、boolean や null そして integer の型を、可能な限り維持します。 文字列"true"
、"on"
そして"yes"
はtrue
に変換されます。"false"
、"off"
、"no"
そして"none"
はfalse
だとみなされます。このモードでは、"null"
はnull
に変換されます。また数値形式の文字列も、可能な限り integer 型に変換されます。
返り値
成功した場合に設定を連想配列形式で返します。
失敗した場合に false
を返します。
注意
注意:
ini ファイル上でキーとして使ってはいけない単語があります。
null
,yes
,no
,true
,false
,on
,off
,none
などです。null
,off
,no
およびfalse
は""
となり、on
,yes
およびtrue
は"1"
となります。 ただしINI_SCANNER_TYPED
モードを使っている場合は別です。 次の文字?{}|&~![()^"
は、キーで使ってはいけません。 また、値の中で特別な意味を持ちます。