Hyde\Framework\Models\Parsers\DocumentationPageParser

Complexity

Total Complexity

4

Size/Duplication

Total Lines	39
Duplicated Lines	0 %

Importance

Changes	5
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	execute()	0	8	1
A	getCategory()	0	7	2
A	get()	0	9	1

<?php

namespace Hyde\Framework\Models\Parsers;

use Hyde\Framework\Contracts\AbstractPageParser;
use Hyde\Framework\Hyde;
use Hyde\Framework\Models\Pages\DocumentationPage;
use Hyde\Framework\Services\MarkdownFileService;
use Illuminate\Support\Str;

/**
 * Parses a Markdown file in the configured docs directory into a DocumentationPage object.
 *
 * If the file is in a subdirectory relative to the base source directory (default _docs),
 * the subdirectory name will be used as the page's category. This only works for one level,
 * and the resulting file will still be put in the root of the docs output directory.
 */
class DocumentationPageParser extends AbstractPageParser
{
    protected string $pageModel = DocumentationPage::class;
    protected string $slug;

    /** @deprecated v0.44.x (handled in constructor) */
    public string $title = '';
    public string $body;
    public array $matter;

    public function execute(): void
    {
        $document = (new MarkdownFileService(
            Hyde::getDocumentationPagePath("/$this->slug.md")
        ))->get();

        $this->body = $document->body;
        $this->matter = $document->matter;
    }

    public function get(): DocumentationPage
    {
        return new DocumentationPage(
            matter: $this->matter,
            body: $this->body,
            title: $this->title,

The property Hyde\Framework\Models\Parsers\DocumentationPageParser::$title has been deprecated: v0.44.x (handled in constructor)

            slug: basename($this->slug),
            category: $this->getCategory(),
            localPath: $this->slug
        );
    }

    public function getCategory(): ?string
    {
        if (str_contains($this->slug, '/')) {
            return Str::before($this->slug, '/');
        }

        return $this->matter['category'] ?? null;
    }
}