kzykhys/yaml-front-matter

YAML Front-matter Parser/Dumper for PHP

YAML Front-matter Parser/Dumper for PHP

, _(*1)

A PHP YAML Front-matter parser/dumper using symfony/yaml., _(*2)

Requirements

• PHP5.3+

Installation

Create or update your composer.json and run composer update, _(*3)

``` json { "require": { "kzykhys/yaml-front-matter": ">=1.0" } }, <sub>(*4)</sub>

Usage
-----

### FrontMatter::parse(string $input)

``` php
<?php

require __DIR__ . '/vendor/autoload.php';

use KzykHys\FrontMatter\FrontMatter;

// Parse a document
$document = FrontMatter::parse(<<<EOF
---
title: Hello World
category: blog
layout: post
tags:
    - technology
    - PHP
vars:
    pingback_url: http://example.com/pingback?id={{post.id}}
    description: ~
extra:
    markdown:
        gfm: true
        textile: true
    template: twig
---

{% block content %}
    Lorem Ipsum ...
{% endblock %}
EOF
);

var_dump($document); // An instance of `Document`
var_dump($document->getConfig()); // An array {title:"Hello World", category: "blog"....}
var_dump($document->getContent()); // "{% block content %}...."
var_dump((string) $document); // "{% block content %}...."
var_dump($document["layout"]); // "post"
var_dump($document["extra"]["template"]); // "twig"

foreach ($document as $key => $value) {
    var_dump($key, $value); // "title", "Hello World"
    break;
}

FrontMatter::dump(Document $document)

``` php <?php, <sub>(*5)</sub>

use KzykHys\FrontMatter\Document; use KzykHys\FrontMatter\FrontMatter;, <sub>(*6)</sub>

require DIR . '/vendor/autoload.php';, <sub>(*7)</sub>

$document = new Document(); $document['title'] = 'Hello!'; $document['tags'] = array('uncategorized', 'test'); $document->setContent(', <sub>(*8)</sub>

Hello World!, <sub>(*9)</sub>

');, <sub>(*10)</sub>

echo FrontMatter::dump($document);, <sub>(*11)</sub>

will output:

title: Hello! tags: - uncategorized, <sub>(*12)</sub>

- test

, <sub>(*13)</sub>

Hello World!, <sub>(*14)</sub>

### Document::inherit(Document $parent)

``` php
$parent = FrontMatter::parse(<<<EOF
---
extra:
    template: twig
category: blog
tags:
    - PHP
---

Lorem Ipsum ...
EOF
);

$document = FrontMatter::parse(<<<EOF
---
extra:
    template: smarty
tags:
    - HHVM
    - PHP5.5
---

Lorem Ipsum ...
EOF
);

$document->inherit($parent);
var_dump($document->getConfig());

array(2) {
  'extra' => array(1) {
    'template' => string(6) "smarty"
  }
  'category' => string(4) "blog"
  'tags' => array(3) {
    [0] => string(3) "PHP"
    [1] => string(4) "HHVM"
    [2] => string(6) "PHP5.5"
  }
}

License

The MIT License, <sub>(*15)</sub>

Author

Kazuyuki Hayashi (@kzykhys), <sub>(*16)</sub>