bluebaytravel/phrontmatter

Front Matter parser for PHP, with support for YAML, JSON and TOML.

v1.5.0 2017-10-11 16:19 UTC

Requires

• php: >=5.5.9
• illuminate/contracts: 5.1.*|5.2.*|5.3.*|5.4.*|5.5.*
• illuminate/support: 5.1.*|5.2.*|5.3.*|5.4.*|5.5.*
• jamesmoss/toml: ^1.1
• symfony/yaml: ~2.7|~3.0

Requires (Dev)

• graham-campbell/testbench: ^3.1
• phpunit/phpunit: ^4.8|^5.0

MIT

• James Brooks

README

// Parse a document.
Phrontmatter::parse("---\nfoo: bar---\nThis is actual content!")->foo;

// Dependency injection example.
$phrontmatter->parse("---\nfoo: bar---\nThis is actual content!")->getContent();

// Parse a document with JSON meta data.
$phrontmatter->parse("---\n{\"foo\":\"bar\"}\n---\nThis is a document with JSON!", Phrontmatter::JSON)->getData();

For more information on Front Matter, see the Jekyll documentation.

Installation

Require this package, with Composer, in the root directory of your project.

composer require bluebaytravel/phrontmatter

Laravel Installation

Add the service provider to config/app.php in the providers array.

BlueBayTravel\Phrontmatter\PhrontmatterServiceProvider::class

If you want you can use the facade. Add the reference in config/app.php to your aliases array.

'Phrontmatter' => BlueBayTravel\Phrontmatter\Facades\Phrontmatter::class

Supported Formatters

Phrontmatter supports the following formatters:

• YAML (default)
• TOML
• JSON

License

Blue Bay Travel Phrontmatter is licensed under The MIT License (MIT).