Kurenai

, _(*2)

, _(*3)

Kurenai is a document with metadata parsing library for PHP. It supports a variety of different document content and metadata parsers., _(*4)

Installation

Kurenai is available on Packagist for Composer., _(*5)

composer require daylerees/kurenai

Usage

Kurenai documents look like this:, _(*6)

Some form of metadata here.
===
Some form of content here.

A metadata section, and a content section seperated by three equals === signs or more., _(*7)

Here's an example using JSON for metadata, and Markdown for content., _(*8)

{
    "title": "Hello world!"
}
===
# Hello World

Well hello there, world!

Formats for metadata and content are interchangable using classes called parsers. First, let's create our parser instance., _(*9)

$kurenai = new \Kurenai\Parser(
    new \Kurenai\Parsers\Metadata\JsonParser,
    new \Kurenai\Parsers\Content\MarkdownParser
);

In the above example, we're using a JSON metadata parser, and a Markdown content parser. We can now parse a document., _(*10)

$document = $kurenai->parse('path/to/document.md');

Our documents can have any filename or extension. You can also pass the parse() function the content of a document directly., _(*11)

The document instance has a few useful methods., _(*12)

$document->getRaw();

This will fetch the raw document content. Before Kurenai parsed it., _(*13)

$document->getMetadata();

This will fetch the metadata, parsed into an array., _(*14)

$document->getContent();

This will get the content of the document, rendered using the provided content parser., _(*15)

$document->get('foo.bar');

The get() method uses dot-notation to return a metadata value. For example, the above example would be equivalent to fetching $metadata['foo']['bar']., _(*16)

If the subject can't be found, null will be returned. You can supply a default value as a second parameter to the method., _(*17)

Metadata Parsers

Format	Install Package	Class
JSON	N/A	`Kurenai\Parsers\Metdata\JsonParser`
YAML	`symfony/yaml`	`Kurenai\Parsers\Metdata\YamlParser`
INI	N/A	`Kurenai\Parsers\Metdata\IniParser`

Content Parsers

Format	Install Package	Class
Plaintext (no parsing)	N/A	`Kurenai\Parsers\Content\PlainTextParser`
CommonMark	`league/commonmark`	`Kurenai\Parsers\Content\CommonMarkParser`
Markdown	`michelf/php-markdown`	`Kurenai\Parsers\Content\MarkdownParser`
Markdown Extra	`michelf/php-markdown`	`Kurenai\Parsers\Content\MarkdownExtraParser`
Parsedown (Github Markdown)	`erusev/parsedown`	`Kurenai\Parsers\Content\ParsedownParser`
Textile	`netcarver/textile`	`Kurenai\Parsers\Content\TextileParser`