Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yosymfony/toml
A PHP parser for TOML
https://github.com/yosymfony/toml
configuration php toml
Last synced: about 8 hours ago
JSON representation
A PHP parser for TOML
- Host: GitHub
- URL: https://github.com/yosymfony/toml
- Owner: yosymfony
- License: mit
- Created: 2013-05-12T11:21:50.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2020-08-08T20:48:54.000Z (over 4 years ago)
- Last Synced: 2024-05-17T04:01:46.083Z (6 months ago)
- Topics: configuration, php, toml
- Language: PHP
- Homepage:
- Size: 238 KB
- Stars: 192
- Watchers: 6
- Forks: 28
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-php - Yo! Symfony TOML - A PHP parser for [TOML](https://github.com/toml-lang/toml). (Configuration / Serverless)
- awesome-php-cn - Yo! Symfony TOML - 一个PHP解析器(TOML) (https://github.com/toml-lang/toml). (配置 Configuration / 无服务器的 Serverless)
- awesome-projects - Yo! Symfony TOML - A PHP parser for [TOML](https://github.com/toml-lang/toml). (Configuration / Serverless)
- php-awesome - TOML parser for PHP
- awesome-php - Yo! Symfony TOML - A PHP parser for [TOML](https://github.com/toml-lang/toml). (Configuration / Serverless)
README
TOML parser for PHP
===================
A PHP parser for [TOML](https://github.com/toml-lang/toml) compatible with [TOML v0.4.0](https://github.com/toml-lang/toml/releases/tag/v0.4.0).
[](https://travis-ci.org/yosymfony/toml)
[](https://packagist.org/packages/yosymfony/toml)
[](https://packagist.org/packages/yosymfony/toml)
Support:
[](https://gitter.im/yosymfony/Toml?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
Installation
------------
**Requires PHP >= 7.1.**
Use [Composer](http://getcomposer.org/) to install this package:
```bash
composer require yosymfony/toml
```
Usage
-----
You can parse an inline TOML string or from a file:
To parse an inline TOML string:
```php
use Yosymfony\Toml\Toml;
$array = Toml::Parse('key = [1,2,3]');
print_r($array);
```
To parse a TOML file:
```php
$array = Toml::ParseFile('example.toml');
print_r($array);
```
Additionally, methods `parse` and `parseFile` accept a second argument called
`resultAsObject` to return the result as an object based on `stdClass`.
```php
$object = Toml::Parse('key = [1,2,3]', true);
```
### TomlBuilder
You can create a TOML string with TomlBuilder. TomlBuilder uses a *fluent interface* for more readable code:
```php
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
```
The result:
```toml
#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"
```
#### Limitations
The `TomlBuilder` class is an utility to get Toml strings that has the following limitations:
* Only admits `basic strings` and `literal strings`.
Deprecated method
-----------------
The following method will be eliminated in version 2.0.0
* [TomlBuilder] **addArrayTables**
Contributing
------------
When Contributing code to this library, you must follow its coding standards.
Toml follows [PSR-2 coding style](https://www.php-fig.org/psr/psr-2/). To ensure
the CS, you can use the CLI tool [PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer).
Unit tests
----------
You can run the unit tests with the following command:
```bash
$ cd toml
$ composer test
```
## License
This library is open-sourced software licensed under the
[MIT license](http://opensource.org/licenses/MIT).