parse_ini_file()

❮ PHP 文件系统参考手册

实例

"test.ini" 的内容:

[names]
me = Robert
you = Peter

[urls]
first = "http://www.example.com"
second = "https://www.w3ccoo.com"

PHP code:

<?php
print_r(parse_ini_file("test.ini"));
?>

上述代码的输出为:

Array (
  [me] => Robert
  [you] => Peter
  [first] => http://www.example.com
  [second] => https://www.w3ccoo.com
)

---

定义和用法

parse_ini_file() 函数解析一个配置文件，并以数组的形式返回其中的设置。

提示:这个函数可以用来读入自己的配置文件，与php.ini文件无关。

注释: 以下保留字不得用作 ini 文件的键:null、yes、no、true、false、on、off、none。 此外，密钥中不得使用以下保留字符: {}|&~!()^".

语法

parse_ini_file(file, process_sections, scanner_mode)

参数值

参数	描述
file	必需。规定要检查的 ini 文件。
process_sections	可选。如果设置为 true，则返回一个多维数组，包括了配置文件中每一节的名称和设置。默认是 false。
scanner_mode	可选。 可以是以下值之一: INI_SCANNER_NORMAL（默认） INI_SCANNER_RAW（表示不解析选项值） INI_SCANNER_TYPED（表示在可能的情况下保留布尔、空和整数类型。 "true", "on", "yes" 被转换为 TRUE。 "false", "off", "no", "none" 被转换为 FALSE。 "null" 转换为 NULL。 如果可能，将数字字符串转换为整数类型）

说明

ini 文件的结构和 php.ini 的相似。

常量也可以在 ini 文件中被解析，因此如果在运行 parse_ini_file() 之前定义了常量作为 ini 的值，将会被集成到结果中去。只有 ini 的值会被求值。

由数字组成的键名和小节名会被 PHP 当作整数来处理，因此以 0 开头的数字会被当作八进制而以 0x 开头的会被当作十六进制。

---

提示和注释

注释:本函数可以用来读取你自己的应用程序的配置文件。本函数与 php.ini 文件没有关系，该文件在运行脚本时就已经处理过了。

注释:如果 ini 文件中的值包含任何非字母数字的字符，需要将其括在双引号中（"）。

注释:有些保留字不能作为 ini 文件中的键名，包括:null，yes，no，true 和 false。值为 null，no 和 false 等效于 ""，值为 yes 和 true 等效于 "1"。字符 {}|"~![()" 也不能用在键名的任何地方，而且这些字符在选项值中有着特殊的意义。

注释:自 PHP 5.0 版本开始，该函数也处理选项值内的新行。

---

技术细节

返回值:	成功时为数组，失败时为 FALSE
PHP 版本:	4.0+
PHP 更新日志:	PHP 7.0: 哈希标记 (#) 不再被识别为注释 PHP 5.6.1:添加了 INI_SCANNER_TYPED 模式 PHP 5.3:添加了可选 scanner_mode 参数

---

更多实例

实例

"test.ini"的内容:

[names]
me = Robert
you = Peter

[urls]
first = "http://www.example.com"
second = "https://www.w3ccoo.com"

PHP code (with process_sections set to true):

<?php
print_r(parse_ini_file("test.ini",true));
?>

上述代码的输出为:

Array
(
[names] => Array
  (
  [me] => Robert
  [you] => Peter
  )
[urls] => Array
  (
  [first] => http://www.example.com
  [second] => https://www.w3ccoo.com
  )
)

---

❮ PHP 文件系统参考手册