spatie/yaml-front-matter

A to the point yaml front matter parser

, _(*1)

yaml-front-matter

, _(*2)

A to the point front matter parser. Front matter is metadata written in yaml, located at the top of a file wrapped in ---'s., _(*3)

---
title: Example
---

Lorem ipsum.

use Spatie\YamlFrontMatter\YamlFrontMatter;

$object = YamlFrontMatter::parse(file_get_contents(__DIR__.'/example.md'));

$object->matter('title'); // => 'Example';
$object->body(); // => 'Lorem ipsum.'

// Or retrieve front matter with a property call...

$object->title; // => 'Example';

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website., _(*4)

Support us

, _(*5)

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products., _(*6)

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall., _(*7)

Install

You can install the yaml-front-matter via composer:, _(*8)

``` bash $ composer require spatie/yaml-front-matter, <sub>(*9)</sub>

## Usage

Consider the `example.md` file from above. First you'll need to parse the contents:

```php
use Spatie\YamlFrontMatter\YamlFrontMatter;
$object = YamlFrontMatter::parse(file_get_contents('example.md'));

The parser will return a YamlFrontMatterObject, which can be queried for front matter or it's body., <sub>(*10)</sub>

$object->matter(); // => ['title' => 'Example']
$object->matter('title'); // => 'Example'
$object->body(); // => 'Lorem ipsum.'
$object->title; // => 'Example'

Protip: The matter function also accepts dot notation for nested fields, e.g. matter('meta.keywords')., <sub>(*11)</sub>

Changelog

Please see CHANGELOG for more information what has changed recently., <sub>(*12)</sub>

Testing

bash $ vendor/bin/phpunit, <sub>(*13)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*14)</sub>

Security

If you've found a bug regarding security please mail security@spatie.be instead of using the issue tracker., <sub>(*15)</sub>

Postcardware

You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using., <sub>(*16)</sub>

Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium., <sub>(*17)</sub>

We publish all received postcards on our company website., <sub>(*18)</sub>

Credits

• Sebastian De Deyne
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*19)</sub>