本篇文章帶大家聊聊PHP中的TOML配置，介紹一下在 PHP 中如何使用 TOML 配置文件格式語言，希望對大家有所幫助！

php零基礎到就業直播視頻課：進入學習
接口如何自動化測試：快速上手

TOML 是一個配置格式化語言，特色是簡潔易讀。 全稱為 "Tom's Obvious, Minimal Language" 其中的 Tom 為創建者 —— Tom Preston-Werner (譯者注：Github CEO)。

來自其 Github Reopo，TOML 的目的如下：

TOML 是一門簡潔易用的配置信息格式化語言，高可讀性來自于其優雅的語法。 TOML 為哈希表數據結構量身定制的，在各種編程語言里皆可以輕松地將 TOML 解析為各自的數據結構。

TOML 和 PHP 在一起

各種語言的 TOML 解析器可以 在其項目 WIKI 中找到。

我們將利用 yosymfony/toml: 一個 PHP 的 TOML 解析器 來嘗試下 TOML 語言，在你的 PHP 7.1+ 項目里使用 Composer:

composer require yosymfony/toml

TOML 的項目 Readme 里有一個示例配置信息，我們可以試著用起來：

## This is a TOML document.  title = "TOML Example"  [owner] name = "Tom Preston-Werner" dob = 1979-05-27T07:32:00-08:00 # First class dates  [database] server = "192.168.1.1" ports = [ 8001, 8001, 8002 ] connection_max = 5000 enabled = true  [servers]    # Indentation (tabs and/or spaces) is allowed but not required   [servers.alpha]   ip = "10.0.0.1"   dc = "eqdc10"    [servers.beta]   ip = "10.0.0.2"   dc = "eqdc10"  [clients] data = [ ["gamma", "delta"], [1, 2] ]  # Line breaks are OK when inside arrays hosts = [   "alpha",   "omega" ]

下面是 PHP 的解析和輸出：

<?php  use YosymfonyTomlToml;  require __DIR__ . '/vendor/autoload.php';  $data = Toml::ParseFile(__DIR__.'/example.toml');  var_dump($data);  // output php index.php string(10) "1979-05-27" toml-demo|? php index.php array(5) {   ["title"]=>   string(12) "TOML Example"   ["owner"]=>   array(2) {     ["name"]=>     string(18) "Tom Preston-Werner"     ["dob"]=>     object(DateTime)#243 (3) {       ["date"]=>       string(26) "1979-05-27 07:32:00.000000"       ["timezone_type"]=>       int(1)       ["timezone"]=>       string(6) "-08:00"     }   }   ["database"]=>   array(4) {     ["server"]=>     string(11) "192.168.1.1"     ["ports"]=>     array(3) {       [0]=>       int(8001)       [1]=>       int(8001)       [2]=>       int(8002)     }     ["connection_max"]=>     int(5000)     ["enabled"]=>     bool(true)   }   ["servers"]=>   array(2) {     ["alpha"]=>     array(2) {       ["ip"]=>       string(8) "10.0.0.1"       ["dc"]=>       string(6) "eqdc10"     }     ["beta"]=>     array(2) {       ["ip"]=>       string(8) "10.0.0.2"       ["dc"]=>       string(6) "eqdc10"     }   }   ["clients"]=>   array(2) {     ["data"]=>     array(2) {       [0]=>       array(2) {         [0]=>         string(5) "gamma"         [1]=>         string(5) "delta"       }       [1]=>       array(2) {         [0]=>         int(1)         [1]=>         int(2)       }     }     ["hosts"]=>     array(2) {       [0]=>       string(5) "alpha"       [1]=>       string(5) "omega"     }   } }

配置信息示例

接下來我們試著將 Laravel 的配置信息 config/database.php 解析為 TOML ，做個對比。

需要注意的是，這只是一個示范，Laravel 的配置系統要比 TOML 高級很多，這里這樣做的目的只是想在我們熟悉的配置信息里去理解 TOML：

[database]     default = "mysql"     migrations = "migrations"      [database.connections.sqlite]         driver = "sqlite"         database = "path/to/database.sqlite"         prefix = ""      [database.connections.mysql]         driver = "mysql"         host = "127.0.0.1"         port = "3306"         database = "forge"         username = "forge"         password = ""         unix_socket = ""         charset = "utf8mb4"         collation = "utf8mb4_unicode_ci"         prefix = ""         strict = true      [database.redis]         client = "predis"          [database.redis.default]             host = "127.0.0.1"             password = ""             port = 6379             database = 0

目前來講，TOML 并不允許 nil 和 null 值，這在一些使用 null 作為默認值的場景下會變得很不方便。

縮進是允許的，但是不強求，上面的文件使用以下寫法也不會有問題：

[database] default = "mysql" migrations = "migrations"  [database.connections.sqlite] driver = "sqlite" database = "path/to/database.sqlite" prefix = ""  # ...

構建一個 TOML 配置文件

擴展包 yosymfony/toml 除了提供解析 TOML 文件和字串外，還提供了一個 TomlBuilder 類，用來實時構建 TOML 配置信息，接下來我們還是使用 Laravel 的 config/services.php 來作為例子講解：

<?php  use YosymfonyTomlTomlBuilder;  require __DIR__.'/vendor/autoload.php';  $builder = new TomlBuilder();  $services = $builder     ->addComment('Third Party Services')     ->addComment('Mailgun')     ->addTable('services.mailgun')         ->addValue('domain', 'mg.example.com')         ->addValue('secret', 'mailgun-secret')     ->addComment('Stripe')     ->addTable('services.stripe')         ->addValue('model', 'AppUser')         ->addValue('key', 'stripe-key')         ->addValue('secret', 'stripe-secret') ;  file_put_contents(__DIR__.'/services.toml', $services->getTomlString());

生成的內容如下：

#Third Party Services #Mailgun  [services.mailgun] domain = "mg.example.com" secret = "mailgun-secret" #Stripe  [services.stripe] model = "App\User" key = "stripe-key" secret = "stripe-secret"

日期

TOML 支持 RFC 3339 制定的日期格式：

# Offset Date-Time odt1 = 1979-05-27T07:32:00Z odt2 = 1979-05-27T00:32:00-07:00 odt3 = 1979-05-27T00:32:00.999999-07:00 # space permitted per the RFC 3339 spec odt4 = 1979-05-27 07:32:00Z  # Local Date-Time ldt1 = 1979-05-27T07:32:00  # Local Date ld1 = 1979-05-27  # Local Time lt1 = 07:32:00 lt2 = 00:32:00.999999

在此篇文章編寫時，上面大部分的格式都出現了錯誤，除了下面這一行：

dob = 1979-05-27T07:32:00-08:00

PHP 解析器會將解析成功輸出為 DateTime 實例：

array(1) {   ["dob"]=>   object(DateTime)#128 (3) {     ["date"]=>     string(26) "1979-05-27 07:32:00.000000"     ["timezone_type"]=>     int(1)     ["timezone"]=>     string(6) "-08:00"   } }

閱讀