README

一个与TOML兼容的PHP解析器，符合TOML v0.4.0。

支持

安装

需要PHP >= 7.1。

使用Composer安装此包

composer require yosymfony/toml

用法

您可以从文件或字符串解析TOML

解析内联TOML字符串

use Yosymfony\Toml\Toml;

$array = Toml::Parse('key = [1,2,3]');

print_r($array);

解析TOML文件

$array = Toml::ParseFile('example.toml');

print_r($array);

此外，方法 parse 和 parseFile 接受一个名为 resultAsObject 的第二个参数，以返回基于 stdClass 的对象。

$object = Toml::Parse('key = [1,2,3]', true);

TomlBuilder

您可以使用TomlBuilder创建TOML字符串。TomlBuilder使用流畅接口以使代码更易读

    use Yosymfony\Toml\TomlBuilder;

    $tb = new TomlBuilder();

    $result = $tb->addComment('Toml file')
        ->addTable('data.string')
        ->addValue('name', "Toml", 'This is your name')
        ->addValue('newline', "This string has a \n new line character.")
        ->addValue('winPath', "C:\\Users\\nodejs\\templates")
        ->addValue('literal', '@<\i\c*\s*>') // literals starts with '@'.
        ->addValue('unicode', 'unicode character: ' . json_decode('"\u03B4"'))

        ->addTable('data.bool')
        ->addValue('t', true)
        ->addValue('f', false)

        ->addTable('data.integer')
        ->addValue('positive', 25, 'Comment inline.')
        ->addValue('negative', -25)

        ->addTable('data.float')
        ->addValue('positive', 25.25)
        ->addValue('negative', -25.25)

        ->addTable('data.datetime')
        ->addValue('datetime', new \Datetime())

        ->addComment('Related to arrays')

        ->addTable('data.array')
        ->addValue('simple', array(1,2,3))
        ->addValue('multiple', array(
            array(1,2),
            array('abc', 'def'),
            array(1.1, 1.2),
            array(true, false),
            array( new \Datetime()) ))

        ->addComment('Array of tables')

        ->addArrayOfTable('fruit')                            // Row
            ->addValue('name', 'apple')
            ->addArrayOfTable('fruit.variety')
                ->addValue('name', 'red delicious')
            ->addArrayOfTable('fruit.variety')
                ->addValue('name', 'granny smith')
        ->addArrayOfTable('fruit')                            // Row
            ->addValue('name', 'banana')
            ->addArrayOfTable('fruit.variety')
                ->addValue('name', 'plantain')
        ->getTomlString();    // Generate the TOML string

结果

#Toml file

[data.string]
name = "Toml" #This is your name
newline = "This string has a \n new line character."
winPath = "C:\\Users\\nodejs\\templates"
literal = '<\i\c*\s*>'
unicode = "unicode character: δ"

[data.bool]
t = true
f = false

[data.integer]
positive = 25 #Comment inline.
negative = -25

[data.float]
positive = 25.25
negative = -25.25

[data.datetime]
datetime = 2013-06-10T21:12:48Z

#Related to arrays

[data.array]
simple = [1, 2, 3]
multiple = [[1, 2], ["abc", "def"], [1.1, 1.2], [true, false], [2013-06-10T21:12:48Z]]

# Array of tables

[[fruit]]
name = "apple"

[[fruit.variety]]
name = "red delicious"

[[fruit.variety]]
name = "granny smith"

[[fruit]]
name = "banana"

[[fruit.variety]]
name = "plantain"

限制

TomlBuilder类是一个工具，用于获取具有以下限制的TOML字符串：

• 只接受基本字符串和字面字符串。

弃用的方法

以下方法将在版本2.0.0中删除

• [TomlBuilder] addArrayTables

贡献

向此库贡献代码时，必须遵循其编码标准。TOML遵循PSR-2编码风格。为了确保CS，您可以使用CLI工具PHP-CS-Fixer。

单元测试

您可以使用以下命令运行单元测试

$ cd toml
$ composer test

许可证

此库是开源软件，受MIT许可证许可。