for testing and deploying your application
for finding and fixing issues
for empowering human code reviews
<?php
namespace Hyde\Framework\Modules\Markdown;
use Hyde\Framework\Models\MarkdownDocument;
use Spatie\YamlFrontMatter\YamlFrontMatter;
/**
* Prepares a Markdown file for further usage by extracting the Front Matter and creating MarkdownDocument object.
*
* @see \Hyde\Framework\Testing\Feature\MarkdownFileParserTest
*/
class MarkdownFileParser
{
* The extracted Front Matter.
* @var array
public array $matter = [];
* The extracted Markdown body.
* @var string
public string $body = '';
public function __construct(string $filepath)
$stream = file_get_contents($filepath);
// Check if the file has Front Matter.
if (str_starts_with($stream, '---')) {
$object = YamlFrontMatter::markdownCompatibleParse($stream);
if ($object->matter()) {
$this->matter = $object->matter();
// Unset the slug from the matter, as it can cause problems if it exists.
unset($this->matter['slug']);
}
if ($object->body()) {
$this->body = $object->body();
} else {
$this->body = $stream;
* Get the processed Markdown file as a MarkdownDocument.
public function get(): MarkdownDocument
return new MarkdownDocument($this->matter, $this->body);
public static function parse(string $filepath): MarkdownDocument
return (new self($filepath))->get();
hydephp /
develop
