Hyde\Framework\Models\Pages\DocumentationPage

Complexity

Total Complexity

7

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Importance

Changes	8
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getOnlineSourcePath()	0	7	2
A	__construct()	0	4	1
A	hasTableOfContents()	0	3	1
A	home()	0	3	2
A	getCurrentPagePath()	0	3	1

<?php

namespace Hyde\Framework\Models\Pages;

use Hyde\Framework\Concerns\HasTableOfContents;
use Hyde\Framework\Contracts\AbstractMarkdownPage;
use Hyde\Framework\Contracts\RouteContract;
use Hyde\Framework\Models\Route;

class DocumentationPage extends AbstractMarkdownPage
{
    use HasTableOfContents;

    public static string $sourceDirectory = '_docs';
    public static string $outputDirectory = 'docs';
    public static string $template = 'hyde::layouts/docs';

    /**
     * The sidebar category group, if any.
     */
    public ?string $category;

    public function __construct(array $matter = [], string $body = '', string $title = '', string $slug = '', ?string $category = null)
    {
        parent::__construct($matter, $body, $title, $slug);
        $this->category = $category;
    }

    /** @inheritDoc */
    public function getCurrentPagePath(): string
    {
        return trim(static::getOutputDirectory().'/'.basename($this->slug), '/');
    }

    /** @internal */
    public function getOnlineSourcePath(): string|false
    {
        if (config('docs.source_file_location_base') === null) {
            return false;
        }

        return trim(config('docs.source_file_location_base'), '/').'/'.$this->slug.'.md';
    }

    public static function home(): ?RouteContract
    {
        return Route::exists('docs/index') ? Route::get('docs/index') : null;
    }

    public static function hasTableOfContents(): bool
    {
        return config('docs.table_of_contents.enabled', true);
    }
}