Hyde\Framework\Models\MarkdownDocument

Complexity

Total Complexity

10

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Importance

Changes	7
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	body()	0	3	1
A	matter()	0	3	2
A	parseFile()	0	3	1
A	__toString()	0	3	1
A	__construct()	0	6	3
A	markdown()	0	3	1
A	parse()	0	3	1

<?php

namespace Hyde\Framework\Models;

use Hyde\Framework\Contracts\MarkdownDocumentContract;
use Hyde\Framework\Hyde;
use Hyde\Framework\Modules\Markdown\MarkdownFileParser;

/**
 * A MarkdownDocument is a simpler alternative to a MarkdownPage.
 *
 * It's an object that contains a parsed FrontMatter split from the body of the Markdown file.
 *
 * @see \Hyde\Framework\Testing\Unit\MarkdownDocumentTest
 */
class MarkdownDocument implements MarkdownDocumentContract
{
    public FrontMatter $matter;
    public Markdown $markdown;

    /** @deprecated */
    public string $body;

    public function __construct(FrontMatter|array $matter = [], Markdown|string $body = '')
    {
        $this->matter = $matter instanceof FrontMatter ? $matter : new FrontMatter($matter);

$matter is never a sub-type of Hyde\Framework\Models\FrontMatter.

        $this->markdown = $body instanceof Markdown ? $body : new Markdown($body);

        $this->body = $this->markdown->body;

The property Hyde\Framework\Models\MarkdownDocument::$body has been deprecated.

    }

    public function __toString(): string
    {
        return $this->markdown;
    }

    public function matter(string $key = null, mixed $default = null): mixed
    {
        return $key ? $this->matter->get($key, $default) : $this->matter;
    }

    public function markdown(): Markdown
    {
        return $this->markdown;
    }

    /** @deprecated  */
    public function body(): string
    {
        return $this->body;

The property Hyde\Framework\Models\MarkdownDocument::$body has been deprecated.

    }

    /**
     * @deprecated v0.56.0 - Use static::parse() instead
     */
    public static function parseFile(string $localFilepath): static
    {
        return static::parse($localFilepath);
    }

    public static function parse(string $localFilepath): static
    {
        return (new MarkdownFileParser(Hyde::path($localFilepath)))->get();
    }
}